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

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

#include <controlBoardRemapper/RemoteControlBoardRemapper_ParamsParser.h>

+ Inheritance diagram for RemoteControlBoardRemapper_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 RemoteControlBoardRemapper_ParamsParser ()
 
 ~RemoteControlBoardRemapper_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 = {"RemoteControlBoardRemapper"}
 
const std::string m_device_name = {"remotecontrolboardremapper"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_remoteControlBoards_defaultValue = {""}
 
const std::string m_axesNames_defaultValue = {""}
 
const std::string m_localPortPrefix_defaultValue = {""}
 
const std::string m_verbose_defaultValue = {"false"}
 
std::vector< std::string > m_remoteControlBoards = {}
 
std::vector< std::string > m_axesNames = {}
 
std::string m_localPortPrefix = {}
 
bool m_verbose = {false}
 

Detailed Description

This class is the parameters parser for class RemoteControlBoardRemapper.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- remoteControlBoards vector<string> - - 1 Ordered list of the axes that are part of the remapped device. -
- axesNames vector<string> - - 1 List of remote prefix used by the remote controlboards The element of this list are then passed as "remote" parameter to the RemoteControlBoard device.
- localPortPrefix string - - 1 All ports opened by this device will start with this prefix -
- 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 remotecontrolboardremapper --remoteControlBoards <mandatory_value> --axesNames <mandatory_value> --localPortPrefix <mandatory_value> --verbose false
yarpdev --device remotecontrolboardremapper --remoteControlBoards <mandatory_value> --axesNames <mandatory_value> --localPortPrefix <mandatory_value>

Definition at line 44 of file RemoteControlBoardRemapper_ParamsParser.h.

Constructor & Destructor Documentation

◆ RemoteControlBoardRemapper_ParamsParser()

RemoteControlBoardRemapper_ParamsParser::RemoteControlBoardRemapper_ParamsParser ( )

Definition at line 23 of file RemoteControlBoardRemapper_ParamsParser.cpp.

◆ ~RemoteControlBoardRemapper_ParamsParser()

RemoteControlBoardRemapper_ParamsParser::~RemoteControlBoardRemapper_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getConfiguration()

std::string RemoteControlBoardRemapper_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 83 of file RemoteControlBoardRemapper_ParamsParser.cpp.

◆ getDeviceClassName()

std::string RemoteControlBoardRemapper_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 74 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ getDeviceName()

std::string RemoteControlBoardRemapper_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 75 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string RemoteControlBoardRemapper_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 224 of file RemoteControlBoardRemapper_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > RemoteControlBoardRemapper_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 RemoteControlBoardRemapper_ParamsParser.cpp.

◆ getParamValue()

bool RemoteControlBoardRemapper_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 39 of file RemoteControlBoardRemapper_ParamsParser.cpp.

◆ parseParams()

bool RemoteControlBoardRemapper_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 93 of file RemoteControlBoardRemapper_ParamsParser.cpp.

Member Data Documentation

◆ m_axesNames

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

Definition at line 69 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_axesNames_defaultValue

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

Definition at line 64 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_device_classname

const std::string RemoteControlBoardRemapper_ParamsParser::m_device_classname = {"RemoteControlBoardRemapper"}

Definition at line 51 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_device_name

const std::string RemoteControlBoardRemapper_ParamsParser::m_device_name = {"remotecontrolboardremapper"}

Definition at line 52 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_localPortPrefix

std::string RemoteControlBoardRemapper_ParamsParser::m_localPortPrefix = {}

Definition at line 70 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_localPortPrefix_defaultValue

const std::string RemoteControlBoardRemapper_ParamsParser::m_localPortPrefix_defaultValue = {""}

Definition at line 65 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_parser_is_strict

bool RemoteControlBoardRemapper_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_parser_version

const parser_version_type RemoteControlBoardRemapper_ParamsParser::m_parser_version = {}

Definition at line 59 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_provided_configuration

std::string RemoteControlBoardRemapper_ParamsParser::m_provided_configuration

Definition at line 61 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_remoteControlBoards

std::vector<std::string> RemoteControlBoardRemapper_ParamsParser::m_remoteControlBoards = {}

Definition at line 68 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_remoteControlBoards_defaultValue

const std::string RemoteControlBoardRemapper_ParamsParser::m_remoteControlBoards_defaultValue = {""}

Definition at line 63 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_verbose

bool RemoteControlBoardRemapper_ParamsParser::m_verbose = {false}

Definition at line 71 of file RemoteControlBoardRemapper_ParamsParser.h.

◆ m_verbose_defaultValue

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

Definition at line 66 of file RemoteControlBoardRemapper_ParamsParser.h.


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