mavsdk::ParamServer Class Reference

#include: param_server.h

Provide raw access to retrieve and provide server parameters.

Data Structures

struct AllParams

struct CustomParam

struct FloatParam

struct IntParam

Public Types

Public Member Functions

Constructor & Destructor Documentation

ParamServer()

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

Constructor. Creates the plugin for a ServerComponent instance.

The plugin is typically created as shown below:

auto param_server = ParamServer(server_component);

Parameters

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

~ParamServer()

mavsdk::ParamServer::~ParamServer() override

Destructor (internal use only).

ParamServer()

mavsdk::ParamServer::ParamServer(const ParamServer &other)

Copy constructor.

Parameters

• const ParamServer& other -

Member Typdef Documentation

typedef ResultCallback

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

Callback type for asynchronous ParamServer calls.

typedef ChangedParamIntCallback

using mavsdk::ParamServer::ChangedParamIntCallback =  std::function<void(IntParam)>

Callback type for subscribe_changed_param_int.

typedef ChangedParamIntHandle

using mavsdk::ParamServer::ChangedParamIntHandle =  Handle<IntParam>

Handle type for subscribe_changed_param_int.

typedef ChangedParamFloatCallback

using mavsdk::ParamServer::ChangedParamFloatCallback =  std::function<void(FloatParam)>

Callback type for subscribe_changed_param_float.

typedef ChangedParamFloatHandle

using mavsdk::ParamServer::ChangedParamFloatHandle =  Handle<FloatParam>

Handle type for subscribe_changed_param_float.

typedef ChangedParamCustomCallback

using mavsdk::ParamServer::ChangedParamCustomCallback =  std::function<void(CustomParam)>

Callback type for subscribe_changed_param_custom.

typedef ChangedParamCustomHandle

using mavsdk::ParamServer::ChangedParamCustomHandle =  Handle<CustomParam>

Handle type for subscribe_changed_param_custom.

Member Enumeration Documentation

enum Result

Possible results returned for param requests.

Member Function Documentation

retrieve_param_int()

std::pair<Result, int32_t> mavsdk::ParamServer::retrieve_param_int(std::string name) const

Retrieve an int parameter.

If the type is wrong, the result will be WRONG_TYPE.

This function is blocking.

Parameters

• std::string name -

Returns

 std::pair< Result, int32_t > - Result of request.

provide_param_int()

Result mavsdk::ParamServer::provide_param_int(std::string name, int32_t value) const

Provide an int parameter.

If the type is wrong, the result will be WRONG_TYPE.

This function is blocking.

Parameters

• std::string name -
• int32_t value -

Returns

 Result - Result of request.

retrieve_param_float()

std::pair<Result, float> mavsdk::ParamServer::retrieve_param_float(std::string name) const

Retrieve a float parameter.

If the type is wrong, the result will be WRONG_TYPE.

This function is blocking.

Parameters

• std::string name -

Returns

 std::pair< Result, float > - Result of request.

provide_param_float()

Result mavsdk::ParamServer::provide_param_float(std::string name, float value) const

Provide a float parameter.

If the type is wrong, the result will be WRONG_TYPE.

This function is blocking.

Parameters

• std::string name -
• float value -

Returns

 Result - Result of request.

retrieve_param_custom()

std::pair<Result, std::string> mavsdk::ParamServer::retrieve_param_custom(std::string name) const

Retrieve a custom parameter.

If the type is wrong, the result will be WRONG_TYPE.

This function is blocking.

Parameters

• std::string name -

Returns

 std::pair< Result, std::string > - Result of request.

provide_param_custom()

Result mavsdk::ParamServer::provide_param_custom(std::string name, std::string value) const

Provide a custom parameter.

If the type is wrong, the result will be WRONG_TYPE.

This function is blocking.

Parameters

• std::string name -
• std::string value -

Returns

 Result - Result of request.

retrieve_all_params()

ParamServer::AllParams mavsdk::ParamServer::retrieve_all_params() const

Retrieve all parameters.

This function is blocking.

Returns

 ParamServer::AllParams - Result of request.

subscribe_changed_param_int()

ChangedParamIntHandle mavsdk::ParamServer::subscribe_changed_param_int(const ChangedParamIntCallback &callback)

Subscribe to changed int param.

Parameters

• const ChangedParamIntCallback& callback -

Returns

 ChangedParamIntHandle -

unsubscribe_changed_param_int()

void mavsdk::ParamServer::unsubscribe_changed_param_int(ChangedParamIntHandle handle)

Unsubscribe from subscribe_changed_param_int.

Parameters

• ChangedParamIntHandle handle -

subscribe_changed_param_float()

ChangedParamFloatHandle mavsdk::ParamServer::subscribe_changed_param_float(const ChangedParamFloatCallback &callback)

Subscribe to changed float param.

Parameters

• const ChangedParamFloatCallback& callback -

Returns

 ChangedParamFloatHandle -

unsubscribe_changed_param_float()

void mavsdk::ParamServer::unsubscribe_changed_param_float(ChangedParamFloatHandle handle)

Unsubscribe from subscribe_changed_param_float.

Parameters

• ChangedParamFloatHandle handle -

subscribe_changed_param_custom()

ChangedParamCustomHandle mavsdk::ParamServer::subscribe_changed_param_custom(const ChangedParamCustomCallback &callback)

Subscribe to changed custom param.

Parameters

• const ChangedParamCustomCallback& callback -

Returns

 ChangedParamCustomHandle -

unsubscribe_changed_param_custom()

void mavsdk::ParamServer::unsubscribe_changed_param_custom(ChangedParamCustomHandle handle)

Unsubscribe from subscribe_changed_param_custom.

Parameters

• ChangedParamCustomHandle handle -

operator=()

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

Equality operator (object is not copyable).

Parameters

• const ParamServer& -

Returns

 const ParamServer & -