uavcan::IParamManager Class Reference

#include <param_server.hpp>

Inheritance diagram for uavcan::IParamManager:

Public Types
typedef StorageType< typename protocol::param::GetSet::Request::FieldTypes::index >::Type	Index
typedef StorageType< typename protocol::param::GetSet::Response::FieldTypes::name >::Type	Name
typedef protocol::param::NumericValue	NumericValue
typedef protocol::param::Value	Value

Public Member Functions
virtual void	assignParamValue (const Name &name, const Value &value)=0
virtual int	eraseAllParams ()=0
virtual void	getParamNameByIndex (Index index, Name &out_name) const =0
virtual void	readParamDefaultMaxMin (const Name &name, Value &out_default, NumericValue &out_max, NumericValue &out_min) const
virtual void	readParamValue (const Name &name, Value &out_value) const =0
virtual int	saveAllParams ()=0
virtual	~IParamManager ()

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 Typedef Documentation

Index

typedef StorageType<typename protocol::param::GetSet::Request::FieldTypes::index>::Type uavcan::IParamManager::Index

Definition at line 26 of file param_server.hpp.

Name

typedef StorageType<typename protocol::param::GetSet::Response::FieldTypes::name>::Type uavcan::IParamManager::Name

Definition at line 25 of file param_server.hpp.

NumericValue

typedef protocol::param::NumericValue uavcan::IParamManager::NumericValue

Definition at line 28 of file param_server.hpp.

Value

typedef protocol::param::Value uavcan::IParamManager::Value

Definition at line 27 of file param_server.hpp.

Constructor & Destructor Documentation

~IParamManager()

virtual uavcan::IParamManager::~IParamManager ( )

inlinevirtual

Definition at line 30 of file param_server.hpp.

Member Function Documentation

assignParamValue()

virtual void uavcan::IParamManager::assignParamValue ( const Name &  name, const Value &  value  )

pure virtual

Assign by name if exists.

eraseAllParams()

virtual int uavcan::IParamManager::eraseAllParams ( )

pure virtual

Clear the non-volatile storage.

Returns

Negative if failed.

Implemented in ParamServerTestManager.

getParamNameByIndex()

virtual void uavcan::IParamManager::getParamNameByIndex ( Index  index, Name &  out_name  ) const

pure virtual

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

readParamDefaultMaxMin()

virtual void uavcan::IParamManager::readParamDefaultMaxMin ( const Name &  name, Value &  out_default, NumericValue &  out_max, NumericValue &  out_min  ) const

inlinevirtual

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.

readParamValue()

virtual void uavcan::IParamManager::readParamValue ( const Name &  name, Value &  out_value  ) const

pure virtual

Read by name if exists, otherwise do nothing.

saveAllParams()

virtual int uavcan::IParamManager::saveAllParams ( )

pure virtual

Save all params to non-volatile storage.

Returns

Negative if failed.

Implemented in ParamServerTestManager.

---

The documentation for this class was generated from the following file:

• param_server.hpp