FrameGrabberCropper_ParamsParser Class Reference

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

#include <frameGrabberCropper/FrameGrabberCropper_ParamsParser.h>

Inheritance diagram for FrameGrabberCropper_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FrameGrabberCropper_ParamsParser ()
	~FrameGrabberCropper_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 = {"FrameGrabberCropper"}
const std::string	m_device_name = {"frameGrabberCropper"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_x1_defaultValue = {"0"}
const std::string	m_y1_defaultValue = {"0"}
const std::string	m_x2_defaultValue = {"100"}
const std::string	m_y2_defaultValue = {"100"}
const std::string	m_forwardRgbVisualParams_defaultValue = {"false"}
int	m_x1 = {0}
int	m_y1 = {0}
int	m_x2 = {100}
int	m_y2 = {100}
bool	m_forwardRgbVisualParams = {false}

Detailed Description

This class is the parameters parser for class FrameGrabberCropper.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	x1	int	-	0	1	x1	-
-	y1	int	-	0	1	y1	-
-	x2	int	-	100	1	x2	-
-	y2	int	-	100	1	y2	-
-	forwardRgbVisualParams	bool	-	false	0	Forward the the IRgbVisualParams calls to the attached device	-

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

yarpdev --device frameGrabberCropper --x1 0 --y1 0 --x2 100 --y2 100 --forwardRgbVisualParams false

yarpdev --device frameGrabberCropper --x1 0 --y1 0 --x2 100 --y2 100

Definition at line 45 of file FrameGrabberCropper_ParamsParser.h.

Constructor & Destructor Documentation

FrameGrabberCropper_ParamsParser()

FrameGrabberCropper_ParamsParser::FrameGrabberCropper_ParamsParser

(

)

Definition at line 23 of file FrameGrabberCropper_ParamsParser.cpp.

~FrameGrabberCropper_ParamsParser()

FrameGrabberCropper_ParamsParser::~FrameGrabberCropper_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string FrameGrabberCropper_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 FrameGrabberCropper_ParamsParser.h.

getDeviceName()

std::string FrameGrabberCropper_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 FrameGrabberCropper_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string FrameGrabberCropper_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 157 of file FrameGrabberCropper_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > FrameGrabberCropper_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 FrameGrabberCropper_ParamsParser.cpp.

parseParams()

bool FrameGrabberCropper_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 FrameGrabberCropper_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string FrameGrabberCropper_ParamsParser::m_device_classname = {"FrameGrabberCropper"}

Definition at line 52 of file FrameGrabberCropper_ParamsParser.h.

m_device_name

const std::string FrameGrabberCropper_ParamsParser::m_device_name = {"frameGrabberCropper"}

Definition at line 53 of file FrameGrabberCropper_ParamsParser.h.

m_forwardRgbVisualParams

bool FrameGrabberCropper_ParamsParser::m_forwardRgbVisualParams = {false}

Definition at line 72 of file FrameGrabberCropper_ParamsParser.h.

m_forwardRgbVisualParams_defaultValue

const std::string FrameGrabberCropper_ParamsParser::m_forwardRgbVisualParams_defaultValue = {"false"}

Definition at line 66 of file FrameGrabberCropper_ParamsParser.h.

m_parser_is_strict

bool FrameGrabberCropper_ParamsParser::m_parser_is_strict = false

Definition at line 54 of file FrameGrabberCropper_ParamsParser.h.

m_parser_version

const parser_version_type FrameGrabberCropper_ParamsParser::m_parser_version = {}

Definition at line 60 of file FrameGrabberCropper_ParamsParser.h.

m_x1

int FrameGrabberCropper_ParamsParser::m_x1 = {0}

Definition at line 68 of file FrameGrabberCropper_ParamsParser.h.

m_x1_defaultValue

const std::string FrameGrabberCropper_ParamsParser::m_x1_defaultValue = {"0"}

Definition at line 62 of file FrameGrabberCropper_ParamsParser.h.

m_x2

int FrameGrabberCropper_ParamsParser::m_x2 = {100}

Definition at line 70 of file FrameGrabberCropper_ParamsParser.h.

m_x2_defaultValue

const std::string FrameGrabberCropper_ParamsParser::m_x2_defaultValue = {"100"}

Definition at line 64 of file FrameGrabberCropper_ParamsParser.h.

m_y1

int FrameGrabberCropper_ParamsParser::m_y1 = {0}

Definition at line 69 of file FrameGrabberCropper_ParamsParser.h.

m_y1_defaultValue

const std::string FrameGrabberCropper_ParamsParser::m_y1_defaultValue = {"0"}

Definition at line 63 of file FrameGrabberCropper_ParamsParser.h.

m_y2

int FrameGrabberCropper_ParamsParser::m_y2 = {100}

Definition at line 71 of file FrameGrabberCropper_ParamsParser.h.

m_y2_defaultValue

const std::string FrameGrabberCropper_ParamsParser::m_y2_defaultValue = {"100"}

Definition at line 65 of file FrameGrabberCropper_ParamsParser.h.

---

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

• src/devices/frameGrabberCropper/FrameGrabberCropper_ParamsParser.h
• src/devices/frameGrabberCropper/FrameGrabberCropper_ParamsParser.cpp