bertini::Event< ObsT, false > Class Template Reference

For emission of events from observables. More...

#include <events.hpp>

Inheritance diagram for bertini::Event< ObsT, false >:

Collaboration diagram for bertini::Event< ObsT, false >:

Public Types
using	HeldT = ObsT&
	How the observable is held: by mutable reference.

Public Member Functions
	Event (ObsT &obs)
	Constructor for an event.
virtual	~Event ()=default
ObsT &	Get ()
	Get the emitting object, by const reference.
	Event ()=delete

Protected Attributes
ObsT &	current_observable_
	The observable object this event carries.

Detailed Description

template<class ObsT>
class bertini::Event< ObsT, false >

For emission of events from observables.

An observable object probably wants to emit events to notify observers that things are happening. The observers filter the events, at this time by dynamic casting (slow, I know, but it works for now. Premature optimization, etc.) A better method than dynamic casting would be to filter based on a union of bits or something. If you, the reader, want to help make this better, please contact a developer!

Say I am an observable object, and I want to emit an event. Events attach the type of object emitting them, and in fact (a refence to) the emitter itself. So if my type is T, I would do something like NotifyObservers(Event<T>(*this)). Then an Observer can filter based on a heirarchy of event types, etc.

Template Parameters

ObsT	The Observed type. When emitting an event, you pass in the type of object emitting the event, and the object itself. Then the observer can Get the emitting object, and do (const) stuff to it.

See also

Observable, Observable::NotifyObservers, ADD_BERTINI_EVENT_TYPE, AMPPathAccumulator, AnyEvent

Member Typedef Documentation

HeldT

template<class ObsT>

using bertini::Event< ObsT, false >::HeldT = ObsT&

How the observable is held: by mutable reference.

Constructor & Destructor Documentation

Event() [1/2]

template<class ObsT>

bertini::Event< ObsT, false >::Event ( ObsT & obs )

inline

Constructor for an event.

Parameters

obs	The observable emitting the event to observers. Passed by const reference, this permits arbitrary const function calls by the observer.

~Event()

template<class ObsT>

virtual bertini::Event< ObsT, false >::~Event ( )

virtualdefault

Event() [2/2]

template<class ObsT>

bertini::Event< ObsT, false >::Event ( )

delete

Member Function Documentation

Get()

template<class ObsT>

ObsT & bertini::Event< ObsT, false >::Get ( )

inline

Get the emitting object, by const reference.

Returns

The observable who emitted the event. This permits calls of arbitrary const functions, particularly getters.

See also

AMPPathAccumulator for simple example of filtering using dynamic_casts

Member Data Documentation

current_observable_

template<class ObsT>

ObsT& bertini::Event< ObsT, false >::current_observable_

protected

The observable object this event carries.