UbObservable Class Reference

Observable object. More...

#include <UbObservable.h>

Inheritance diagram for UbObservable:

Public Member Functions
virtual	~UbObservable ()
virtual void	addObserver (UbObserver *observer)
virtual void	removeObserver (UbObserver *observer)
virtual void	removeAllObservers ()
virtual bool	isObservedBy (UbObserver *observer)
virtual void	notifyObserversObjectChanged ()
std::list< UbObserver * > *	getObserverList ()
virtual std::string	toString ()

Protected Member Functions
	UbObservable ()=default
	UbObservable (const UbObservable &)
UbObservable &	operator= (const UbObservable &)

Detailed Description

Observable object.

This class provides Observables. The Observeres which observe this Observable are stored in an observerlist. IMPORTANT: objectWillBeDeleted is called at UbObserver::~UbObserver this destructor is called AFTER the destructor of the child classes. if you down_cast the pointer sent with the objectWillBeDeleted(UbObserver* objpointer) then have to go this:

if(dynamic_cast<UbObserver*>(observedObj)==objpointer) (e.g.) observedObj=NULL; example: see end of file

a copy of an UbservableObject will NOT copy the observerList

• Extending: This UbObservable is the observable object itself. Extending should be used where object types can be extended from UbObservable.
• Associating: Initialization is done via the constructor UbObservable(ObservableObject). Associating may be used, where object types to be observed could not be extended from UbObservable.

see UbObserver

Definition at line 70 of file UbObservable.h.

Constructor & Destructor Documentation

UbObservable() [1/2]

UbObservable::UbObservable ( )

protecteddefault

Creates a UbObservable itself to be the object to be observed. Usually this constructor is used in extended classes.

UbObservable() [2/2]

UbObservable::UbObservable ( const UbObservable &  )

inlineprotected

Definition at line 82 of file UbObservable.h.

~UbObservable()

virtual UbObservable::~UbObservable ( )

inlinevirtual

Definition at line 102 of file UbObservable.h.

Member Function Documentation

addObserver()

virtual void UbObservable::addObserver ( UbObserver *  observer )

inlinevirtual

Adds an UbObserver to the observerlist.

Parameters

observer

the observer to add to this observable (note that an observer may observe c1 observable more than once)

Definition at line 113 of file UbObservable.h.

getObserverList()

std::list< UbObserver * > * UbObservable::getObserverList ( )

inline

Definition at line 174 of file UbObservable.h.

isObservedBy()

virtual bool UbObservable::isObservedBy ( UbObserver *  observer )

inlinevirtual

Checks whether the specified UbObserver observes this observable.

Parameters

observer

the observer to remove from this observable (note that all observers identical are deleted)

Returns

true if the specified observer observes this observable

Definition at line 145 of file UbObservable.h.

notifyObserversObjectChanged()

virtual void UbObservable::notifyObserversObjectChanged ( )

inlinevirtual

Notifies all of its observers that something happened. Does nothing, if the observed object is null. Calls the Method UbObserver.objectChanged(Object) with the object of this observable as parameter. The Method UbObserver.objectChanged(Object) must be defined by each class implementing the interface TiObserver

Definition at line 161 of file UbObservable.h.

operator=()

UbObservable & UbObservable::operator= ( const UbObservable &  )

inlineprotected

Definition at line 89 of file UbObservable.h.

removeAllObservers()

virtual void UbObservable::removeAllObservers ( )

inlinevirtual

Deletes all Observers from the observerlist. ( delete means delete Heap... but here we're only removing a pointer)

Definition at line 138 of file UbObservable.h.

removeObserver()

virtual void UbObservable::removeObserver ( UbObserver *  observer )

inlinevirtual

Deletes an UbObserver from the observerlist.

Parameters

observer

the observer to remove from this observable (note that all observers identical are deleted) ( delete means delete Heap... but here we're only removing a pointer)

Definition at line 128 of file UbObservable.h.

toString()

virtual std::string UbObservable::toString ( )

inlinevirtual

Reimplemented in GbCuboid3D, GbCylinder3D, GbHalfSpaceKrischan3D, GbLine3D, GbObjectGroup3D, GbPoint3D, GbPolygon3D, GbQuadFaceMesh3D, GbSphere3D, GbTriangle3D, GbTriangularMesh3D, GbTriFaceMesh3D, GbVoxelMatrix3D, and ObObject.

Definition at line 176 of file UbObservable.h.

---

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

• src/basics/utilities/UbObservable.h