Base class for an observable object that can be tracked by multiple Observer objects. More...

#include <ogdf/basic/Observer.h>

Public Member Functions
	Observable ()=default

	Observable (const Observable &copy)=delete
	If you want to copy a subclass of Observable, call the default Observable() constructor. More...

	Observable (Observable &&move)=delete
	If you want to move a subclass of Observable, call the default Observable() constructor. More...

virtual	~Observable ()
	Note that all Observers must already be removed once the destructor of this base class is invoked (e.g. More...

Observable &	operator= (const Observable &copy)=delete

Observable &	operator= (Observable &&move)=delete

Protected Member Functions
void	clearObservers ()

const ListPure< TObserver * > &	getObservers () const

ListPure< TObserver * >::iterator	registerObserver (TObserver *obs) const
	Registers an observer. More...

void	unregisterObserver (typename ListPure< TObserver * >::iterator it) const
	Unregisters an observer. More...

Private Attributes
std::mutex	m_mutexRegArrays
	The critical section for protecting shared access to register/unregister methods. More...

ListPure< TObserver * >	m_regObservers
	The registered observers. More...

friend	Observer< TObserved, TObserver >

friend	TObserved

friend	TObserver

Detailed Description

template<typename TObserver, typename TObserved>
class ogdf::Observable< TObserver, TObserved >

Base class for an observable object that can be tracked by multiple Observer objects.

Will notify its observers when it is destructed and can be subclassed to provide further callbacks. For compatibility with MSVC, the Observer subclass has to be defined before the Observable subclass.

Template Parameters

TObserved	The subclass of Observable that will be observed.
TObserver	The subclass of Observer that defines all virtual callback methods.

Definition at line 127 of file Observer.h.

Constructor & Destructor Documentation

◆ Observable() [1/3]

template<typename TObserver , typename TObserved >

ogdf::Observable< TObserver, TObserved >::Observable ( )

default

◆ ~Observable()

template<typename TObserver , typename TObserved >

virtual ogdf::Observable< TObserver, TObserved >::~Observable ( )

inlinevirtual

Note that all Observers must already be removed once the destructor of this base class is invoked (e.g.

through clearObservers in a child class destructor), as calling it here would notify Observers with already partially destructed child classes.

Definition at line 145 of file Observer.h.

◆ Observable() [2/3]

template<typename TObserver , typename TObserved >

ogdf::Observable< TObserver, TObserved >::Observable ( const Observable< TObserver, TObserved > & copy )

delete

If you want to copy a subclass of Observable, call the default Observable() constructor.

Note that Observers can only observe one Observable and in this case will stay with the old one.

◆ Observable() [3/3]

template<typename TObserver , typename TObserved >

ogdf::Observable< TObserver, TObserved >::Observable ( Observable< TObserver, TObserved > && move )

delete

If you want to move a subclass of Observable, call the default Observable() constructor.

If you want to also point all Observers to the new location of their Observable, call register for each of them.

Member Function Documentation

◆ clearObservers()

template<typename TObserver , typename TObserved >

void ogdf::Observable< TObserver, TObserved >::clearObservers ( )

inlineprotected

Definition at line 208 of file Observer.h.

◆ getObservers()

template<typename TObserver , typename TObserved >

const ListPure<TObserver*>& ogdf::Observable< TObserver, TObserved >::getObservers ( ) const

inlineprotected

Definition at line 206 of file Observer.h.

◆ operator=() [1/2]

template<typename TObserver , typename TObserved >

Observable& ogdf::Observable< TObserver, TObserved >::operator= ( const Observable< TObserver, TObserved > & copy )

delete

◆ operator=() [2/2]

template<typename TObserver , typename TObserved >

Observable& ogdf::Observable< TObserver, TObserved >::operator= ( Observable< TObserver, TObserved > && move )

delete

◆ registerObserver()

template<typename TObserver , typename TObserved >

ListPure<TObserver*>::iterator ogdf::Observable< TObserver, TObserved >::registerObserver ( TObserver * obs ) const

inlineprotected

Registers an observer.

You should never directly call this method as it is called by the Observer() constructor and Observer::reregister() methods automatically. If you have a class that inherits from multiple Observables, you may need to reexport this method:

friend Observer<ObservableA, ObserverA>;
friend Observer<ObservableB, ObserverB>;
using ParentObservableA::(un)registerObserver; using ParentObservableB::(un)registerObserver;

See https://stackoverflow.com/a/1313162 and ClusterGraph for an example.

Parameters

obs	is a pointer to the observer that shall be registered

Returns: an iterator pointing to the entry for the registered observer in the list of registered observers. This iterator is required for unregistering the observer again.

Definition at line 176 of file Observer.h.

◆ unregisterObserver()

template<typename TObserver , typename TObserved >

void ogdf::Observable< TObserver, TObserved >::unregisterObserver ( typename ListPure< TObserver * >::iterator it ) const

inlineprotected

Unregisters an observer.

You should never directly call this method as it is called by the ~Observer() destructor and Observer::reregister() methods automatically. If you have a class that inherits from multiple Observables, you may need to reexport this method:

friend Observer<ObservableA, ObserverA>;
friend Observer<ObservableB, ObserverB>;
using ParentObservableA::(un)registerObserver; using ParentObservableB::(un)registerObserver;

See https://stackoverflow.com/a/1313162 and ClusterGraph for an example.

Parameters

it	is an iterator pointing to the entry in the list of registered observers for the observer to be unregistered.

Definition at line 199 of file Observer.h.

Member Data Documentation

◆ m_mutexRegArrays

template<typename TObserver , typename TObserved >

std::mutex ogdf::Observable< TObserver, TObserved >::m_mutexRegArrays

mutableprivate

The critical section for protecting shared access to register/unregister methods.

Definition at line 133 of file Observer.h.

◆ m_regObservers

template<typename TObserver , typename TObserved >

ListPure<TObserver*> ogdf::Observable< TObserver, TObserved >::m_regObservers

mutableprivate

The registered observers.

Definition at line 135 of file Observer.h.

◆ Observer< TObserved, TObserver >

template<typename TObserver , typename TObserved >

friend ogdf::Observable< TObserver, TObserved >::Observer< TObserved, TObserver >

private

Definition at line 128 of file Observer.h.

◆ TObserved

template<typename TObserver , typename TObserved >

friend ogdf::Observable< TObserver, TObserved >::TObserved

private

Definition at line 129 of file Observer.h.

◆ TObserver

template<typename TObserver , typename TObserved >

friend ogdf::Observable< TObserver, TObserved >::TObserver

private

Definition at line 130 of file Observer.h.

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

include/ogdf/basic/Observer.h

OpenGraph DrawingFramework

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

template<typename TObserver, typename TObserved> class ogdf::Observable< TObserver, TObserved >

Constructor & Destructor Documentation

◆ Observable() [1/3]

◆ ~Observable()

◆ Observable() [2/3]

◆ Observable() [3/3]

Member Function Documentation

◆ clearObservers()

◆ getObservers()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ registerObserver()

◆ unregisterObserver()

Member Data Documentation

◆ m_mutexRegArrays

◆ m_regObservers

◆ Observer< TObserved, TObserver >

◆ TObserved

◆ TObserver

Open
Graph Drawing
Framework

template<typename TObserver, typename TObserved>
class ogdf::Observable< TObserver, TObserved >