libuav original

Dependents:   UAVCAN UAVCAN_Subscriber

Embed: (wiki syntax)

« Back to documentation index

IParamManager Class Reference

IParamManager Class Reference

Implement this interface in the application to support the standard remote reconfiguration services. More...

#include <param_server.hpp>

Inherited by ParamServerTestManager.

Public Member Functions

virtual void getParamNameByIndex (Index index, Name &out_name) const =0
 Copy the parameter name to out_name if it exists, otherwise do nothing.
virtual void assignParamValue (const Name &name, const Value &value)=0
 Assign by name if exists.
virtual void readParamValue (const Name &name, Value &out_value) const =0
 Read by name if exists, otherwise do nothing.
virtual void readParamDefaultMaxMin (const Name &name, Value &out_default, NumericValue &out_max, NumericValue &out_min) const
 Read param's default/max/min if available.
virtual int saveAllParams ()=0
 Save all params to non-volatile storage.
virtual int eraseAllParams ()=0
 Clear the non-volatile storage.

Detailed Description

Implement this interface in the application to support the standard remote reconfiguration services.

Refer to ParamServer.

Definition at line 22 of file param_server.hpp.


Member Function Documentation

virtual void assignParamValue ( const Name &  name,
const Value &  value 
) [pure virtual]

Assign by name if exists.

virtual int eraseAllParams (  ) [pure virtual]

Clear the non-volatile storage.

Returns:
Negative if failed.
virtual void getParamNameByIndex ( Index  index,
Name &  out_name 
) const [pure virtual]

Copy the parameter name to out_name if it exists, otherwise do nothing.

virtual void readParamDefaultMaxMin ( const Name &  name,
Value &  out_default,
NumericValue &  out_max,
NumericValue &  out_min 
) const [virtual]

Read param's default/max/min if available.

Note that min/max are only applicable to numeric params. Implementation is optional.

Definition at line 52 of file param_server.hpp.

virtual void readParamValue ( const Name &  name,
Value &  out_value 
) const [pure virtual]

Read by name if exists, otherwise do nothing.

virtual int saveAllParams (  ) [pure virtual]

Save all params to non-volatile storage.

Returns:
Negative if failed.