DumpModule Class Reference

Inheritance diagram for DumpModule:

Public Member Functions
	DumpModule ()=default
bool	configure (ResourceFinder &rf) override
	Configure the module, pass a ResourceFinder object to the module.
bool	close () override
	Close function.
double	getPeriod () override
	You can override this to control the approximate periodicity at which updateModule() is called by runModule().
bool	updateModule () override
	Override this to do whatever your module needs to do.
Public Member Functions inherited from yarp::os::RFModule
	RFModule ()
	Constructor.
virtual	~RFModule ()
	Destructor.
virtual int	runModule ()
	Calls updateModule() until that returns false.
virtual int	runModule (yarp::os::ResourceFinder &rf)
	Simple helper method to call configure() and then runModule().
virtual int	runModuleThreaded ()
	Calls updateModule() on a separate thread until that returns false.
virtual int	runModuleThreaded (yarp::os::ResourceFinder &rf)
	Simple helper method to call configure() and then runModule() on a separate thread.
virtual int	getThreadKey ()
	return the Thread unique identifier
virtual bool	respond (const Bottle &command, Bottle &reply)
	Respond to a message.
virtual bool	attach (yarp::os::Port &source)
	Make any input from a Port object go to the respond() method.
virtual bool	attach (yarp::os::RpcServer &source)
	Make any input from an RpcServer object go to the respond() method.
bool	attachTerminal ()
	Make any input from standard input (usually the keyboard) go to the respond() method.
bool	detachTerminal ()
	Detach terminal.
virtual bool	interruptModule ()
	Try to halt any ongoing operations by threads managed by the module.
void	stopModule (bool wait=false)
	Ask the module to stop.
bool	isStopping ()
	Check if the module should stop.
bool	joinModule (double seconds=-1)
	The function returns when the thread execution has completed.
std::string	getName (const std::string &subName="")
	Return name of module, as set with setName().
void	setName (const char *name)
	Set the name of the module.
bool	safeRespond (const Bottle &command, Bottle &reply)
	Wrapper around respond() that is guaranteed to process system messages.

Detailed Description

Definition at line 605 of file main.cpp.

Constructor & Destructor Documentation

DumpModule()

DumpModule::DumpModule ( )

default

Member Function Documentation

close()

bool DumpModule::close ( )

inlineoverridevirtual

Close function.

This is called automatically when the module closes, after the last call to updateModule. Override this to cleanup memory allocated in the configure() function or perform other activities that ensure graceful shutdown.

Returns

true/false on success failure.

Reimplemented from yarp::os::RFModule.

Definition at line 801 of file main.cpp.

configure()

bool DumpModule::configure ( ResourceFinder &  rf )

inlineoverridevirtual

Configure the module, pass a ResourceFinder object to the module.

This function can perform initialization including object creation and memory allocation; returns false to notify that initialization was not successful and that the module should not start. Cleanup should be performed by the function close(). In case of failure during the initialization and before returning false, the function configure() should cleanup memory and resources allocated.

Parameters

rf	a previously initialized ResourceFinder

Returns

true/false upon success/failure

Note

attachTerminal() is no longer called automatically. You can call it in the configure function.

Reimplemented from yarp::os::RFModule.

Definition at line 641 of file main.cpp.

getPeriod()

double DumpModule::getPeriod ( )

inlineoverridevirtual

You can override this to control the approximate periodicity at which updateModule() is called by runModule().

By default, it returns 1.0. Time here is in seconds.

Returns

the desired period between successive calls to updateModule()

Reimplemented from yarp::os::RFModule.

Definition at line 827 of file main.cpp.

updateModule()

bool DumpModule::updateModule ( )

inlineoverridevirtual

Override this to do whatever your module needs to do.

When your module wants to stop, return false. The module's actual work could be done during this call, or it could just check the state of a thread running in the background.

The thread calls the updateModule() function every <period> seconds. At the end of each run, the thread will sleep the amounth of time required, taking into account the time spent inside the loop function. Example: requested period is 10ms, the updateModule() function take 3ms to be executed, the thread will sleep for 7ms.

Note: after each run is completed, the thread will call a yield() in order to facilitate other threads to run.

Returns

true iff module should continue

Implements yarp::os::RFModule.

Definition at line 828 of file main.cpp.

---

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

• src/commands/yarpdatadumper/main.cpp