dronecode_sdk::Info Class Reference

#include: info.h


The Info class provides basic infomation about the hardware and/or software of a system.

Data Structures

struct Product

struct Version

Public Member Functions

Type Name Description
  Info (System & system) Constructor. Creates the plugin for a specific System.
  ~Info () Destructor (internal use only).
  Info (const Info &)=delete Copy Constructor (object is not copyable).
uint64_t uuid () const Gets the UUID of the system.
bool is_complete () const Tests if the Version and Product objects are fully populated from hardware.
Version get_version () const Get system version information.
Product get_product () const Get system product information.
const Info & operator= (const Info &)=delete Equality operator (object is not copyable).

Static Public Attributes

static const unsigned GIT_HASH_STR_LEN = 17 - Length of git hash strings.

Constructor & Destructor Documentation

Info()

dronecode_sdk::Info::Info(System &system)

Constructor. Creates the plugin for a specific System.

The plugin is typically created as shown below:

auto info = std::make_shared<Info>(system);

Parameters

  • System& system - The specific system associated with this plugin.

~Info()

dronecode_sdk::Info::~Info()

Destructor (internal use only).

Info()

dronecode_sdk::Info::Info(const Info &)=delete

Copy Constructor (object is not copyable).

Parameters

Member Function Documentation

uuid()

uint64_t dronecode_sdk::Info::uuid() const

Gets the UUID of the system.

If possible this will be a unique identifier provided by hardware.

Returns

 uint64_t - The UUID of the system.

is_complete()

bool dronecode_sdk::Info::is_complete() const

Tests if the Version and Product objects are fully populated from hardware.

Returns

 bool - true if Version and Product objects are fully populated from system.

get_version()

Version dronecode_sdk::Info::get_version() const

Get system version information.

Returns

Version - The version object for the system.

get_product()

Product dronecode_sdk::Info::get_product() const

Get system product information.

Returns

Product - The product object for the system.

operator=()

const Info& dronecode_sdk::Info::operator=(const Info &)=delete

Equality operator (object is not copyable).

Parameters

Returns

 const Info & -

Field Documentation

GIT_HASH_STR_LEN

const unsigned dronecode_sdk::Info::GIT_HASH_STR_LEN = 17

Length of git hash strings.

Length is 16 chars + null termination.

© Dronecode 2017. License: CC BY 4.0            Updated: 2018-07-12 03:09:32

results matching ""

    No results matching ""