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

#include <fake/fakeDepthCamera/FakeDepthCameraDriver_ParamsParser.h>

Inheritance diagram for FakeDepthCameraDriver_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FakeDepthCameraDriver_ParamsParser ()

	~FakeDepthCameraDriver_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 = {"FakeDepthCameraDriver"}

const std::string	m_device_name = {"fakeDepthCamera"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

std::string	m_provided_configuration

const std::string	m_rgb_h_defaultValue = {"480.0"}

const std::string	m_rgb_w_defaultValue = {"640.0"}

const std::string	m_dep_h_defaultValue = {"480.0"}

const std::string	m_dep_w_defaultValue = {"640.0"}

const std::string	m_accuracy_defaultValue = {"0.001"}

const std::string	m_rgb_Vfov_defaultValue = {"50.0"}

const std::string	m_rgb_Hfov_defaultValue = {"36.0"}

const std::string	m_dep_Vfov_defaultValue = {"50.0"}

const std::string	m_dep_Hfov_defaultValue = {"36.0"}

const std::string	m_dep_near_defaultValue = {"0.2"}

const std::string	m_dep_far_defaultValue = {"6.0"}

double	m_rgb_h = {480.0}

double	m_rgb_w = {640.0}

double	m_dep_h = {480.0}

double	m_dep_w = {640.0}

double	m_accuracy = {0.001}

double	m_rgb_Vfov = {50.0}

double	m_rgb_Hfov = {36.0}

double	m_dep_Vfov = {50.0}

double	m_dep_Hfov = {36.0}

double	m_dep_near = {0.2}

double	m_dep_far = {6.0}

Detailed Description

This class is the parameters parser for class FakeDepthCameraDriver.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Description	Notes
-	rgb_h	double	-	480.0	rgb_h	-
-	rgb_w	double	-	640.0	rgb_w	-
-	dep_h	double	-	480.0	dep_h	probably it should be identical to rgb_h
-	dep_w	double	-	640.0	dep_w	probably it should be identical to rgb_w
-	accuracy	double	-	0.001	accuracy	-
-	rgb_Vfov	double	-	50.0	rgb_Vfov	-
-	rgb_Hfov	double	-	36.0	rgb_Hfov	-
-	dep_Vfov	double	-	50.0	dep_Vfov	-
-	dep_Hfov	double	-	36.0	dep_Hfov	-
-	dep_near	double	-	0.2	dep_near	-
-	dep_far	double	-	6.0	dep_far	-

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

yarpdev --device fakeDepthCamera --rgb_h 480.0 --rgb_w 640.0 --dep_h 480.0 --dep_w 640.0 --accuracy 0.001 --rgb_Vfov 50.0 --rgb_Hfov 36.0 --dep_Vfov 50.0 --dep_Hfov 36.0 --dep_near 0.2 --dep_far 6.0

yarpdev --device fakeDepthCamera

Definition at line 51 of file FakeDepthCameraDriver_ParamsParser.h.

Constructor & Destructor Documentation

◆ FakeDepthCameraDriver_ParamsParser()

FakeDepthCameraDriver_ParamsParser::FakeDepthCameraDriver_ParamsParser ( )

Definition at line 23 of file FakeDepthCameraDriver_ParamsParser.cpp.

◆ ~FakeDepthCameraDriver_ParamsParser()

FakeDepthCameraDriver_ParamsParser::~FakeDepthCameraDriver_ParamsParser ( )

overridedefault

Member Function Documentation

◆ getConfiguration()

std::string FakeDepthCameraDriver_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 110 of file FakeDepthCameraDriver_ParamsParser.cpp.

◆ getDeviceClassName()

std::string FakeDepthCameraDriver_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 95 of file FakeDepthCameraDriver_ParamsParser.h.

◆ getDeviceName()

std::string FakeDepthCameraDriver_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 96 of file FakeDepthCameraDriver_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string FakeDepthCameraDriver_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 313 of file FakeDepthCameraDriver_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > FakeDepthCameraDriver_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 FakeDepthCameraDriver_ParamsParser.cpp.

◆ getParamValue()

bool FakeDepthCameraDriver_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 46 of file FakeDepthCameraDriver_ParamsParser.cpp.

◆ parseParams()

bool FakeDepthCameraDriver_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 120 of file FakeDepthCameraDriver_ParamsParser.cpp.

Member Data Documentation

◆ m_accuracy

double FakeDepthCameraDriver_ParamsParser::m_accuracy = {0.001}

Definition at line 86 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_accuracy_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_accuracy_defaultValue = {"0.001"}

Definition at line 74 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_far

double FakeDepthCameraDriver_ParamsParser::m_dep_far = {6.0}

Definition at line 92 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_far_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_dep_far_defaultValue = {"6.0"}

Definition at line 80 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_h

double FakeDepthCameraDriver_ParamsParser::m_dep_h = {480.0}

Definition at line 84 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_h_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_dep_h_defaultValue = {"480.0"}

Definition at line 72 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_Hfov

double FakeDepthCameraDriver_ParamsParser::m_dep_Hfov = {36.0}

Definition at line 90 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_Hfov_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_dep_Hfov_defaultValue = {"36.0"}

Definition at line 78 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_near

double FakeDepthCameraDriver_ParamsParser::m_dep_near = {0.2}

Definition at line 91 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_near_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_dep_near_defaultValue = {"0.2"}

Definition at line 79 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_Vfov

double FakeDepthCameraDriver_ParamsParser::m_dep_Vfov = {50.0}

Definition at line 89 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_Vfov_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_dep_Vfov_defaultValue = {"50.0"}

Definition at line 77 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_w

double FakeDepthCameraDriver_ParamsParser::m_dep_w = {640.0}

Definition at line 85 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_dep_w_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_dep_w_defaultValue = {"640.0"}

Definition at line 73 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_device_classname

const std::string FakeDepthCameraDriver_ParamsParser::m_device_classname = {"FakeDepthCameraDriver"}

Definition at line 58 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_device_name

const std::string FakeDepthCameraDriver_ParamsParser::m_device_name = {"fakeDepthCamera"}

Definition at line 59 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_parser_is_strict

bool FakeDepthCameraDriver_ParamsParser::m_parser_is_strict = false

Definition at line 60 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_parser_version

const parser_version_type FakeDepthCameraDriver_ParamsParser::m_parser_version = {}

Definition at line 66 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_provided_configuration

std::string FakeDepthCameraDriver_ParamsParser::m_provided_configuration

Definition at line 68 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_rgb_h

double FakeDepthCameraDriver_ParamsParser::m_rgb_h = {480.0}

Definition at line 82 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_rgb_h_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_rgb_h_defaultValue = {"480.0"}

Definition at line 70 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_rgb_Hfov

double FakeDepthCameraDriver_ParamsParser::m_rgb_Hfov = {36.0}

Definition at line 88 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_rgb_Hfov_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_rgb_Hfov_defaultValue = {"36.0"}

Definition at line 76 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_rgb_Vfov

double FakeDepthCameraDriver_ParamsParser::m_rgb_Vfov = {50.0}

Definition at line 87 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_rgb_Vfov_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_rgb_Vfov_defaultValue = {"50.0"}

Definition at line 75 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_rgb_w

double FakeDepthCameraDriver_ParamsParser::m_rgb_w = {640.0}

Definition at line 83 of file FakeDepthCameraDriver_ParamsParser.h.

◆ m_rgb_w_defaultValue

const std::string FakeDepthCameraDriver_ParamsParser::m_rgb_w_defaultValue = {"640.0"}

Definition at line 71 of file FakeDepthCameraDriver_ParamsParser.h.

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

src/devices/fake/fakeDepthCamera/FakeDepthCameraDriver_ParamsParser.h
src/devices/fake/fakeDepthCamera/FakeDepthCameraDriver_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FakeDepthCameraDriver_ParamsParser()

◆ ~FakeDepthCameraDriver_ParamsParser()

Member Function Documentation

◆ getConfiguration()

◆ getDeviceClassName()

◆ getDeviceName()

◆ getDocumentationOfDeviceParams()

◆ getListOfParams()

◆ getParamValue()

◆ parseParams()

Member Data Documentation

◆ m_accuracy

◆ m_accuracy_defaultValue

◆ m_dep_far

◆ m_dep_far_defaultValue

◆ m_dep_h

◆ m_dep_h_defaultValue

◆ m_dep_Hfov

◆ m_dep_Hfov_defaultValue

◆ m_dep_near

◆ m_dep_near_defaultValue

◆ m_dep_Vfov

◆ m_dep_Vfov_defaultValue

◆ m_dep_w

◆ m_dep_w_defaultValue

◆ m_device_classname

◆ m_device_name

◆ m_parser_is_strict

◆ m_parser_version

◆ m_provided_configuration

◆ m_rgb_h

◆ m_rgb_h_defaultValue

◆ m_rgb_Hfov

◆ m_rgb_Hfov_defaultValue

◆ m_rgb_Vfov

◆ m_rgb_Vfov_defaultValue

◆ m_rgb_w

◆ m_rgb_w_defaultValue