YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
ControlBoardRemapper_ParamsParser Class Reference

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

#include <controlBoardRemapper/ControlBoardRemapper_ParamsParser.h>

+ Inheritance diagram for ControlBoardRemapper_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 ControlBoardRemapper_ParamsParser ()
 
 ~ControlBoardRemapper_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 = {"ControlBoardRemapper"}
 
const std::string m_device_name = {"controlboardremapper"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_axesNames_defaultValue = {""}
 
const std::string m_networkNames_defaultValue = {""}
 
const std::string m_verbose_defaultValue = {"false"}
 
std::vector< std::string > m_axesNames = {}
 
std::vector< std::string > m_networkNames = {}
 
bool m_verbose = {false}
 

Detailed Description

This class is the parameters parser for class ControlBoardRemapper.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- axesNames vector<string> - - 0 Ordered list of the axes that are part of the remapped device. e.g.(/joint0 /joint1) -
- networkNames vector<string> - - 0 List of the robot parts to be used in remapped device. e.g.(/partA /partB) Deprecated. Requires additional params (here not specified). Cannot be used together with axesNames
- verbose bool - false 0 print additional output if enabled -

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

yarpdev --device controlboardremapper --axesNames <optional_value> --networkNames <optional_value> --verbose false
yarpdev --device controlboardremapper

Definition at line 43 of file ControlBoardRemapper_ParamsParser.h.

Constructor & Destructor Documentation

◆ ControlBoardRemapper_ParamsParser()

ControlBoardRemapper_ParamsParser::ControlBoardRemapper_ParamsParser ( )

Definition at line 23 of file ControlBoardRemapper_ParamsParser.cpp.

◆ ~ControlBoardRemapper_ParamsParser()

ControlBoardRemapper_ParamsParser::~ControlBoardRemapper_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getConfiguration()

std::string ControlBoardRemapper_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 77 of file ControlBoardRemapper_ParamsParser.cpp.

◆ getDeviceClassName()

std::string ControlBoardRemapper_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 71 of file ControlBoardRemapper_ParamsParser.h.

◆ getDeviceName()

std::string ControlBoardRemapper_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 72 of file ControlBoardRemapper_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string ControlBoardRemapper_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 198 of file ControlBoardRemapper_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > ControlBoardRemapper_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 ControlBoardRemapper_ParamsParser.cpp.

◆ getParamValue()

bool ControlBoardRemapper_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 38 of file ControlBoardRemapper_ParamsParser.cpp.

◆ parseParams()

bool ControlBoardRemapper_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 87 of file ControlBoardRemapper_ParamsParser.cpp.

Member Data Documentation

◆ m_axesNames

std::vector<std::string> ControlBoardRemapper_ParamsParser::m_axesNames = {}

Definition at line 66 of file ControlBoardRemapper_ParamsParser.h.

◆ m_axesNames_defaultValue

const std::string ControlBoardRemapper_ParamsParser::m_axesNames_defaultValue = {""}

Definition at line 62 of file ControlBoardRemapper_ParamsParser.h.

◆ m_device_classname

const std::string ControlBoardRemapper_ParamsParser::m_device_classname = {"ControlBoardRemapper"}

Definition at line 50 of file ControlBoardRemapper_ParamsParser.h.

◆ m_device_name

const std::string ControlBoardRemapper_ParamsParser::m_device_name = {"controlboardremapper"}

Definition at line 51 of file ControlBoardRemapper_ParamsParser.h.

◆ m_networkNames

std::vector<std::string> ControlBoardRemapper_ParamsParser::m_networkNames = {}

Definition at line 67 of file ControlBoardRemapper_ParamsParser.h.

◆ m_networkNames_defaultValue

const std::string ControlBoardRemapper_ParamsParser::m_networkNames_defaultValue = {""}

Definition at line 63 of file ControlBoardRemapper_ParamsParser.h.

◆ m_parser_is_strict

bool ControlBoardRemapper_ParamsParser::m_parser_is_strict = false

Definition at line 52 of file ControlBoardRemapper_ParamsParser.h.

◆ m_parser_version

const parser_version_type ControlBoardRemapper_ParamsParser::m_parser_version = {}

Definition at line 58 of file ControlBoardRemapper_ParamsParser.h.

◆ m_provided_configuration

std::string ControlBoardRemapper_ParamsParser::m_provided_configuration

Definition at line 60 of file ControlBoardRemapper_ParamsParser.h.

◆ m_verbose

bool ControlBoardRemapper_ParamsParser::m_verbose = {false}

Definition at line 68 of file ControlBoardRemapper_ParamsParser.h.

◆ m_verbose_defaultValue

const std::string ControlBoardRemapper_ParamsParser::m_verbose_defaultValue = {"false"}

Definition at line 64 of file ControlBoardRemapper_ParamsParser.h.


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