YARP
Yet Another Robot Platform
Public Member Functions | List of all members
yarp::os::MonitorObject Class Reference

#include <yarp/os/MonitorObject.h>

Public Member Functions

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...
 

Detailed Description

Definition at line 22 of file MonitorObject.h.

Constructor & Destructor Documentation

◆ ~MonitorObject()

yarp::os::MonitorObject::~MonitorObject ( )
virtualdefault

Member Function Documentation

◆ accept()

bool yarp::os::MonitorObject::accept ( yarp::os::Things &  thing)
virtual

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

Parameters
thingAn 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

Definition at line 38 of file MonitorObject.cpp.

◆ create()

bool yarp::os::MonitorObject::create ( const yarp::os::Property &  options)
virtual

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

Parameters
optionsA set of useful information of the current connection which the monitor object is attached.
Returns
Returning false will stop the portmonitor object to procced

Definition at line 12 of file MonitorObject.cpp.

◆ destroy()

void yarp::os::MonitorObject::destroy ( )
virtual

This will be called when the portmonitor object destroyes.

Definition at line 18 of file MonitorObject.cpp.

◆ getparam()

bool yarp::os::MonitorObject::getparam ( yarp::os::Property &  params)
virtual

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

Parameters
paramsThe Property
Returns
Returns true of any parameter is available

Definition at line 28 of file MonitorObject.cpp.

◆ setparam()

bool yarp::os::MonitorObject::setparam ( const yarp::os::Property &  params)
virtual

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

Parameters
paramsThe Property
Returns
Returns true if parameters are correctly set

Definition at line 22 of file MonitorObject.cpp.

◆ trig()

void yarp::os::MonitorObject::trig ( )
virtual

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

Definition at line 34 of file MonitorObject.cpp.

◆ update()

yarp::os::Things & yarp::os::MonitorObject::update ( yarp::os::Things &  thing)
virtual

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
thingAn 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

Definition at line 44 of file MonitorObject.cpp.

◆ updateReply()

yarp::os::Things & yarp::os::MonitorObject::updateReply ( yarp::os::Things &  thing)
virtual

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).

Parameters
thingAn 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

Definition at line 50 of file MonitorObject.cpp.

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