ZfpMonitorObject: Portmonitor plugin for compression and decompression of floating point values using zfp library. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/portmonitors/depthimage_compression_zfp/zfpPortmonitor.h>

Inheritance diagram for ZfpMonitorObject:

Public Member Functions
bool	create (const yarp::os::Property &options) override
	This will be called when the dll is properly loaded by the portmonitor carrier. More...

void	destroy () override
	This will be called when the portmonitor object destroyes. More...

bool	setparam (const yarp::os::Property &params) override
	This will be called when the portmonitor carrier parameters are set via YARP admin port. More...

bool	getparam (yarp::os::Property &params) override
	This will be called when the portmonitor carrier parameters are requested via YARP admin port. More...

bool	accept (yarp::os::Things &thing) override
	This will be called when the data reach the portmonitor object. More...

yarp::os::Things &	update (yarp::os::Things &thing) override
	After data get accpeted in the accept() callback, an instance of that is given to the update function where the data can be accessed and modified. More...

Public Member Functions inherited from yarp::os::MonitorObject
virtual	~MonitorObject ()

virtual bool	create (const yarp::os::Property &options)
	This will be called when the dll is properly loaded by the portmonitor carrier. More...

virtual void	destroy ()
	This will be called when the portmonitor object destroyes. More...

virtual bool	setparam (const yarp::os::Property &params)
	This will be called when the portmonitor carrier parameters are set via YARP admin port. More...

virtual bool	getparam (yarp::os::Property &params)
	This will be called when the portmonitor carrier parameters are requested via YARP admin port. More...

virtual void	trig ()
	This will be called when one of the peer connections to the same import port receives data. More...

virtual bool	accept (yarp::os::Things &thing)
	This will be called when the data reach the portmonitor object. More...

virtual yarp::os::Things &	update (yarp::os::Things &thing)
	After data get accpeted in the accept() callback, an instance of that is given to the update function where the data can be accessed and modified. More...

virtual yarp::os::Things &	updateReply (yarp::os::Things &thing)
	The updateReply makes it possible to modify a reply from a port when the portmonitor object is attached to a two-ways connection (e.g., RPC). More...

Protected Member Functions
int	compress (float array, float &compressed, int &zfpsize, int nx, int ny, float tolerance)

int	decompress (float array, float &decompressed, int zfpsize, int nx, int ny, float tolerance)

void	resizeF (float *&array, int newSize)

void	resizeV (void *&array, int newSize)

Detailed Description

ZfpMonitorObject: Portmonitor plugin for compression and decompression of floating point values using zfp library.

Definition at line 19 of file zfpPortmonitor.h.

Member Function Documentation

◆ accept()

bool ZfpMonitorObject::accept ( yarp::os::Things & thing )

overridevirtual

This will be called when the data reach the portmonitor object.

Parameters

thing An instance of yarp::os::Thing object which can be used to typecast the data to the correct type.

Returns: returning false will avoid delivering data to an input port or transmitting through the output port

Reimplemented from yarp::os::MonitorObject.

Definition at line 71 of file zfpPortmonitor.cpp.

◆ compress()

int ZfpMonitorObject::compress	(	float *	array,
		float *&	compressed,
		int &	zfpsize,
		int	nx,
		int	ny,
		float	tolerance
	)

protected

Definition at line 156 of file zfpPortmonitor.cpp.

◆ create()

bool ZfpMonitorObject::create ( const yarp::os::Property & options )

overridevirtual

This will be called when the dll is properly loaded by the portmonitor carrier.

Parameters

options A set of useful information of the current connection which the monitor object is attached.

Returns: Returning false will stop the portmonitor object to procced

Reimplemented from yarp::os::MonitorObject.

Definition at line 32 of file zfpPortmonitor.cpp.

◆ decompress()

int ZfpMonitorObject::decompress	(	float *	array,
		float *&	decompressed,
		int	zfpsize,
		int	nx,
		int	ny,
		float	tolerance
	)

protected

Definition at line 204 of file zfpPortmonitor.cpp.

◆ destroy()

void ZfpMonitorObject::destroy ( void )

overridevirtual

This will be called when the portmonitor object destroyes.

Reimplemented from yarp::os::MonitorObject.

Definition at line 43 of file zfpPortmonitor.cpp.

◆ getparam()

bool ZfpMonitorObject::getparam ( yarp::os::Property & params )

overridevirtual

This will be called when the portmonitor carrier parameters are requested via YARP admin port.

Parameters

params The Property

Returns: Returns true of any parameter is available

Reimplemented from yarp::os::MonitorObject.

Definition at line 66 of file zfpPortmonitor.cpp.

◆ resizeF()

void ZfpMonitorObject::resizeF	(	float *&	array,
		int	newSize
	)

protected

Definition at line 137 of file zfpPortmonitor.cpp.

◆ resizeV()

void ZfpMonitorObject::resizeV	(	void *&	array,
		int	newSize
	)

protected

Definition at line 146 of file zfpPortmonitor.cpp.

◆ setparam()

bool ZfpMonitorObject::setparam ( const yarp::os::Property & params )

overridevirtual

This will be called when the portmonitor carrier parameters are set via YARP admin port.

Parameters

params The Property

Returns: Returns true if parameters are correctly set

Reimplemented from yarp::os::MonitorObject.

Definition at line 61 of file zfpPortmonitor.cpp.

◆ update()

yarp::os::Things & ZfpMonitorObject::update ( yarp::os::Things & thing )

overridevirtual

After data get accpeted in the accept() callback, an instance of that is given to the update function where the data can be accessed and modified.

Parameters

thing An instance of yarp::os::Thing object which can be used to typecast the data to the correct type.

Returns: An instance of modified data in form of Thing

Reimplemented from yarp::os::MonitorObject.

Definition at line 93 of file zfpPortmonitor.cpp.

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

src/portmonitors/depthimage_compression_zfp/zfpPortmonitor.h
src/portmonitors/depthimage_compression_zfp/zfpPortmonitor.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ accept()

◆ compress()

◆ create()

◆ decompress()

◆ destroy()

◆ getparam()

◆ resizeF()

◆ resizeV()

◆ setparam()

◆ update()