ogdf::RegisteredObserver< Registry > Class Template Reference

Abstract Base class for registry observers. More...

#include <ogdf/basic/RegisteredArray.h>

Inheritance diagram for ogdf::RegisteredObserver< Registry >:

Public Member Functions
	RegisteredObserver ()=default
	Constructs instance of RegisteredObserver class.
	RegisteredObserver (const Registry *R)
const Registry *	getRegistry () const
virtual void	keyAdded (typename Registry::key_type v)=0
	Called by watched registry after a key has been added.
virtual void	keyRemoved (typename Registry::key_type v)=0
	Called by watched registry just before a key is deleted.
virtual void	keysCleared ()=0
	Called by watched registry when its clear function is called, just before things are removed.
virtual void	keysCopied (int toIndex, int fromIndex)=0
	Called when an entry is copied from fromIndex to toIndex in all registered arrays.
virtual void	keysSwapped (int index1, int index2)=0
	Called when an entry is swapped between index1 and index2 in all registered arrays.
Public Member Functions inherited from ogdf::Observer< Registry, RegisteredObserver< Registry > >
	Observer ()=default
	Constructs unregistered instance of Observer class.
	Observer (const Observer &copy)=delete
	If you want to copy a subclass of Observer, call the default Observer() constructor and optionally also call reregister if it makes sense.
	Observer (const Registry *R)
	Observer (Observer &&move)=delete
	If you want to move a subclass of Observer, call the default Observer() constructor and optionally also call reregister if it makes sense.
virtual	~Observer ()
	Destroys the instance, unregisters it from watched instance.
const Registry *	getObserved () const
Observer &	operator= (const Observer &copy)=delete
Observer &	operator= (Observer &&move)=delete
virtual void	registrationChanged (const Registry *old)
	Called after reregister() changed the observed instance.
void	reregister (const Registry *obs)
	Associates observer instance with instance obs.

Private Types
using	Obs = Observer< Registry, RegisteredObserver< Registry > >

Detailed Description

template<typename Registry>
class ogdf::RegisteredObserver< Registry >

Abstract Base class for registry observers.

Definition at line 76 of file RegisteredArray.h.

Member Typedef Documentation

Obs

template<typename Registry >

using ogdf::RegisteredObserver< Registry >::Obs = Observer<Registry, RegisteredObserver<Registry> >

private

Definition at line 77 of file RegisteredArray.h.

Constructor & Destructor Documentation

RegisteredObserver() [1/2]

template<typename Registry >

ogdf::RegisteredObserver< Registry >::RegisteredObserver ( )

default

Constructs instance of RegisteredObserver class.

RegisteredObserver() [2/2]

template<typename Registry >

ogdf::RegisteredObserver< Registry >::RegisteredObserver ( const Registry *  R )

inlineexplicit

Deprecated:

"calls registrationChanged with only partially-constructed child classes, " "see copy constructor of Observer for fix"

Definition at line 86 of file RegisteredArray.h.

Member Function Documentation

getRegistry()

template<typename Registry >

const Registry * ogdf::RegisteredObserver< Registry >::getRegistry ( ) const

inline

Definition at line 103 of file RegisteredArray.h.

keyAdded()

template<typename Registry >

virtual void ogdf::RegisteredObserver< Registry >::keyAdded ( typename Registry::key_type  v )

pure virtual

Called by watched registry after a key has been added.

Implemented in ogdf::RegisteredSet< Registry >, ogdf::RegisteredSet< ClusterGraph >, ogdf::RegisteredSet< ConstCombinatorialEmbedding >, ogdf::RegisteredSet< internal::GraphAdjRegistry >, ogdf::RegisteredSet< internal::GraphEdgeRegistry >, and ogdf::RegisteredSet< internal::GraphNodeRegistry >.

keyRemoved()

template<typename Registry >

virtual void ogdf::RegisteredObserver< Registry >::keyRemoved ( typename Registry::key_type  v )

pure virtual

Called by watched registry just before a key is deleted.

Implemented in ogdf::RegisteredSet< Registry >, ogdf::RegisteredSet< ClusterGraph >, ogdf::RegisteredSet< ConstCombinatorialEmbedding >, ogdf::RegisteredSet< internal::GraphAdjRegistry >, ogdf::RegisteredSet< internal::GraphEdgeRegistry >, and ogdf::RegisteredSet< internal::GraphNodeRegistry >.

keysCleared()

template<typename Registry >

virtual void ogdf::RegisteredObserver< Registry >::keysCleared ( )

pure virtual

Called by watched registry when its clear function is called, just before things are removed.

Implemented in ogdf::RegisteredSet< Registry >, ogdf::RegisteredSet< ClusterGraph >, ogdf::RegisteredSet< ConstCombinatorialEmbedding >, ogdf::RegisteredSet< internal::GraphAdjRegistry >, ogdf::RegisteredSet< internal::GraphEdgeRegistry >, and ogdf::RegisteredSet< internal::GraphNodeRegistry >.

keysCopied()

template<typename Registry >

virtual void ogdf::RegisteredObserver< Registry >::keysCopied ( int  toIndex, int  fromIndex  )

pure virtual

Called when an entry is copied from fromIndex to toIndex in all registered arrays.

Implemented in ogdf::RegisteredSet< Registry >, ogdf::RegisteredSet< ClusterGraph >, ogdf::RegisteredSet< ConstCombinatorialEmbedding >, ogdf::RegisteredSet< internal::GraphAdjRegistry >, ogdf::RegisteredSet< internal::GraphEdgeRegistry >, and ogdf::RegisteredSet< internal::GraphNodeRegistry >.

keysSwapped()

template<typename Registry >

virtual void ogdf::RegisteredObserver< Registry >::keysSwapped ( int  index1, int  index2  )

pure virtual

Called when an entry is swapped between index1 and index2 in all registered arrays.

Implemented in ogdf::RegisteredSet< Registry >, ogdf::RegisteredSet< ClusterGraph >, ogdf::RegisteredSet< ConstCombinatorialEmbedding >, ogdf::RegisteredSet< internal::GraphAdjRegistry >, ogdf::RegisteredSet< internal::GraphEdgeRegistry >, and ogdf::RegisteredSet< internal::GraphNodeRegistry >.

---

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

• include/ogdf/basic/RegisteredArray.h