mavsdk::ComponentMetadataServer Class Reference

#include: component_metadata_server.h

Provide component metadata json definitions, such as parameters.

Data Structures

Public Types

Type	Description
enum MetadataType	The metadata type.

Public Member Functions

Type	Name	Description
	ComponentMetadataServer (std::shared_ptr< ServerComponent > server_component)	Constructor. Creates the plugin for a ServerComponent instance.
	~ComponentMetadataServer () override	Destructor (internal use only).
	ComponentMetadataServer (const ComponentMetadataServer & other)	Copy constructor.
void	set_metadata (std::vector< Metadata > metadata)const	Provide metadata (can only be called once)
const ComponentMetadataServer &	operator= (const ComponentMetadataServer &)=delete	Equality operator (object is not copyable).

Constructor & Destructor Documentation

ComponentMetadataServer()

cpp

mavsdk::ComponentMetadataServer::ComponentMetadataServer(std::shared_ptr< ServerComponent > server_component)

Constructor. Creates the plugin for a ServerComponent instance.

The plugin is typically created as shown below:

cpp

auto component_metadata_server = ComponentMetadataServer(server_component);

Parameters

std::shared_ptr< ServerComponent > server_component - The ServerComponent instance associated with this server plugin.

~ComponentMetadataServer()

cpp

mavsdk::ComponentMetadataServer::~ComponentMetadataServer() override

Destructor (internal use only).

ComponentMetadataServer()

cpp

mavsdk::ComponentMetadataServer::ComponentMetadataServer(const ComponentMetadataServer &other)

Copy constructor.

Parameters

const ComponentMetadataServer& other -

Member Enumeration Documentation

enum MetadataType

The metadata type.

Value	Description
`Parameter`	Parameter metadata.
`Events`	Event definitions.
`Actuators`	Actuator definitions.

Member Function Documentation

set_metadata()

cpp

void mavsdk::ComponentMetadataServer::set_metadata(std::vector< Metadata > metadata) const

Provide metadata (can only be called once)

This function is blocking.

Parameters

std::vector< Metadata > metadata -

operator=()

cpp

const ComponentMetadataServer & mavsdk::ComponentMetadataServer::operator=(const ComponentMetadataServer &)=delete

Equality operator (object is not copyable).

Parameters

const ComponentMetadataServer& -

Returns

const ComponentMetadataServer & -

class ActionServer

class Calibration

class Camera

class CameraServer

class ComponentMetadata

class ComponentMetadataServer

class Events

class FollowMe

class Ftp

class Geofence

class geometry::CoordinateTransformation

class Gimbal

class Info

class LogFiles

class LogStreaming

class MavlinkPassthrough

class Mavsdk

class Mission

class MissionRaw

class MissionRawServer

class Mocap

class Offboard

class Param

class ParamServer

class Rtk

class Telemetry

class TelemetryServer

class Transponder

class Tune

class Winch

mavsdk::ComponentMetadataServer Class Reference ​

Data Structures ​

Public Types ​

Public Member Functions ​

Constructor & Destructor Documentation ​

ComponentMetadataServer() ​

~ComponentMetadataServer() ​

ComponentMetadataServer() ​

Member Enumeration Documentation ​

enum MetadataType ​

Member Function Documentation ​

set_metadata() ​

operator=() ​

mavsdk::ComponentMetadataServer Class Reference

Data Structures

Public Types

Public Member Functions

Constructor & Destructor Documentation

ComponentMetadataServer()

~ComponentMetadataServer()

ComponentMetadataServer()

Member Enumeration Documentation

enum MetadataType

Member Function Documentation

set_metadata()

operator=()