Appearance

mavsdk::ComponentMetadata Class Reference ​

#include: component_metadata.h

Access component metadata json definitions, such as parameters.

Data Structures ​

struct MetadataData

struct MetadataUpdate

Public Types ​

TypeDescription
enum MetadataTypeThe metadata type.
enum ResultPossible results returned.
std::function< void(Result)> ResultCallbackCallback type for asynchronous ComponentMetadata calls.
std::function< void(MetadataUpdate)> MetadataAvailableCallbackCallback type for subscribe_metadata_available.
Handle< MetadataUpdate > MetadataAvailableHandleHandle type for subscribe_metadata_available.

Public Member Functions ​

TypeNameDescription
 ComponentMetadata (System & system)Constructor. Creates the plugin for a specific System.
 ComponentMetadata (std::shared_ptr< System > system)Constructor. Creates the plugin for a specific System.
 ~ComponentMetadata () overrideDestructor (internal use only).
 ComponentMetadata (const ComponentMetadata & other)Copy constructor.
voidrequest_component (uint32_t compid)constRequest metadata from a specific component. This is used to start requesting metadata from a component. The metadata can later be accessed via subscription (see below) or GetMetadata.
voidrequest_autopilot_component () constRequest metadata from the autopilot component. This is used to start requesting metadata from the autopilot. The metadata can later be accessed via subscription (see below) or GetMetadata.
MetadataAvailableHandlesubscribe_metadata_available (const MetadataAvailableCallback & callback)Register a callback that gets called when metadata is available.
voidunsubscribe_metadata_available (MetadataAvailableHandle handle)Unsubscribe from subscribe_metadata_available.
std::pair< Result, ComponentMetadata::MetadataData >get_metadata (uint32_t compid, MetadataType metadata_type)constAccess metadata. This can be used if you know the metadata is available already, otherwise use the subscription to get notified when it becomes available.
const ComponentMetadata &operator= (const ComponentMetadata &)=deleteEquality operator (object is not copyable).

Constructor & Destructor Documentation ​

ComponentMetadata() ​

cpp
mavsdk::ComponentMetadata::ComponentMetadata(System &system)

Constructor. Creates the plugin for a specific System.

The plugin is typically created as shown below:

cpp
auto component_metadata = ComponentMetadata(system);

Parameters

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

ComponentMetadata() ​

cpp
mavsdk::ComponentMetadata::ComponentMetadata(std::shared_ptr< System > system)

Constructor. Creates the plugin for a specific System.

The plugin is typically created as shown below:

cpp
auto component_metadata = ComponentMetadata(system);

Parameters

  • std::shared_ptr< System > system - The specific system associated with this plugin.

~ComponentMetadata() ​

cpp
mavsdk::ComponentMetadata::~ComponentMetadata() override

Destructor (internal use only).

ComponentMetadata() ​

cpp
mavsdk::ComponentMetadata::ComponentMetadata(const ComponentMetadata &other)

Copy constructor.

Parameters

Member Typdef Documentation ​

typedef ResultCallback ​

cpp
using mavsdk::ComponentMetadata::ResultCallback =  std::function<void(Result)>

Callback type for asynchronous ComponentMetadata calls.

typedef MetadataAvailableCallback ​

cpp
using mavsdk::ComponentMetadata::MetadataAvailableCallback =  std::function<void(MetadataUpdate)>

Callback type for subscribe_metadata_available.

typedef MetadataAvailableHandle ​

cpp
using mavsdk::ComponentMetadata::MetadataAvailableHandle =  Handle<MetadataUpdate>

Handle type for subscribe_metadata_available.

Member Enumeration Documentation ​

enum MetadataType ​

The metadata type.

ValueDescription
AllCompletedThis is set in the subscription callback when all metadata types completed for a given component ID.
ParameterParameter metadata.
EventsEvent definitions.
ActuatorsActuator definitions.

enum Result ​

Possible results returned.

ValueDescription
SuccessSuccess.
NotAvailableNot available.
ConnectionErrorConnection error.
UnsupportedUnsupported.
DeniedDenied.
FailedFailed.
TimeoutTimeout.
NoSystemNo system.
NotRequestedNot requested.

Member Function Documentation ​

request_component() ​

cpp
void mavsdk::ComponentMetadata::request_component(uint32_t compid) const

Request metadata from a specific component. This is used to start requesting metadata from a component. The metadata can later be accessed via subscription (see below) or GetMetadata.

This function is blocking.

Parameters

  • uint32_t compid -

request_autopilot_component() ​

cpp
void mavsdk::ComponentMetadata::request_autopilot_component() const

Request metadata from the autopilot component. This is used to start requesting metadata from the autopilot. The metadata can later be accessed via subscription (see below) or GetMetadata.

This function is blocking.

subscribe_metadata_available() ​

cpp
MetadataAvailableHandle mavsdk::ComponentMetadata::subscribe_metadata_available(const MetadataAvailableCallback &callback)

Register a callback that gets called when metadata is available.

Parameters

Returns

 MetadataAvailableHandle -

unsubscribe_metadata_available() ​

cpp
void mavsdk::ComponentMetadata::unsubscribe_metadata_available(MetadataAvailableHandle handle)

Unsubscribe from subscribe_metadata_available.

Parameters

get_metadata() ​

cpp
std::pair< Result, ComponentMetadata::MetadataData > mavsdk::ComponentMetadata::get_metadata(uint32_t compid, MetadataType metadata_type) const

Access metadata. This can be used if you know the metadata is available already, otherwise use the subscription to get notified when it becomes available.

This function is blocking.

Parameters

Returns

 std::pair< Result, ComponentMetadata::MetadataData > - Result of request.

operator=() ​

cpp
const ComponentMetadata & mavsdk::ComponentMetadata::operator=(const ComponentMetadata &)=delete

Equality operator (object is not copyable).

Parameters

Returns

 const ComponentMetadata & -