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

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

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-ros2/src/devices/map2D_nws_ros2/Map2D_nws_ros2_ParamsParser.h>

+ Inheritance diagram for Map2D_nws_ros2_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 Map2D_nws_ros2_ParamsParser ()
 
 ~Map2D_nws_ros2_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 = {"Map2D_nws_ros2"}
 
const std::string m_device_name = {"map2D_nws_ros2"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_name_defaultValue = {"map2D_nws_ros2"}
 
const std::string m_getmap_defaultValue = {"getMap"}
 
const std::string m_getmapbyname_defaultValue = {"getMapByName"}
 
const std::string m_roscmdparser_defaultValue = {"rosCmdParser"}
 
const std::string m_markers_pub_defaultValue = {"locationServerMarkers"}
 
const std::string m_node_name_defaultValue = {"map2D_nws_ros2"}
 
std::string m_name = {"map2D_nws_ros2"}
 
std::string m_getmap = {"getMap"}
 
std::string m_getmapbyname = {"getMapByName"}
 
std::string m_roscmdparser = {"rosCmdParser"}
 
std::string m_markers_pub = {"locationServerMarkers"}
 
std::string m_node_name = {"map2D_nws_ros2"}
 

Detailed Description

This class is the parameters parser for class Map2D_nws_ros2.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- name string - map2D_nws_ros2 0 Device name prefix -
- getmap string - getMap 0 The "GetMap" ROS service name For the moment being the service always responds with an empty map
- getmapbyname string - getMapByName 0 The "GetMapByName" ROS2 custom service name The map returned by this service is also available via publisher named "getmapbyname value"/pub
- roscmdparser string - rosCmdParser 0 The "BasicTypes" ROS service name This is used to send commands to the nws via ros2 BasicTypes service
- markers_pub string - locationServerMarkers 0 The visual markers array publisher name -
- node_name string - map2D_nws_ros2 0 The ROS2 node name. If absent, the device name will be used -

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

yarpdev --device map2D_nws_ros2 --name map2D_nws_ros2 --getmap getMap --getmapbyname getMapByName --roscmdparser rosCmdParser --markers_pub locationServerMarkers --node_name map2D_nws_ros2
yarpdev --device map2D_nws_ros2

Definition at line 46 of file Map2D_nws_ros2_ParamsParser.h.

Constructor & Destructor Documentation

◆ Map2D_nws_ros2_ParamsParser()

Map2D_nws_ros2_ParamsParser::Map2D_nws_ros2_ParamsParser ( )

Definition at line 23 of file Map2D_nws_ros2_ParamsParser.cpp.

◆ ~Map2D_nws_ros2_ParamsParser()

Map2D_nws_ros2_ParamsParser::~Map2D_nws_ros2_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string Map2D_nws_ros2_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 78 of file Map2D_nws_ros2_ParamsParser.h.

◆ getDeviceName()

std::string Map2D_nws_ros2_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 79 of file Map2D_nws_ros2_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string Map2D_nws_ros2_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 164 of file Map2D_nws_ros2_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > Map2D_nws_ros2_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 Map2D_nws_ros2_ParamsParser.cpp.

◆ parseParams()

bool Map2D_nws_ros2_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 41 of file Map2D_nws_ros2_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string Map2D_nws_ros2_ParamsParser::m_device_classname = {"Map2D_nws_ros2"}

Definition at line 53 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_device_name

const std::string Map2D_nws_ros2_ParamsParser::m_device_name = {"map2D_nws_ros2"}

Definition at line 54 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_getmap

std::string Map2D_nws_ros2_ParamsParser::m_getmap = {"getMap"}

Definition at line 71 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_getmap_defaultValue

const std::string Map2D_nws_ros2_ParamsParser::m_getmap_defaultValue = {"getMap"}

Definition at line 64 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_getmapbyname

std::string Map2D_nws_ros2_ParamsParser::m_getmapbyname = {"getMapByName"}

Definition at line 72 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_getmapbyname_defaultValue

const std::string Map2D_nws_ros2_ParamsParser::m_getmapbyname_defaultValue = {"getMapByName"}

Definition at line 65 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_markers_pub

std::string Map2D_nws_ros2_ParamsParser::m_markers_pub = {"locationServerMarkers"}

Definition at line 74 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_markers_pub_defaultValue

const std::string Map2D_nws_ros2_ParamsParser::m_markers_pub_defaultValue = {"locationServerMarkers"}

Definition at line 67 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_name

std::string Map2D_nws_ros2_ParamsParser::m_name = {"map2D_nws_ros2"}

Definition at line 70 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_name_defaultValue

const std::string Map2D_nws_ros2_ParamsParser::m_name_defaultValue = {"map2D_nws_ros2"}

Definition at line 63 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_node_name

std::string Map2D_nws_ros2_ParamsParser::m_node_name = {"map2D_nws_ros2"}

Definition at line 75 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_node_name_defaultValue

const std::string Map2D_nws_ros2_ParamsParser::m_node_name_defaultValue = {"map2D_nws_ros2"}

Definition at line 68 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_parser_is_strict

bool Map2D_nws_ros2_ParamsParser::m_parser_is_strict = false

Definition at line 55 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_parser_version

const parser_version_type Map2D_nws_ros2_ParamsParser::m_parser_version = {}

Definition at line 61 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_roscmdparser

std::string Map2D_nws_ros2_ParamsParser::m_roscmdparser = {"rosCmdParser"}

Definition at line 73 of file Map2D_nws_ros2_ParamsParser.h.

◆ m_roscmdparser_defaultValue

const std::string Map2D_nws_ros2_ParamsParser::m_roscmdparser_defaultValue = {"rosCmdParser"}

Definition at line 66 of file Map2D_nws_ros2_ParamsParser.h.

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