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

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

#include <frameTransformServer/FrameTransformServer_ParamsParser.h>

+ Inheritance diagram for FrameTransformServer_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 FrameTransformServer_ParamsParser ()
 
 ~FrameTransformServer_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.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Public Attributes

const std::string m_device_classname = {"FrameTransformServer"}
 
const std::string m_device_name = {"frameTransformServer"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_testxml_from_defaultValue = {""}
 
const std::string m_testxml_context_defaultValue = {""}
 
const std::string m_filexml_option_defaultValue = {"fts_yarp_only.xml"}
 
const std::string m_local_rpc_defaultValue = {"/ftServer/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 = {"fts_yarp_only.xml"}
 
std::string m_local_rpc = {"/ftServer/rpc"}
 
bool m_FrameTransform_verbose_debug = {false}
 
double m_period = {0.10}
 

Detailed Description

This class is the parameters parser for class FrameTransformServer.

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 - fts_yarp_only.xml 0 The name of the xml file containing the needed configuration. if used, the name will be appended to config_xml/ it is mutually exclusive with testxml_from, testxml_context options
- local_rpc string - /ftServer/rpc 0 Full name of the 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 frameTransformServer --testxml_from <optional_value> --testxml_context <optional_value> --filexml_option fts_yarp_only.xml --local_rpc /ftServer/rpc --FrameTransform_verbose_debug false --period 0.10
yarpdev --device frameTransformServer

Definition at line 46 of file FrameTransformServer_ParamsParser.h.

Constructor & Destructor Documentation

◆ FrameTransformServer_ParamsParser()

FrameTransformServer_ParamsParser::FrameTransformServer_ParamsParser ( )

Definition at line 23 of file FrameTransformServer_ParamsParser.cpp.

◆ ~FrameTransformServer_ParamsParser()

FrameTransformServer_ParamsParser::~FrameTransformServer_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string FrameTransformServer_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 78 of file FrameTransformServer_ParamsParser.h.

◆ getDeviceName()

std::string FrameTransformServer_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 79 of file FrameTransformServer_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string FrameTransformServer_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 164 of file FrameTransformServer_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > FrameTransformServer_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 FrameTransformServer_ParamsParser.cpp.

◆ parseParams()

bool FrameTransformServer_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 41 of file FrameTransformServer_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string FrameTransformServer_ParamsParser::m_device_classname = {"FrameTransformServer"}

Definition at line 53 of file FrameTransformServer_ParamsParser.h.

◆ m_device_name

const std::string FrameTransformServer_ParamsParser::m_device_name = {"frameTransformServer"}

Definition at line 54 of file FrameTransformServer_ParamsParser.h.

◆ m_filexml_option

std::string FrameTransformServer_ParamsParser::m_filexml_option = {"fts_yarp_only.xml"}

Definition at line 72 of file FrameTransformServer_ParamsParser.h.

◆ m_filexml_option_defaultValue

const std::string FrameTransformServer_ParamsParser::m_filexml_option_defaultValue = {"fts_yarp_only.xml"}

Definition at line 65 of file FrameTransformServer_ParamsParser.h.

◆ m_FrameTransform_verbose_debug

bool FrameTransformServer_ParamsParser::m_FrameTransform_verbose_debug = {false}

Definition at line 74 of file FrameTransformServer_ParamsParser.h.

◆ m_FrameTransform_verbose_debug_defaultValue

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

Definition at line 67 of file FrameTransformServer_ParamsParser.h.

◆ m_local_rpc

std::string FrameTransformServer_ParamsParser::m_local_rpc = {"/ftServer/rpc"}

Definition at line 73 of file FrameTransformServer_ParamsParser.h.

◆ m_local_rpc_defaultValue

const std::string FrameTransformServer_ParamsParser::m_local_rpc_defaultValue = {"/ftServer/rpc"}

Definition at line 66 of file FrameTransformServer_ParamsParser.h.

◆ m_parser_is_strict

bool FrameTransformServer_ParamsParser::m_parser_is_strict = false

Definition at line 55 of file FrameTransformServer_ParamsParser.h.

◆ m_parser_version

const parser_version_type FrameTransformServer_ParamsParser::m_parser_version = {}

Definition at line 61 of file FrameTransformServer_ParamsParser.h.

◆ m_period

double FrameTransformServer_ParamsParser::m_period = {0.10}

Definition at line 75 of file FrameTransformServer_ParamsParser.h.

◆ m_period_defaultValue

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

Definition at line 68 of file FrameTransformServer_ParamsParser.h.

◆ m_testxml_context

std::string FrameTransformServer_ParamsParser::m_testxml_context = {}

Definition at line 71 of file FrameTransformServer_ParamsParser.h.

◆ m_testxml_context_defaultValue

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

Definition at line 64 of file FrameTransformServer_ParamsParser.h.

◆ m_testxml_from

std::string FrameTransformServer_ParamsParser::m_testxml_from = {}

Definition at line 70 of file FrameTransformServer_ParamsParser.h.

◆ m_testxml_from_defaultValue

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

Definition at line 63 of file FrameTransformServer_ParamsParser.h.

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