YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
RerunLogger Class Reference
+ Inheritance diagram for RerunLogger:

Public Member Functions

 RerunLogger ()
 
 ~RerunLogger ()
 
bool process_RGBImage (const Bottle *pbot)
 
bool process_SensorStreamingData (const Bottle *pbot)
 
bool process_Bottle (const Bottle *pbot)
 
bool process_Vector (const Bottle *pbot)
 
bool process_RobotState (const Bottle *pbot)
 
bool process_DepthImage (const Bottle *pbot)
 
bool process_Lidar2D (const Bottle *pbot)
 
bool process_PointCloud (const Bottle *pbot)
 
void process_Bottle_nested (const Bottle *pbot, std::vector< size_t > path)
 
bool configure (yarp::os::ResourceFinder &rf) override
 Configure the module, pass a ResourceFinder object to the module.
 
bool interruptModule () override
 Try to halt any ongoing operations by threads managed by the module.
 
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 close ()
 Close function.
 
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.
 

Public Attributes

rerun::RecordingStream * m_rec = nullptr
 
yarp::os::BufferedPort< yarp::os::Bottlem_port
 

Detailed Description

Definition at line 29 of file yarpRerun.cpp.

Constructor & Destructor Documentation

◆ RerunLogger()

RerunLogger::RerunLogger ( )
inline

Definition at line 35 of file yarpRerun.cpp.

◆ ~RerunLogger()

RerunLogger::~RerunLogger ( )
inline

Definition at line 39 of file yarpRerun.cpp.

Member Function Documentation

◆ configure()

bool RerunLogger::configure ( yarp::os::ResourceFinder rf)
overridevirtual

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
rfa 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 85 of file yarpRerun.cpp.

◆ getPeriod()

double RerunLogger::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 63 of file yarpRerun.cpp.

◆ interruptModule()

bool RerunLogger::interruptModule ( )
overridevirtual

Try to halt any ongoing operations by threads managed by the module.

This is called asynchronously just after a quit command is received. By default it does nothing - you may want to override this. If you have created any ports, and have any threads that are might be blocked on reading data from those ports, this is a good place to add calls to BufferedPort::interrupt() or Port::interrupt().

Returns
true if there was no catastrophic failure

Reimplemented from yarp::os::RFModule.

Definition at line 78 of file yarpRerun.cpp.

◆ process_Bottle()

bool RerunLogger::process_Bottle ( const Bottle pbot)

Definition at line 377 of file yarpRerun.cpp.

◆ process_Bottle_nested()

void RerunLogger::process_Bottle_nested ( const Bottle pbot,
std::vector< size_t path 
)

Definition at line 354 of file yarpRerun.cpp.

◆ process_DepthImage()

bool RerunLogger::process_DepthImage ( const Bottle pbot)

Definition at line 427 of file yarpRerun.cpp.

◆ process_Lidar2D()

bool RerunLogger::process_Lidar2D ( const Bottle pbot)

Definition at line 223 of file yarpRerun.cpp.

◆ process_PointCloud()

bool RerunLogger::process_PointCloud ( const Bottle pbot)

Definition at line 245 of file yarpRerun.cpp.

◆ process_RGBImage()

bool RerunLogger::process_RGBImage ( const Bottle pbot)

Definition at line 207 of file yarpRerun.cpp.

◆ process_RobotState()

bool RerunLogger::process_RobotState ( const Bottle pbot)

Definition at line 405 of file yarpRerun.cpp.

◆ process_SensorStreamingData()

bool RerunLogger::process_SensorStreamingData ( const Bottle pbot)

Definition at line 269 of file yarpRerun.cpp.

◆ process_Vector()

bool RerunLogger::process_Vector ( const Bottle pbot)

Definition at line 389 of file yarpRerun.cpp.

◆ updateModule()

bool RerunLogger::updateModule ( )
overridevirtual

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 151 of file yarpRerun.cpp.

Member Data Documentation

◆ m_port

Definition at line 33 of file yarpRerun.cpp.

◆ m_rec

rerun::RecordingStream* RerunLogger::m_rec = nullptr

Definition at line 32 of file yarpRerun.cpp.


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