YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
FrameTransformClient_ParamsParser Class Reference

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

#include <frameTransformClient/FrameTransformClient_ParamsParser.h>

+ Inheritance diagram for FrameTransformClient_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 FrameTransformClient_ParamsParser ()
 
 ~FrameTransformClient_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 = {"FrameTransformClient"}
 
const std::string m_device_name = {"frameTransformClient"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_testxml_from_defaultValue = {""}
 
const std::string m_testxml_context_defaultValue = {""}
 
const std::string m_filexml_option_defaultValue = {"ftc_local_only.xml"}
 
const std::string m_local_rpc_defaultValue = {"/ftClient/rpc"}
 
const std::string m_FrameTransform_verbose_debug_defaultValue = {"false"}
 
const std::string m_period_defaultValue = {"0.10"}
 
std::string m_testxml_from = {}
 
std::string m_testxml_context = {}
 
std::string m_filexml_option = {"ftc_local_only.xml"}
 
std::string m_local_rpc = {"/ftClient/rpc"}
 
bool m_FrameTransform_verbose_debug = {false}
 
double m_period = {0.10}
 

Detailed Description

This class is the parameters parser for class FrameTransformClient.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- testxml_from string - - 0 xml configuration file name NB: FOR TEST ONLY.
- testxml_context string - - 0 xml configuration file context NB: FOR TEST ONLY.
- filexml_option string - ftc_local_only.xml 0 The name of the xml file containing the needed client configuration. if used, the name will be appended to config_xml/ it is mutually exclusive with testxml_from, testxml_context options
- local_rpc string - /ftClient/rpc 0 Full name of the client rpc port -
- FrameTransform_verbose_debug bool - false 0 Enable debug prints -
- period double s 0.10 0 thread period -

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

yarpdev --device frameTransformClient --testxml_from <optional_value> --testxml_context <optional_value> --filexml_option ftc_local_only.xml --local_rpc /ftClient/rpc --FrameTransform_verbose_debug false --period 0.10
yarpdev --device frameTransformClient

Definition at line 46 of file FrameTransformClient_ParamsParser.h.

Constructor & Destructor Documentation

◆ FrameTransformClient_ParamsParser()

FrameTransformClient_ParamsParser::FrameTransformClient_ParamsParser ( )

Definition at line 23 of file FrameTransformClient_ParamsParser.cpp.

◆ ~FrameTransformClient_ParamsParser()

FrameTransformClient_ParamsParser::~FrameTransformClient_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getConfiguration()

std::string FrameTransformClient_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 81 of file FrameTransformClient_ParamsParser.cpp.

◆ getDeviceClassName()

std::string FrameTransformClient_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 80 of file FrameTransformClient_ParamsParser.h.

◆ getDeviceName()

std::string FrameTransformClient_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 81 of file FrameTransformClient_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string FrameTransformClient_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 214 of file FrameTransformClient_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > FrameTransformClient_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 FrameTransformClient_ParamsParser.cpp.

◆ getParamValue()

bool FrameTransformClient_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 41 of file FrameTransformClient_ParamsParser.cpp.

◆ parseParams()

bool FrameTransformClient_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 91 of file FrameTransformClient_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string FrameTransformClient_ParamsParser::m_device_classname = {"FrameTransformClient"}

Definition at line 53 of file FrameTransformClient_ParamsParser.h.

◆ m_device_name

const std::string FrameTransformClient_ParamsParser::m_device_name = {"frameTransformClient"}

Definition at line 54 of file FrameTransformClient_ParamsParser.h.

◆ m_filexml_option

std::string FrameTransformClient_ParamsParser::m_filexml_option = {"ftc_local_only.xml"}

Definition at line 74 of file FrameTransformClient_ParamsParser.h.

◆ m_filexml_option_defaultValue

const std::string FrameTransformClient_ParamsParser::m_filexml_option_defaultValue = {"ftc_local_only.xml"}

Definition at line 67 of file FrameTransformClient_ParamsParser.h.

◆ m_FrameTransform_verbose_debug

bool FrameTransformClient_ParamsParser::m_FrameTransform_verbose_debug = {false}

Definition at line 76 of file FrameTransformClient_ParamsParser.h.

◆ m_FrameTransform_verbose_debug_defaultValue

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

Definition at line 69 of file FrameTransformClient_ParamsParser.h.

◆ m_local_rpc

std::string FrameTransformClient_ParamsParser::m_local_rpc = {"/ftClient/rpc"}

Definition at line 75 of file FrameTransformClient_ParamsParser.h.

◆ m_local_rpc_defaultValue

const std::string FrameTransformClient_ParamsParser::m_local_rpc_defaultValue = {"/ftClient/rpc"}

Definition at line 68 of file FrameTransformClient_ParamsParser.h.

◆ m_parser_is_strict

bool FrameTransformClient_ParamsParser::m_parser_is_strict = false

Definition at line 55 of file FrameTransformClient_ParamsParser.h.

◆ m_parser_version

const parser_version_type FrameTransformClient_ParamsParser::m_parser_version = {}

Definition at line 61 of file FrameTransformClient_ParamsParser.h.

◆ m_period

double FrameTransformClient_ParamsParser::m_period = {0.10}

Definition at line 77 of file FrameTransformClient_ParamsParser.h.

◆ m_period_defaultValue

const std::string FrameTransformClient_ParamsParser::m_period_defaultValue = {"0.10"}

Definition at line 70 of file FrameTransformClient_ParamsParser.h.

◆ m_provided_configuration

std::string FrameTransformClient_ParamsParser::m_provided_configuration

Definition at line 63 of file FrameTransformClient_ParamsParser.h.

◆ m_testxml_context

std::string FrameTransformClient_ParamsParser::m_testxml_context = {}

Definition at line 73 of file FrameTransformClient_ParamsParser.h.

◆ m_testxml_context_defaultValue

const std::string FrameTransformClient_ParamsParser::m_testxml_context_defaultValue = {""}

Definition at line 66 of file FrameTransformClient_ParamsParser.h.

◆ m_testxml_from

std::string FrameTransformClient_ParamsParser::m_testxml_from = {}

Definition at line 72 of file FrameTransformClient_ParamsParser.h.

◆ m_testxml_from_defaultValue

const std::string FrameTransformClient_ParamsParser::m_testxml_from_defaultValue = {""}

Definition at line 65 of file FrameTransformClient_ParamsParser.h.

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