yarp::dev::CameraConfig Class Reference

Struct describing a possible camera configuration. More...

#include <yarp/dev/IRgbVisualParams.h>

Inheritance diagram for yarp::dev::CameraConfig:

Public Member Functions
	CameraConfig ()=default
	CameraConfig (int w, int h, double rate, YarpVocabPixelTypesEnum enc)
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write this object to a network connection.
Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.
virtual Type	getReadType () const
Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.
virtual void	onCompletion () const
	This is called when the port has finished all writing operations.
virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.
virtual yarp::os::Type	getWriteType () const

Public Attributes
int	width {0}
int	height {0}
double	framerate {0.0}
YarpVocabPixelTypesEnum	pixelCoding {VOCAB_PIXEL_INVALID}

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Detailed Description

Struct describing a possible camera configuration.

Parameters

width	image width
height	image height
framerate	camera framerate
pixelCoding	camera pixel coding

Definition at line 30 of file IRgbVisualParams.h.

Constructor & Destructor Documentation

CameraConfig() [1/2]

yarp::dev::CameraConfig::CameraConfig ( )

default

CameraConfig() [2/2]

yarp::dev::CameraConfig::CameraConfig	(	int	w,
		int	h,
		double	rate,
		YarpVocabPixelTypesEnum	enc
	)

Definition at line 10 of file IRgbVisualParams.cpp.

Member Function Documentation

read()

bool yarp::dev::CameraConfig::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 35 of file IRgbVisualParams.cpp.

write()

bool yarp::dev::CameraConfig::write ( yarp::os::ConnectionWriter &  writer ) const

overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 18 of file IRgbVisualParams.cpp.

Member Data Documentation

framerate

double yarp::dev::CameraConfig::framerate {0.0}

Definition at line 38 of file IRgbVisualParams.h.

height

int yarp::dev::CameraConfig::height {0}

Definition at line 37 of file IRgbVisualParams.h.

pixelCoding

YarpVocabPixelTypesEnum yarp::dev::CameraConfig::pixelCoding {VOCAB_PIXEL_INVALID}

Definition at line 39 of file IRgbVisualParams.h.

width

int yarp::dev::CameraConfig::width {0}

Definition at line 36 of file IRgbVisualParams.h.

---

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

• src/libYARP_dev/src/yarp/dev/IRgbVisualParams.h
• src/libYARP_dev/src/yarp/dev/IRgbVisualParams.cpp