Actual observer type, which you should derive from to extract custom information from observable types. More...

#include <observer.hpp>

Inheritance diagram for bertini::Observer< ObservedT >:

Collaboration diagram for bertini::Observer< ObservedT >:

Public Member Functions
virtual	~Observer ()=default
std::type_index	ObservedKind () const override
	The type this observer expects to observe.
virtual ObserveResult	Observe (AnyEvent const &e)=0
	Observe the observable object being observed.
virtual std::vector< std::type_index >	SubscribedEventTypes () const
	Declares which event types this observer wants to receive.

Detailed Description

template<class ObservedT>
class bertini::Observer< ObservedT >

Actual observer type, which you should derive from to extract custom information from observable types.

Template Parameters

ObservedT	The type of object the observer observes.
RetT	The type of object the observer returns when it visits.

See also: PrecisionAccumulator, GoryDetailLogger, MultiObserver

Constructor & Destructor Documentation

◆ ~Observer()

template<class ObservedT>

virtual bertini::Observer< ObservedT >::~Observer ( )

virtualdefault

Member Function Documentation

◆ Observe()

virtual ObserveResult bertini::AnyObserver::Observe ( AnyEvent const & e )

pure virtualinherited

Observe the observable object being observed.

This is probably in response to NotifyObservers.

This virtual function must be overridden by actual observers, defining how they observe the observable they are observing, probably filtering events and doing something specific for different ones.

Parameters

e	The event which was emitted by the observed object.

Returns: ObserveResult::KeepObserving to keep receiving events, or ObserveResult::Unsubscribe to ask the observable to drop this observer once the current notification finishes.

◆ ObservedKind()

template<class ObservedT>

std::type_index bertini::Observer< ObservedT >::ObservedKind ( ) const

inlineoverridevirtual

The type this observer expects to observe.

Used by Observable::AddObserver to reject attaching an observer to an incompatible observable (which would otherwise silently never fire). The default is typeid(void), a wildcard meaning "attach me anywhere"; Observer<ObservedT> reports typeid(ObservedT).

Reimplemented from bertini::AnyObserver.

◆ SubscribedEventTypes()

virtual std::vector< std::type_index > bertini::AnyObserver::SubscribedEventTypes ( ) const

inlinevirtualinherited

Declares which event types this observer wants to receive.

Return a non-empty vector to opt into type-indexed dispatch: the observable will only call Observe() for events whose dynamic type exactly matches one of the returned type_index values. Return an empty vector (the default) to receive every event — this is the correct choice for observers that handle many or all event types, and is the automatic behavior for Python-defined observers.