#include <UEvent.h>

Inheritance diagram for UEvent:

[legend]

Public Member Functions
virtual std::string	getClassName () const =0

int	getCode () const

Protected Member Functions
	UEvent (int code=0)

Detailed Description

This is the base class for all events used with the UEventsManager. Inherited classes must redefined the virtual method getClassName() to return their class name.

Example:

class MyEvent : public UEvent
{
public:
   MyEvent() {}
   virtual ~MyEvent() {}
   std::string getClassName() const {return "MyEvent";}
};
 
int main(int argc, char * argv[])
{
 ...
 UEventsManager::post(new MyEvent()); // UEventsManager take ownership of the event (deleted by UEventsManager).
 ...
}

See also: UEventsManager; UEventsHandler; getClassName()

Definition at line 57 of file UEvent.h.

Constructor & Destructor Documentation

◆ ~UEvent()

virtual UEvent::~UEvent ( )

inlinevirtual

Definition at line 59 of file UEvent.h.

◆ UEvent()

UEvent::UEvent ( int code = 0 )

inlineprotected

Parameters

code	the event code. TODO : Remove the code, not required for most of all implemented events

Definition at line 81 of file UEvent.h.

Member Function Documentation

◆ getClassName()

virtual std::string UEvent::getClassName ( ) const

pure virtual

This method is used to get the class name of the event. For example, if a class MouseEvent inherits from UEvent, it must return the "MouseEvent" string.

Returns: the class name

Implemented in rtabmap::IMUEvent, rtabmap::OdometryEvent, rtabmap::OdometryResetEvent, rtabmap::ParamEvent, rtabmap::RtabmapEvent, rtabmap::RtabmapEventCmd, rtabmap::RtabmapEventInit, rtabmap::RtabmapEvent3DMap, rtabmap::RtabmapGlobalPathEvent, rtabmap::RtabmapLabelErrorEvent, rtabmap::RtabmapGoalStatusEvent, rtabmap::SensorEvent, rtabmap::UserDataEvent, ULogEvent, and UObjDeletedEvent.

◆ getCode()

int UEvent::getCode ( ) const

inline

Get event's code.

Returns: the code

Definition at line 74 of file UEvent.h.

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

utilite/include/rtabmap/utilite/UEvent.h

Public Member Functions