anch::events::Observable< Event > Class Template Reference

An observable implementation of the observers/observable design pattern. More...

#include <observable.hpp>

Inheritance diagram for anch::events::Observable< Event >:

Collaboration diagram for anch::events::Observable< Event >:

Public Member Functions
	Observable ()
virtual	~Observable ()
bool	addObserver (anch::events::Observer< Event > &observer)
void	removeObserver (anch::events::Observer< Event > &observer)
void	notifyObservers (const Event &event)

Detailed Description

template<typename Event>
class anch::events::Observable< Event >

An observable implementation of the observers/observable design pattern.

This class maintains an observer list which have to be notified on event.

Since

0.1

Author

Vincent Lachenal

Constructor & Destructor Documentation

template<typename Event>

anch::events::Observable< Event >::Observable ( )

inline

Observable default constructor

template<typename Event>

virtual anch::events::Observable< Event >::~Observable ( )

inlinevirtual

Observable destructor

Member Function Documentation

template<typename Event>

bool anch::events::Observable< Event >::addObserver ( anch::events::Observer< Event > &  observer )

inline

Add observer for notifications

Parameters

observer

The observer to add

Returns

true if observer has been added, false otherwise

template<typename Event>

void anch::events::Observable< Event >::notifyObservers ( const Event &  event )

inline

Notify every observer that an event has been fired

Parameters

event

the event to fire

template<typename Event>

void anch::events::Observable< Event >::removeObserver ( anch::events::Observer< Event > &  observer )

inline

Remove observer for notifications

Parameters

observer

The observer to remove

---

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

• anch-events/inc/events/observable.hpp