FrameTransformStorage_ParamsParser Class Reference

This class is the parameters parser for class FrameTransformStorage. More...

#include <frameTransformStorage/FrameTransformStorage_ParamsParser.h>

Inheritance diagram for FrameTransformStorage_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FrameTransformStorage_ParamsParser ()
	~FrameTransformStorage_ParamsParser () override=default
bool	parseParams (const yarp::os::Searchable &config) override
	Parse the DeviceDriver parameters.
std::string	getDeviceClassName () const override
	Get the name of the DeviceDriver class.
std::string	getDeviceName () const override
	Get the name of the device (i.e.
std::string	getDocumentationOfDeviceParams () const override
	Get the documentation of the DeviceDriver's parameters.
std::vector< std::string >	getListOfParams () const override
	Return a list of all params used by the device.
bool	getParamValue (const std::string &paramName, std::string &paramValue) const override
	Return the value (represented as a string) of the requested parameter.
std::string	getConfiguration () const override
	Return the configuration of the device.
Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Public Attributes
const std::string	m_device_classname = {"FrameTransformStorage"}
const std::string	m_device_name = {"frameTransformStorage"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
std::string	m_provided_configuration
const std::string	m_FrameTransform_verbose_debug_defaultValue = {"false"}
const std::string	m_FrameTransform_container_timeout_defaultValue = {"0.2"}
bool	m_FrameTransform_verbose_debug = {false}
double	m_FrameTransform_container_timeout = {0.2}

Detailed Description

This class is the parameters parser for class FrameTransformStorage.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	FrameTransform_verbose_debug	bool	-	false	0	Enables additinal debug print	NB: FOR TEST ONLY.
-	FrameTransform_container_timeout	double	s	0.2	0	After this time, not-refreshed transforms will be deleted	-

The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):

yarpdev --device frameTransformStorage --FrameTransform_verbose_debug false --FrameTransform_container_timeout 0.2

yarpdev --device frameTransformStorage

Definition at line 42 of file FrameTransformStorage_ParamsParser.h.

Constructor & Destructor Documentation

FrameTransformStorage_ParamsParser()

FrameTransformStorage_ParamsParser::FrameTransformStorage_ParamsParser

(

)

Definition at line 23 of file FrameTransformStorage_ParamsParser.cpp.

~FrameTransformStorage_ParamsParser()

FrameTransformStorage_ParamsParser::~FrameTransformStorage_ParamsParser ( )

overridedefault

Member Function Documentation

getConfiguration()

std::string FrameTransformStorage_ParamsParser::getConfiguration ( ) const

overridevirtual

Return the configuration of the device.

Returns

The configuration of the device, represented in a string format.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 57 of file FrameTransformStorage_ParamsParser.cpp.

getDeviceClassName()

std::string FrameTransformStorage_ParamsParser::getDeviceClassName ( ) const

inlineoverridevirtual

Get the name of the DeviceDriver class.

Returns

A string containing the name of the class.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 68 of file FrameTransformStorage_ParamsParser.h.

getDeviceName()

std::string FrameTransformStorage_ParamsParser::getDeviceName ( ) const

inlineoverridevirtual

Get the name of the device (i.e.

the plugin name).

Returns

A string containing the name of the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 69 of file FrameTransformStorage_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string FrameTransformStorage_ParamsParser::getDocumentationOfDeviceParams ( ) const

overridevirtual

Get the documentation of the DeviceDriver's parameters.

Returns

A string containing the documentation.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 134 of file FrameTransformStorage_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > FrameTransformStorage_ParamsParser::getListOfParams ( ) const

overridevirtual

Return a list of all params used by the device.

Returns

A vector containing the names of parameters used by the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 28 of file FrameTransformStorage_ParamsParser.cpp.

getParamValue()

bool FrameTransformStorage_ParamsParser::getParamValue ( const std::string &  paramName, std::string &  paramValue  ) const

overridevirtual

Return the value (represented as a string) of the requested parameter.

Returns

True if the requested parameter was succesfully retrieved.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 37 of file FrameTransformStorage_ParamsParser.cpp.

parseParams()

bool FrameTransformStorage_ParamsParser::parseParams ( const yarp::os::Searchable &  config )

overridevirtual

Parse the DeviceDriver parameters.

Returns

true if the parsing is successful, false otherwise

Implements yarp::dev::IDeviceDriverParams.

Definition at line 67 of file FrameTransformStorage_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string FrameTransformStorage_ParamsParser::m_device_classname = {"FrameTransformStorage"}

Definition at line 49 of file FrameTransformStorage_ParamsParser.h.

m_device_name

const std::string FrameTransformStorage_ParamsParser::m_device_name = {"frameTransformStorage"}

Definition at line 50 of file FrameTransformStorage_ParamsParser.h.

m_FrameTransform_container_timeout

double FrameTransformStorage_ParamsParser::m_FrameTransform_container_timeout = {0.2}

Definition at line 65 of file FrameTransformStorage_ParamsParser.h.

m_FrameTransform_container_timeout_defaultValue

const std::string FrameTransformStorage_ParamsParser::m_FrameTransform_container_timeout_defaultValue = {"0.2"}

Definition at line 62 of file FrameTransformStorage_ParamsParser.h.

m_FrameTransform_verbose_debug

bool FrameTransformStorage_ParamsParser::m_FrameTransform_verbose_debug = {false}

Definition at line 64 of file FrameTransformStorage_ParamsParser.h.

m_FrameTransform_verbose_debug_defaultValue

const std::string FrameTransformStorage_ParamsParser::m_FrameTransform_verbose_debug_defaultValue = {"false"}

Definition at line 61 of file FrameTransformStorage_ParamsParser.h.

m_parser_is_strict

bool FrameTransformStorage_ParamsParser::m_parser_is_strict = false

Definition at line 51 of file FrameTransformStorage_ParamsParser.h.

m_parser_version

const parser_version_type FrameTransformStorage_ParamsParser::m_parser_version = {}

Definition at line 57 of file FrameTransformStorage_ParamsParser.h.

m_provided_configuration

std::string FrameTransformStorage_ParamsParser::m_provided_configuration

Definition at line 59 of file FrameTransformStorage_ParamsParser.h.

---

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

• src/devices/frameTransformStorage/FrameTransformStorage_ParamsParser.h
• src/devices/frameTransformStorage/FrameTransformStorage_ParamsParser.cpp