MRPT  1.9.9
mrpt::system::CObservable Class Reference

Detailed Description

Inherit from this class for those objects capable of being observed by a CObserver class.

The only thing to do in your child class is to call CObservable::publishEvent() whenever needed and all the observer classes will be notified.

Note
The pairs CObservable / CObserver automatically notify each other the destruction of any of them, effectively ending the subscription of events.
See also
CObserver, mrptEvent

Definition at line 31 of file CObservable.h.

#include <mrpt/system/CObservable.h>

Inheritance diagram for mrpt::system::CObservable:

Public Member Functions

 CObservable ()
 
virtual ~CObservable ()
 

Protected Member Functions

void publishEvent (const mrptEvent &e) const
 Called when you want this object to emit an event to all the observers currently subscribed to this object. More...
 
bool hasSubscribers () const
 Can be called by a derived class before preparing an event for publishing with publishEvent to determine if there is no one subscribed, so it can save the wasted time preparing an event that will be not read. More...
 

Private Member Functions

void internal_observer_begin (CObserver *)
 
void internal_observer_end (CObserver *)
 

Private Attributes

std::set< CObserver * > m_subscribers
 

Friends

class CObserver
 

Constructor & Destructor Documentation

◆ CObservable()

CObservable::CObservable ( )
default

◆ ~CObservable()

CObservable::~CObservable ( )
virtual

Definition at line 20 of file CObservable.cpp.

Member Function Documentation

◆ hasSubscribers()

bool mrpt::system::CObservable::hasSubscribers ( ) const
inlineprotected

Can be called by a derived class before preparing an event for publishing with publishEvent to determine if there is no one subscribed, so it can save the wasted time preparing an event that will be not read.

Definition at line 53 of file CObservable.h.

References m_subscribers.

Referenced by mrpt::gui::CWindowDialog::OnMouseDown(), mrpt::gui::CWindowDialog::OnMouseMove(), mrpt::gui::CWindowDialog::OnResize(), and mrpt::opengl::COpenGLViewport::render().

Here is the caller graph for this function:

◆ internal_observer_begin()

void CObservable::internal_observer_begin ( CObserver o)
private

Definition at line 29 of file CObservable.cpp.

◆ internal_observer_end()

void CObservable::internal_observer_end ( CObserver o)
private

Definition at line 34 of file CObservable.cpp.

References ASSERTMSG_, MRPT_END, and MRPT_START.

◆ publishEvent()

void CObservable::publishEvent ( const mrptEvent e) const
protected

Called when you want this object to emit an event to all the observers currently subscribed to this object.

Definition at line 48 of file CObservable.cpp.

References MRPT_END, and MRPT_START.

Referenced by mrpt::gui::CDisplayWindow3D::internal_emitGrabImageEvent(), mrpt::gui::CWindowDialog::OnChar(), mrpt::gui::CWindowDialog::OnClose(), mrpt::gui::C3DWindowDialog::OnClose(), mrpt::gui::CWindowDialog::OnMouseDown(), mrpt::gui::CWindowDialog::OnMouseMove(), mrpt::gui::CWindowDialog::OnResize(), mrpt::gui::C3DWindowDialog::OnResize(), and mrpt::opengl::COpenGLViewport::render().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ CObserver

friend class CObserver
friend

Definition at line 33 of file CObservable.h.

Member Data Documentation

◆ m_subscribers

std::set<CObserver*> mrpt::system::CObservable::m_subscribers
private

Definition at line 40 of file CObservable.h.

Referenced by hasSubscribers().




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: 5887d2b31 Wed Apr 24 13:03:27 2019 +0200 at miƩ abr 24 13:10:13 CEST 2019