FakeFrameWriter: An image frame writer for testing purposes More...

#include <fake/fakeFrameWriter/FakeFrameWriter.h>

Inheritance diagram for FakeFrameWriter:

Public Member Functions
	FakeFrameWriter ()

virtual	~FakeFrameWriter ()

bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

bool	putImage (yarp::sig::ImageOf< yarp::sig::PixelRgb > &image) override
	Write an image to the device.

Public Member Functions inherited from yarp::dev::IFrameWriterImage
virtual	~IFrameWriterImage ()
	Destructor.

Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()

	DeviceDriver (const DeviceDriver &other)=delete

	DeviceDriver (DeviceDriver &&other) noexcept=delete

DeviceDriver &	operator= (const DeviceDriver &other)=delete

DeviceDriver &	operator= (DeviceDriver &&other) noexcept=delete

virtual	~DeviceDriver ()

virtual std::string	id () const
	Return the id assigned to the PolyDriver.

virtual void	setId (const std::string &id)
	Set the id for this device.

template<class T >
bool	view (T *&x)
	Get an interface to the device driver.

virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.

Public Member Functions inherited from FakeFrameWriter_ParamsParser
	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 ()

Protected Attributes
bool	m_isInitialized =false

Additional Inherited Members
Public Attributes inherited from FakeFrameWriter_ParamsParser
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

FakeFrameWriter: An image frame writer for testing purposes

Parameters required by this device are shown in class: FakeFrameWriter_ParamsParser

Definition at line 23 of file FakeFrameWriter.h.

Constructor & Destructor Documentation

◆ FakeFrameWriter()

FakeFrameWriter::FakeFrameWriter ( )

inline

Definition at line 30 of file FakeFrameWriter.h.

◆ ~FakeFrameWriter()

virtual FakeFrameWriter::~FakeFrameWriter ( )

inlinevirtual

Definition at line 31 of file FakeFrameWriter.h.

Member Function Documentation

◆ close()

bool FakeFrameWriter::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 56 of file FakeFrameWriter.cpp.

◆ open()

bool FakeFrameWriter::open ( yarp::os::Searchable & config )

overridevirtual

Open the DeviceDriver.

Parameters

config is a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).

Returns: true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 36 of file FakeFrameWriter.cpp.

◆ putImage()

bool FakeFrameWriter::putImage ( yarp::sig::ImageOf< yarp::sig::PixelRgb > & image )

overridevirtual

Write an image to the device.

Parameters

image the image to write

Returns: true/false upon success/failure

Implements yarp::dev::IFrameWriterImage.

Definition at line 65 of file FakeFrameWriter.cpp.

Member Data Documentation

◆ m_isInitialized

bool FakeFrameWriter::m_isInitialized =false

protected

Definition at line 39 of file FakeFrameWriter.h.

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

src/devices/fake/fakeFrameWriter/FakeFrameWriter.h
src/devices/fake/fakeFrameWriter/FakeFrameWriter.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FakeFrameWriter()

◆ ~FakeFrameWriter()

Member Function Documentation

◆ close()

◆ open()

◆ putImage()

Member Data Documentation

◆ m_isInitialized