Sound_marker Class Reference

sound_marker: Documentation to be added More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/portmonitors/sound_marker/Sound_marker.h>

Inheritance diagram for Sound_marker:

Public Member Functions
void	getParamsFromCommandLine (std::string carrierString, yarp::os::Property &prop)
bool	create (const yarp::os::Property &options) override
	This will be called when the dll is properly loaded by the portmonitor carrier.
void	destroy () override
	This will be called when the portmonitor object destroyes.
bool	setparam (const yarp::os::Property &params) override
	This will be called when the portmonitor carrier parameters are set via YARP admin port.
bool	getparam (yarp::os::Property &params) override
	This will be called when the portmonitor carrier parameters are requested via YARP admin port.
void	trig () override
	This will be called when one of the peer connections to the same import port receives data.
bool	accept (yarp::os::Things &thing) override
	This will be called when the data reach the portmonitor object.
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.
Public Member Functions inherited from yarp::os::MonitorObject
virtual	~MonitorObject ()
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).

Detailed Description

sound_marker: Documentation to be added

Definition at line 21 of file Sound_marker.h.

Member Function Documentation

accept()

bool Sound_marker::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 84 of file Sound_marker.cpp.

create()

bool Sound_marker::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 54 of file Sound_marker.cpp.

destroy()

void Sound_marker::destroy ( void  )

overridevirtual

This will be called when the portmonitor object destroyes.

Reimplemented from yarp::os::MonitorObject.

Definition at line 70 of file Sound_marker.cpp.

getparam()

bool Sound_marker::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 79 of file Sound_marker.cpp.

getParamsFromCommandLine()

void Sound_marker::getParamsFromCommandLine	(	std::string	carrierString,
		yarp::os::Property &	prop
	)

Definition at line 26 of file Sound_marker.cpp.

setparam()

bool Sound_marker::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 74 of file Sound_marker.cpp.

trig()

void Sound_marker::trig ( )

overridevirtual

This will be called when one of the peer connections to the same import port receives data.

Note

this is available only if the portmonitor object attached to the input port

Reimplemented from yarp::os::MonitorObject.

Definition at line 129 of file Sound_marker.cpp.

update()

yarp::os::Things & Sound_marker::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 96 of file Sound_marker.cpp.

---

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

• src/portmonitors/sound_marker/Sound_marker.h
• src/portmonitors/sound_marker/Sound_marker.cpp