FakeFrameWriter_ParamsParser Class Reference

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

#include <fake/fakeFrameWriter/FakeFrameWriter_ParamsParser.h>

Inheritance diagram for FakeFrameWriter_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FakeFrameWriter_ParamsParser ()
	~FakeFrameWriter_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 = {"FakeFrameWriter"}
const std::string	m_device_name = {"fakeFrameWriter"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
std::string	m_provided_configuration
const std::string	m_filename_defaultValue = {"output.avi"}
const std::string	m_framerate_defaultValue = {"30"}
const std::string	m_width_defaultValue = {"0"}
const std::string	m_height_defaultValue = {"0"}
std::string	m_filename = {"output.avi"}
double	m_framerate = {30}
int	m_width = {0}
int	m_height = {0}

Detailed Description

This class is the parameters parser for class FakeFrameWriter.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	filename	string	-	output.avi	0	output file name	-
-	framerate	double	-	30	0	framerate for the output file	-
-	width	int	-	0	0	frame width	if 0, it will automatically detected from the first received frame
-	height	int	-	0	0	frame height	if 0, it will automatically detected from the first received frame

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

yarpdev --device fakeFrameWriter --filename output.avi --framerate 30 --width 0 --height 0

yarpdev --device fakeFrameWriter

Definition at line 44 of file FakeFrameWriter_ParamsParser.h.

Constructor & Destructor Documentation

FakeFrameWriter_ParamsParser()

FakeFrameWriter_ParamsParser::FakeFrameWriter_ParamsParser

(

)

Definition at line 23 of file FakeFrameWriter_ParamsParser.cpp.

~FakeFrameWriter_ParamsParser()

FakeFrameWriter_ParamsParser::~FakeFrameWriter_ParamsParser ( )

overridedefault

Member Function Documentation

getConfiguration()

std::string FakeFrameWriter_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 FakeFrameWriter_ParamsParser.cpp.

getDeviceClassName()

std::string FakeFrameWriter_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 FakeFrameWriter_ParamsParser.h.

getDeviceName()

std::string FakeFrameWriter_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 FakeFrameWriter_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string FakeFrameWriter_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 FakeFrameWriter_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > FakeFrameWriter_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 FakeFrameWriter_ParamsParser.cpp.

getParamValue()

bool FakeFrameWriter_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 FakeFrameWriter_ParamsParser.cpp.

parseParams()

bool FakeFrameWriter_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 FakeFrameWriter_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string FakeFrameWriter_ParamsParser::m_device_classname = {"FakeFrameWriter"}

Definition at line 51 of file FakeFrameWriter_ParamsParser.h.

m_device_name

const std::string FakeFrameWriter_ParamsParser::m_device_name = {"fakeFrameWriter"}

Definition at line 52 of file FakeFrameWriter_ParamsParser.h.

m_filename

std::string FakeFrameWriter_ParamsParser::m_filename = {"output.avi"}

Definition at line 68 of file FakeFrameWriter_ParamsParser.h.

m_filename_defaultValue

const std::string FakeFrameWriter_ParamsParser::m_filename_defaultValue = {"output.avi"}

Definition at line 63 of file FakeFrameWriter_ParamsParser.h.

m_framerate

double FakeFrameWriter_ParamsParser::m_framerate = {30}

Definition at line 69 of file FakeFrameWriter_ParamsParser.h.

m_framerate_defaultValue

const std::string FakeFrameWriter_ParamsParser::m_framerate_defaultValue = {"30"}

Definition at line 64 of file FakeFrameWriter_ParamsParser.h.

m_height

int FakeFrameWriter_ParamsParser::m_height = {0}

Definition at line 71 of file FakeFrameWriter_ParamsParser.h.

m_height_defaultValue

const std::string FakeFrameWriter_ParamsParser::m_height_defaultValue = {"0"}

Definition at line 66 of file FakeFrameWriter_ParamsParser.h.

m_parser_is_strict

bool FakeFrameWriter_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file FakeFrameWriter_ParamsParser.h.

m_parser_version

const parser_version_type FakeFrameWriter_ParamsParser::m_parser_version = {}

Definition at line 59 of file FakeFrameWriter_ParamsParser.h.

m_provided_configuration

std::string FakeFrameWriter_ParamsParser::m_provided_configuration

Definition at line 61 of file FakeFrameWriter_ParamsParser.h.

m_width

int FakeFrameWriter_ParamsParser::m_width = {0}

Definition at line 70 of file FakeFrameWriter_ParamsParser.h.

m_width_defaultValue

const std::string FakeFrameWriter_ParamsParser::m_width_defaultValue = {"0"}

Definition at line 65 of file FakeFrameWriter_ParamsParser.h.

---

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

• src/devices/fake/fakeFrameWriter/FakeFrameWriter_ParamsParser.h
• src/devices/fake/fakeFrameWriter/FakeFrameWriter_ParamsParser.cpp