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

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

#include <networkWrappers/controlBoard_nws_yarp/ControlBoard_nws_yarp_ParamsParser.h>

+ Inheritance diagram for ControlBoard_nws_yarp_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 ControlBoard_nws_yarp_ParamsParser ()
 
 ~ControlBoard_nws_yarp_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 = {"ControlBoard_nws_yarp"}
 
const std::string m_device_name = {"controlBoard_nws_yarp"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_period_defaultValue = {"0.02"}
 
const std::string m_name_defaultValue = {"/robot/part"}
 
double m_period = {0.02}
 
std::string m_name = {"/robot/part"}
 

Detailed Description

This class is the parameters parser for class ControlBoard_nws_yarp.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- period double s 0.02 0 period of the main thread -
- name string - /robot/part 1 Prefix name of the ports opened by the device opened ports will be: xxx/rpc:i xxx/command:i xxx/state:o xxx/stateExt:o

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

yarpdev --device controlBoard_nws_yarp --period 0.02 --name /robot/part
yarpdev --device controlBoard_nws_yarp --name /robot/part

Definition at line 42 of file ControlBoard_nws_yarp_ParamsParser.h.

Constructor & Destructor Documentation

◆ ControlBoard_nws_yarp_ParamsParser()

ControlBoard_nws_yarp_ParamsParser::ControlBoard_nws_yarp_ParamsParser ( )

Definition at line 23 of file ControlBoard_nws_yarp_ParamsParser.cpp.

◆ ~ControlBoard_nws_yarp_ParamsParser()

ControlBoard_nws_yarp_ParamsParser::~ControlBoard_nws_yarp_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string ControlBoard_nws_yarp_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 66 of file ControlBoard_nws_yarp_ParamsParser.h.

◆ getDeviceName()

std::string ControlBoard_nws_yarp_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 67 of file ControlBoard_nws_yarp_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string ControlBoard_nws_yarp_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 106 of file ControlBoard_nws_yarp_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > ControlBoard_nws_yarp_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 ControlBoard_nws_yarp_ParamsParser.cpp.

◆ parseParams()

bool ControlBoard_nws_yarp_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 37 of file ControlBoard_nws_yarp_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string ControlBoard_nws_yarp_ParamsParser::m_device_classname = {"ControlBoard_nws_yarp"}

Definition at line 49 of file ControlBoard_nws_yarp_ParamsParser.h.

◆ m_device_name

const std::string ControlBoard_nws_yarp_ParamsParser::m_device_name = {"controlBoard_nws_yarp"}

Definition at line 50 of file ControlBoard_nws_yarp_ParamsParser.h.

◆ m_name

std::string ControlBoard_nws_yarp_ParamsParser::m_name = {"/robot/part"}

Definition at line 63 of file ControlBoard_nws_yarp_ParamsParser.h.

◆ m_name_defaultValue

const std::string ControlBoard_nws_yarp_ParamsParser::m_name_defaultValue = {"/robot/part"}

Definition at line 60 of file ControlBoard_nws_yarp_ParamsParser.h.

◆ m_parser_is_strict

bool ControlBoard_nws_yarp_ParamsParser::m_parser_is_strict = false

Definition at line 51 of file ControlBoard_nws_yarp_ParamsParser.h.

◆ m_parser_version

const parser_version_type ControlBoard_nws_yarp_ParamsParser::m_parser_version = {}

Definition at line 57 of file ControlBoard_nws_yarp_ParamsParser.h.

◆ m_period

double ControlBoard_nws_yarp_ParamsParser::m_period = {0.02}

Definition at line 62 of file ControlBoard_nws_yarp_ParamsParser.h.

◆ m_period_defaultValue

const std::string ControlBoard_nws_yarp_ParamsParser::m_period_defaultValue = {"0.02"}

Definition at line 59 of file ControlBoard_nws_yarp_ParamsParser.h.

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