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

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

#include <networkWrappers/localization2D_nws_yarp/Localization2D_nws_yarp_ParamsParser.h>

+ Inheritance diagram for Localization2D_nws_yarp_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 Localization2D_nws_yarp_ParamsParser ()
 
 ~Localization2D_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 = {"Localization2D_nws_yarp"}
 
const std::string m_device_name = {"localization2D_nws_yarp"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_GENERAL_period_defaultValue = {"0.01"}
 
const std::string m_GENERAL_retrieve_position_periodically_defaultValue = {"true"}
 
const std::string m_GENERAL_name_defaultValue = {"/localization2D_nws_yarp"}
 
const std::string m_GENERAL_publish_odometry_defaultValue = {"true"}
 
const std::string m_GENERAL_publish_location_defaultValue = {"true"}
 
double m_GENERAL_period = {0.01}
 
bool m_GENERAL_retrieve_position_periodically = {true}
 
std::string m_GENERAL_name = {"/localization2D_nws_yarp"}
 
bool m_GENERAL_publish_odometry = {true}
 
bool m_GENERAL_publish_location = {true}
 

Detailed Description

This class is the parameters parser for class Localization2D_nws_yarp.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
GENERAL period double s 0.01 0 The period of the working thread -
GENERAL retrieve_position_periodically bool - true 0 If true, the subdevice is asked periodically to retrieve the current location. Otherwise the current location is obtained asynchronously when a getCurrentPosition() command is issued. -
GENERAL name string - /localization2D_nws_yarp 0 The name of the server, used as a prefix for the opened ports By default ports opened are /xxx/rpc and /xxx/streaming:o
GENERAL publish_odometry bool - true 0 Periodically publish odometry data over the network -
GENERAL publish_location bool - true 0 PEriodically publish location data over the network -

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

yarpdev --device localization2D_nws_yarp --GENERAL::period 0.01 --GENERAL::retrieve_position_periodically true --GENERAL::name /localization2D_nws_yarp --GENERAL::publish_odometry true --GENERAL::publish_location true
yarpdev --device localization2D_nws_yarp

Definition at line 45 of file Localization2D_nws_yarp_ParamsParser.h.

Constructor & Destructor Documentation

◆ Localization2D_nws_yarp_ParamsParser()

Localization2D_nws_yarp_ParamsParser::Localization2D_nws_yarp_ParamsParser ( )

Definition at line 23 of file Localization2D_nws_yarp_ParamsParser.cpp.

◆ ~Localization2D_nws_yarp_ParamsParser()

Localization2D_nws_yarp_ParamsParser::~Localization2D_nws_yarp_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

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

◆ getDeviceName()

std::string Localization2D_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 76 of file Localization2D_nws_yarp_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string Localization2D_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 159 of file Localization2D_nws_yarp_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > Localization2D_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 Localization2D_nws_yarp_ParamsParser.cpp.

◆ parseParams()

bool Localization2D_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 40 of file Localization2D_nws_yarp_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string Localization2D_nws_yarp_ParamsParser::m_device_classname = {"Localization2D_nws_yarp"}

Definition at line 52 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_device_name

const std::string Localization2D_nws_yarp_ParamsParser::m_device_name = {"localization2D_nws_yarp"}

Definition at line 53 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_name

std::string Localization2D_nws_yarp_ParamsParser::m_GENERAL_name = {"/localization2D_nws_yarp"}

Definition at line 70 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_name_defaultValue

const std::string Localization2D_nws_yarp_ParamsParser::m_GENERAL_name_defaultValue = {"/localization2D_nws_yarp"}

Definition at line 64 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_period

double Localization2D_nws_yarp_ParamsParser::m_GENERAL_period = {0.01}

Definition at line 68 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_period_defaultValue

const std::string Localization2D_nws_yarp_ParamsParser::m_GENERAL_period_defaultValue = {"0.01"}

Definition at line 62 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_publish_location

bool Localization2D_nws_yarp_ParamsParser::m_GENERAL_publish_location = {true}

Definition at line 72 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_publish_location_defaultValue

const std::string Localization2D_nws_yarp_ParamsParser::m_GENERAL_publish_location_defaultValue = {"true"}

Definition at line 66 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_publish_odometry

bool Localization2D_nws_yarp_ParamsParser::m_GENERAL_publish_odometry = {true}

Definition at line 71 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_publish_odometry_defaultValue

const std::string Localization2D_nws_yarp_ParamsParser::m_GENERAL_publish_odometry_defaultValue = {"true"}

Definition at line 65 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_retrieve_position_periodically

bool Localization2D_nws_yarp_ParamsParser::m_GENERAL_retrieve_position_periodically = {true}

Definition at line 69 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_GENERAL_retrieve_position_periodically_defaultValue

const std::string Localization2D_nws_yarp_ParamsParser::m_GENERAL_retrieve_position_periodically_defaultValue = {"true"}

Definition at line 63 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_parser_is_strict

bool Localization2D_nws_yarp_ParamsParser::m_parser_is_strict = false

Definition at line 54 of file Localization2D_nws_yarp_ParamsParser.h.

◆ m_parser_version

const parser_version_type Localization2D_nws_yarp_ParamsParser::m_parser_version = {}

Definition at line 60 of file Localization2D_nws_yarp_ParamsParser.h.

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