mrpt::utils::mrptEvent Class Reference

Detailed Description

The basic event type for the observer-observable pattern in MRPT.

You can sub-class this base class to create custom event types, then tell between them in runtime with isOfType<T>(), for example:

if (e.isOfType<mrptEventOnDestroy>())
{
  const mrptEventOnDestroy* ev = e.getAs<mrptEventOnDestroy>();
  ev-> ...
}

See also

CObserver, CObservable

Definition at line 34 of file mrptEvent.h.

#include <mrpt/utils/mrptEvent.h>

Inheritance diagram for mrpt::utils::mrptEvent:

Public Member Functions
	mrptEvent ()
	Default ctor. More...
template<class EVENTTYPE >
bool	isOfType () const
template<class EVENTTYPE >
const EVENTTYPE *	getAs () const
template<class EVENTTYPE >
EVENTTYPE *	getAsNonConst () const

Public Attributes
mrpt::system::TTimeStamp	timestamp

Protected Member Functions
virtual void	do_nothing ()
	Just to allow this class to be polymorphic. More...

Constructor & Destructor Documentation

mrptEvent()

mrpt::utils::mrptEvent::mrptEvent ( )

inline

Default ctor.

Definition at line 40 of file mrptEvent.h.

Member Function Documentation

do_nothing()

virtual void mrpt::utils::mrptEvent::do_nothing ( )

inlineprotectedvirtual

Just to allow this class to be polymorphic.

Reimplemented in mrpt::opengl::mrptEventGLPostRender, mrpt::opengl::mrptEventGLPreRender, mrpt::gui::mrptEvent3DWindowGrabImageFile, mrpt::gui::mrptEventWindowClosed, mrpt::gui::mrptEventMouseMove, mrpt::gui::mrptEventMouseDown, mrpt::gui::mrptEventWindowResize, mrpt::gui::mrptEventWindowChar, mrpt::utils::mrptEventOnDestroy, mrpt::maps::mrptEventMetricMapInsert, and mrpt::maps::mrptEventMetricMapClear.

Definition at line 37 of file mrptEvent.h.

getAs()

template<class EVENTTYPE >

const EVENTTYPE* mrpt::utils::mrptEvent::getAs ( ) const

inline

Definition at line 46 of file mrptEvent.h.

getAsNonConst()

template<class EVENTTYPE >

EVENTTYPE* mrpt::utils::mrptEvent::getAsNonConst ( ) const

inline

Definition at line 49 of file mrptEvent.h.

isOfType()

template<class EVENTTYPE >

bool mrpt::utils::mrptEvent::isOfType ( ) const

inline

Definition at line 43 of file mrptEvent.h.

Referenced by mrpt::graphslam::CWindowObserver::OnEvent(), and mrpt::slam::COccupancyGridMapFeatureExtractor::OnEvent().

Member Data Documentation

timestamp

mrpt::system::TTimeStamp mrpt::utils::mrptEvent::timestamp

Definition at line 51 of file mrptEvent.h.