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

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

#include <networkWrappers/serialPort_nws_yarp/SerialPort_nws_yarp_ParamsParser.h>

+ Inheritance diagram for SerialPort_nws_yarp_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 SerialPort_nws_yarp_ParamsParser ()
 
 ~SerialPort_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 = {"SerialPort_nws_yarp"}
 
const std::string m_device_name = {"serialPort_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 = {""}
 
const std::string m_frame_id_defaultValue = {""}
 
double m_period = {0.02}
 
std::string m_name = {}
 
std::string m_frame_id = {}
 

Detailed Description

This class is the parameters parser for class SerialPort_nws_yarp.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- period double s 0.02 0 refresh period of the broadcasted values in s default 0.02s
- name string - - 1 Prefix name of the ports opened by the wrapper, e.g. /robotName/Rangefinder2DSensor Required suffix like '/rpc' will be added by the device
- frame_id string - - 0 name of the attached frame Currently not used, reserved for future use

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

yarpdev --device serialPort_nws_yarp --period 0.02 --name <mandatory_value> --frame_id <optional_value>
yarpdev --device serialPort_nws_yarp --name <mandatory_value>

Definition at line 43 of file SerialPort_nws_yarp_ParamsParser.h.

Constructor & Destructor Documentation

◆ SerialPort_nws_yarp_ParamsParser()

SerialPort_nws_yarp_ParamsParser::SerialPort_nws_yarp_ParamsParser ( )

Definition at line 23 of file SerialPort_nws_yarp_ParamsParser.cpp.

◆ ~SerialPort_nws_yarp_ParamsParser()

SerialPort_nws_yarp_ParamsParser::~SerialPort_nws_yarp_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string SerialPort_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 69 of file SerialPort_nws_yarp_ParamsParser.h.

◆ getDeviceName()

std::string SerialPort_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 70 of file SerialPort_nws_yarp_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string SerialPort_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 121 of file SerialPort_nws_yarp_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > SerialPort_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 SerialPort_nws_yarp_ParamsParser.cpp.

◆ parseParams()

bool SerialPort_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 38 of file SerialPort_nws_yarp_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string SerialPort_nws_yarp_ParamsParser::m_device_classname = {"SerialPort_nws_yarp"}

Definition at line 50 of file SerialPort_nws_yarp_ParamsParser.h.

◆ m_device_name

const std::string SerialPort_nws_yarp_ParamsParser::m_device_name = {"serialPort_nws_yarp"}

Definition at line 51 of file SerialPort_nws_yarp_ParamsParser.h.

◆ m_frame_id

std::string SerialPort_nws_yarp_ParamsParser::m_frame_id = {}

Definition at line 66 of file SerialPort_nws_yarp_ParamsParser.h.

◆ m_frame_id_defaultValue

const std::string SerialPort_nws_yarp_ParamsParser::m_frame_id_defaultValue = {""}

Definition at line 62 of file SerialPort_nws_yarp_ParamsParser.h.

◆ m_name

std::string SerialPort_nws_yarp_ParamsParser::m_name = {}

Definition at line 65 of file SerialPort_nws_yarp_ParamsParser.h.

◆ m_name_defaultValue

const std::string SerialPort_nws_yarp_ParamsParser::m_name_defaultValue = {""}

Definition at line 61 of file SerialPort_nws_yarp_ParamsParser.h.

◆ m_parser_is_strict

bool SerialPort_nws_yarp_ParamsParser::m_parser_is_strict = false

Definition at line 52 of file SerialPort_nws_yarp_ParamsParser.h.

◆ m_parser_version

const parser_version_type SerialPort_nws_yarp_ParamsParser::m_parser_version = {}

Definition at line 58 of file SerialPort_nws_yarp_ParamsParser.h.

◆ m_period

double SerialPort_nws_yarp_ParamsParser::m_period = {0.02}

Definition at line 64 of file SerialPort_nws_yarp_ParamsParser.h.

◆ m_period_defaultValue

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

Definition at line 60 of file SerialPort_nws_yarp_ParamsParser.h.

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