osg::ObserverSet Class Reference

Class used by osg::Referenced to track the observers associated with it. More...

#include <Observer>

Inheritance diagram for osg::ObserverSet:

Public Types
typedef std::set< Observer * >	Observers

Public Member Functions
	ObserverSet (const Referenced *observedObject)
Referenced *	getObserverdObject ()
const Referenced *	getObserverdObject () const
Referenced *	addRefLock ()
	"Lock" a Referenced object i.e., protect it from being deleted by incrementing its reference count.
OpenThreads::Mutex *	getObserverSetMutex () const
void	addObserver (Observer *observer)
void	removeObserver (Observer *observer)
void	signalObjectDeleted (void *ptr)
Observers &	getObservers ()
const Observers &	getObservers () const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
virtual void	setThreadSafeRefUnref (bool)
	Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called.
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref().
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int	referenceCount () const
	Return the number of pointers currently referencing this object.
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object.

Protected Member Functions
	ObserverSet (const ObserverSet &rhs)
ObserverSet &	operator= (const ObserverSet &)
virtual	~ObserverSet ()
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Protected Attributes
OpenThreads::Mutex	_mutex
Referenced *	_observedObject
Observers	_observers
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Additional Inherited Members
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler.

Detailed Description

Class used by osg::Referenced to track the observers associated with it.

Member Typedef Documentation

Observers

typedef std::set<Observer*> osg::ObserverSet::Observers

Constructor & Destructor Documentation

ObserverSet() [1/2]

osg::ObserverSet::ObserverSet

(

const Referenced *

observedObject

)

References osg::Referenced::Referenced().

Referenced by ObserverSet(), and operator=().

ObserverSet() [2/2]

osg::ObserverSet::ObserverSet ( const ObserverSet & rhs )

inlineprotected

References ObserverSet(), and osg::Referenced::Referenced().

~ObserverSet()

virtual osg::ObserverSet::~ObserverSet ( )

protectedvirtual

Member Function Documentation

addObserver()

void osg::ObserverSet::addObserver

(

Observer *

observer

)

addRefLock()

Referenced * osg::ObserverSet::addRefLock

(

)

"Lock" a Referenced object i.e., protect it from being deleted by incrementing its reference count.

returns null if object doesn't exist anymore.

References osg::Referenced::Referenced().

getObserverdObject() [1/2]

Referenced * osg::ObserverSet::getObserverdObject ( )

inline

References _observedObject, and osg::Referenced::Referenced().

getObserverdObject() [2/2]

const Referenced * osg::ObserverSet::getObserverdObject ( ) const

inline

References _observedObject, and osg::Referenced::Referenced().

getObservers() [1/2]

Observers & osg::ObserverSet::getObservers ( )

inline

References _observers.

getObservers() [2/2]

const Observers & osg::ObserverSet::getObservers ( ) const

inline

References _observers.

getObserverSetMutex()

OpenThreads::Mutex * osg::ObserverSet::getObserverSetMutex ( ) const

inline

References _mutex.

operator=()

ObserverSet & osg::ObserverSet::operator= ( const ObserverSet & )

inlineprotected

References ObserverSet().

removeObserver()

void osg::ObserverSet::removeObserver

(

Observer *

observer

)

signalObjectDeleted()

void osg::ObserverSet::signalObjectDeleted

(

void *

ptr

)

Member Data Documentation

_mutex

OpenThreads::Mutex osg::ObserverSet::_mutex

mutableprotected

Referenced by getObserverSetMutex().

_observedObject

Referenced* osg::ObserverSet::_observedObject

protected

Referenced by getObserverdObject(), and getObserverdObject().

_observers

Observers osg::ObserverSet::_observers

protected

Referenced by getObservers(), and getObservers().

---

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

• osg/Observer