Rangefinder2DTransformer_ParamsParser Class Reference

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

#include <Rangefinder2DTransformer/Rangefinder2DTransformer_ParamsParser.h>

Inheritance diagram for Rangefinder2DTransformer_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	Rangefinder2DTransformer_ParamsParser ()
	~Rangefinder2DTransformer_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 = {"Rangefinder2DTransformer"}
const std::string	m_device_name = {"rangefinder2DTransformer"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
std::string	m_provided_configuration
const std::string	m_device_position_x_defaultValue = {"0"}
const std::string	m_device_position_y_defaultValue = {"0"}
const std::string	m_device_position_theta_defaultValue = {"0"}
const std::string	m_laser_frame_name_defaultValue = {""}
const std::string	m_robot_frame_name_defaultValue = {""}
double	m_device_position_x = {0}
double	m_device_position_y = {0}
double	m_device_position_theta = {0}
std::string	m_laser_frame_name = {}
std::string	m_robot_frame_name = {}

Detailed Description

This class is the parameters parser for class Rangefinder2DTransformer.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	device_position_x	double	m	0	0	X coordinate of the virtual lidar	-
-	device_position_y	double	m	0	0	Y coordinate of the virtual lidar	-
-	device_position_theta	double	deg	0	0	Theta coordinate of the virtual lidar	-
-	laser_frame_name	string	-	-	0	If present, open a frameTranformClient to get the robot->laser transform	If present, disables device_position_* parameters
-	robot_frame_name	string	-	-	0	If present, open a frameTranformClient to get the robot->laser transform	If present, disables device_position_* parameters

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

yarpdev --device rangefinder2DTransformer --device_position_x 0 --device_position_y 0 --device_position_theta 0 --laser_frame_name <optional_value> --robot_frame_name <optional_value>

yarpdev --device rangefinder2DTransformer

Definition at line 45 of file Rangefinder2DTransformer_ParamsParser.h.

Constructor & Destructor Documentation

Rangefinder2DTransformer_ParamsParser()

Rangefinder2DTransformer_ParamsParser::Rangefinder2DTransformer_ParamsParser

(

)

Definition at line 23 of file Rangefinder2DTransformer_ParamsParser.cpp.

~Rangefinder2DTransformer_ParamsParser()

Rangefinder2DTransformer_ParamsParser::~Rangefinder2DTransformer_ParamsParser ( )

overridedefault

Member Function Documentation

getConfiguration()

std::string Rangefinder2DTransformer_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 74 of file Rangefinder2DTransformer_ParamsParser.cpp.

getDeviceClassName()

std::string Rangefinder2DTransformer_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 77 of file Rangefinder2DTransformer_ParamsParser.h.

getDeviceName()

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

getDocumentationOfDeviceParams()

std::string Rangefinder2DTransformer_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 193 of file Rangefinder2DTransformer_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > Rangefinder2DTransformer_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 Rangefinder2DTransformer_ParamsParser.cpp.

getParamValue()

bool Rangefinder2DTransformer_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 40 of file Rangefinder2DTransformer_ParamsParser.cpp.

parseParams()

bool Rangefinder2DTransformer_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 84 of file Rangefinder2DTransformer_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string Rangefinder2DTransformer_ParamsParser::m_device_classname = {"Rangefinder2DTransformer"}

Definition at line 52 of file Rangefinder2DTransformer_ParamsParser.h.

m_device_name

const std::string Rangefinder2DTransformer_ParamsParser::m_device_name = {"rangefinder2DTransformer"}

Definition at line 53 of file Rangefinder2DTransformer_ParamsParser.h.

m_device_position_theta

double Rangefinder2DTransformer_ParamsParser::m_device_position_theta = {0}

Definition at line 72 of file Rangefinder2DTransformer_ParamsParser.h.

m_device_position_theta_defaultValue

const std::string Rangefinder2DTransformer_ParamsParser::m_device_position_theta_defaultValue = {"0"}

Definition at line 66 of file Rangefinder2DTransformer_ParamsParser.h.

m_device_position_x

double Rangefinder2DTransformer_ParamsParser::m_device_position_x = {0}

Definition at line 70 of file Rangefinder2DTransformer_ParamsParser.h.

m_device_position_x_defaultValue

const std::string Rangefinder2DTransformer_ParamsParser::m_device_position_x_defaultValue = {"0"}

Definition at line 64 of file Rangefinder2DTransformer_ParamsParser.h.

m_device_position_y

double Rangefinder2DTransformer_ParamsParser::m_device_position_y = {0}

Definition at line 71 of file Rangefinder2DTransformer_ParamsParser.h.

m_device_position_y_defaultValue

const std::string Rangefinder2DTransformer_ParamsParser::m_device_position_y_defaultValue = {"0"}

Definition at line 65 of file Rangefinder2DTransformer_ParamsParser.h.

m_laser_frame_name

std::string Rangefinder2DTransformer_ParamsParser::m_laser_frame_name = {}

Definition at line 73 of file Rangefinder2DTransformer_ParamsParser.h.

m_laser_frame_name_defaultValue

const std::string Rangefinder2DTransformer_ParamsParser::m_laser_frame_name_defaultValue = {""}

Definition at line 67 of file Rangefinder2DTransformer_ParamsParser.h.

m_parser_is_strict

bool Rangefinder2DTransformer_ParamsParser::m_parser_is_strict = false

Definition at line 54 of file Rangefinder2DTransformer_ParamsParser.h.

m_parser_version

const parser_version_type Rangefinder2DTransformer_ParamsParser::m_parser_version = {}

Definition at line 60 of file Rangefinder2DTransformer_ParamsParser.h.

m_provided_configuration

std::string Rangefinder2DTransformer_ParamsParser::m_provided_configuration

Definition at line 62 of file Rangefinder2DTransformer_ParamsParser.h.

m_robot_frame_name

std::string Rangefinder2DTransformer_ParamsParser::m_robot_frame_name = {}

Definition at line 74 of file Rangefinder2DTransformer_ParamsParser.h.

m_robot_frame_name_defaultValue

const std::string Rangefinder2DTransformer_ParamsParser::m_robot_frame_name_defaultValue = {""}

Definition at line 68 of file Rangefinder2DTransformer_ParamsParser.h.

---

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

• src/devices/Rangefinder2DTransformer/Rangefinder2DTransformer_ParamsParser.h
• src/devices/Rangefinder2DTransformer/Rangefinder2DTransformer_ParamsParser.cpp