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

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

#include <networkWrappers/serialPort_nwc_yarp/SerialPort_nwc_yarp_ParamsParser.h>

+ Inheritance diagram for SerialPort_nwc_yarp_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 SerialPort_nwc_yarp_ParamsParser ()
 
 ~SerialPort_nwc_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.
 
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 = {"SerialPort_nwc_yarp"}
 
const std::string m_device_name = {"serialPort_nwc_yarp"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_local_defaultValue = {""}
 
const std::string m_remote_defaultValue = {""}
 
std::string m_local = {}
 
std::string m_remote = {}
 

Detailed Description

This class is the parameters parser for class SerialPort_nwc_yarp.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- local string - - 1 Full port name opened by the device. -
- remote string - - 1 Full port name of the port opened on the server side, to which the device connects to. -

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

yarpdev --device serialPort_nwc_yarp --local <mandatory_value> --remote <mandatory_value>
yarpdev --device serialPort_nwc_yarp --local <mandatory_value> --remote <mandatory_value>

Definition at line 42 of file SerialPort_nwc_yarp_ParamsParser.h.

Constructor & Destructor Documentation

◆ SerialPort_nwc_yarp_ParamsParser()

SerialPort_nwc_yarp_ParamsParser::SerialPort_nwc_yarp_ParamsParser ( )

Definition at line 23 of file SerialPort_nwc_yarp_ParamsParser.cpp.

◆ ~SerialPort_nwc_yarp_ParamsParser()

SerialPort_nwc_yarp_ParamsParser::~SerialPort_nwc_yarp_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getConfiguration()

std::string SerialPort_nwc_yarp_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 56 of file SerialPort_nwc_yarp_ParamsParser.cpp.

◆ getDeviceClassName()

std::string SerialPort_nwc_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 68 of file SerialPort_nwc_yarp_ParamsParser.h.

◆ getDeviceName()

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

◆ getDocumentationOfDeviceParams()

std::string SerialPort_nwc_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 137 of file SerialPort_nwc_yarp_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > SerialPort_nwc_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_nwc_yarp_ParamsParser.cpp.

◆ getParamValue()

bool SerialPort_nwc_yarp_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 37 of file SerialPort_nwc_yarp_ParamsParser.cpp.

◆ parseParams()

bool SerialPort_nwc_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 66 of file SerialPort_nwc_yarp_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string SerialPort_nwc_yarp_ParamsParser::m_device_classname = {"SerialPort_nwc_yarp"}

Definition at line 49 of file SerialPort_nwc_yarp_ParamsParser.h.

◆ m_device_name

const std::string SerialPort_nwc_yarp_ParamsParser::m_device_name = {"serialPort_nwc_yarp"}

Definition at line 50 of file SerialPort_nwc_yarp_ParamsParser.h.

◆ m_local

std::string SerialPort_nwc_yarp_ParamsParser::m_local = {}

Definition at line 64 of file SerialPort_nwc_yarp_ParamsParser.h.

◆ m_local_defaultValue

const std::string SerialPort_nwc_yarp_ParamsParser::m_local_defaultValue = {""}

Definition at line 61 of file SerialPort_nwc_yarp_ParamsParser.h.

◆ m_parser_is_strict

bool SerialPort_nwc_yarp_ParamsParser::m_parser_is_strict = false

Definition at line 51 of file SerialPort_nwc_yarp_ParamsParser.h.

◆ m_parser_version

const parser_version_type SerialPort_nwc_yarp_ParamsParser::m_parser_version = {}

Definition at line 57 of file SerialPort_nwc_yarp_ParamsParser.h.

◆ m_provided_configuration

std::string SerialPort_nwc_yarp_ParamsParser::m_provided_configuration

Definition at line 59 of file SerialPort_nwc_yarp_ParamsParser.h.

◆ m_remote

std::string SerialPort_nwc_yarp_ParamsParser::m_remote = {}

Definition at line 65 of file SerialPort_nwc_yarp_ParamsParser.h.

◆ m_remote_defaultValue

const std::string SerialPort_nwc_yarp_ParamsParser::m_remote_defaultValue = {""}

Definition at line 62 of file SerialPort_nwc_yarp_ParamsParser.h.

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