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

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

#include <map2DStorage/Map2DStorage_ParamsParser.h>

+ Inheritance diagram for Map2DStorage_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 Map2DStorage_ParamsParser ()
 
 ~Map2DStorage_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 = {"Map2DStorage"}
 
const std::string m_device_name = {"map2DStorage"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_name_defaultValue = {"/map2DStorage/rpc"}
 
const std::string m_mapCollectionContext_defaultValue = {""}
 
const std::string m_mapCollectionFile_defaultValue = {"maps_collection.ini"}
 
const std::string m_mapLocationsFile_defaultValue = {"locations.ini"}
 
std::string m_name = {"/map2DStorage/rpc"}
 
std::string m_mapCollectionContext = {}
 
std::string m_mapCollectionFile = {"maps_collection.ini"}
 
std::string m_mapLocationsFile = {"locations.ini"}
 

Detailed Description

This class is the parameters parser for class Map2DStorage.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- name string - /map2DStorage/rpc 0 Full name of the rpc port opened by the device -
- mapCollectionContext string - - 0 The context where to find the maps and the locations files. If left empty, no file will be loaded. -
- mapCollectionFile string - maps_collection.ini 0 The name of .ini file containing a map collection. -
- mapLocationsFile string - locations.ini 0 The name of .ini file containing a list of locations. -

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

yarpdev --device map2DStorage --name /map2DStorage/rpc --mapCollectionContext <optional_value> --mapCollectionFile maps_collection.ini --mapLocationsFile locations.ini
yarpdev --device map2DStorage

Definition at line 44 of file Map2DStorage_ParamsParser.h.

Constructor & Destructor Documentation

◆ Map2DStorage_ParamsParser()

Map2DStorage_ParamsParser::Map2DStorage_ParamsParser ( )

Definition at line 23 of file Map2DStorage_ParamsParser.cpp.

◆ ~Map2DStorage_ParamsParser()

Map2DStorage_ParamsParser::~Map2DStorage_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getConfiguration()

std::string Map2DStorage_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 68 of file Map2DStorage_ParamsParser.cpp.

◆ getDeviceClassName()

std::string Map2DStorage_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 74 of file Map2DStorage_ParamsParser.h.

◆ getDeviceName()

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

◆ getDocumentationOfDeviceParams()

std::string Map2DStorage_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 173 of file Map2DStorage_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > Map2DStorage_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 Map2DStorage_ParamsParser.cpp.

◆ getParamValue()

bool Map2DStorage_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 39 of file Map2DStorage_ParamsParser.cpp.

◆ parseParams()

bool Map2DStorage_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 78 of file Map2DStorage_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string Map2DStorage_ParamsParser::m_device_classname = {"Map2DStorage"}

Definition at line 51 of file Map2DStorage_ParamsParser.h.

◆ m_device_name

const std::string Map2DStorage_ParamsParser::m_device_name = {"map2DStorage"}

Definition at line 52 of file Map2DStorage_ParamsParser.h.

◆ m_mapCollectionContext

std::string Map2DStorage_ParamsParser::m_mapCollectionContext = {}

Definition at line 69 of file Map2DStorage_ParamsParser.h.

◆ m_mapCollectionContext_defaultValue

const std::string Map2DStorage_ParamsParser::m_mapCollectionContext_defaultValue = {""}

Definition at line 64 of file Map2DStorage_ParamsParser.h.

◆ m_mapCollectionFile

std::string Map2DStorage_ParamsParser::m_mapCollectionFile = {"maps_collection.ini"}

Definition at line 70 of file Map2DStorage_ParamsParser.h.

◆ m_mapCollectionFile_defaultValue

const std::string Map2DStorage_ParamsParser::m_mapCollectionFile_defaultValue = {"maps_collection.ini"}

Definition at line 65 of file Map2DStorage_ParamsParser.h.

◆ m_mapLocationsFile

std::string Map2DStorage_ParamsParser::m_mapLocationsFile = {"locations.ini"}

Definition at line 71 of file Map2DStorage_ParamsParser.h.

◆ m_mapLocationsFile_defaultValue

const std::string Map2DStorage_ParamsParser::m_mapLocationsFile_defaultValue = {"locations.ini"}

Definition at line 66 of file Map2DStorage_ParamsParser.h.

◆ m_name

std::string Map2DStorage_ParamsParser::m_name = {"/map2DStorage/rpc"}

Definition at line 68 of file Map2DStorage_ParamsParser.h.

◆ m_name_defaultValue

const std::string Map2DStorage_ParamsParser::m_name_defaultValue = {"/map2DStorage/rpc"}

Definition at line 63 of file Map2DStorage_ParamsParser.h.

◆ m_parser_is_strict

bool Map2DStorage_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file Map2DStorage_ParamsParser.h.

◆ m_parser_version

const parser_version_type Map2DStorage_ParamsParser::m_parser_version = {}

Definition at line 59 of file Map2DStorage_ParamsParser.h.

◆ m_provided_configuration

std::string Map2DStorage_ParamsParser::m_provided_configuration

Definition at line 61 of file Map2DStorage_ParamsParser.h.

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