osg::Referenced Class Reference

Inheritance diagram for osg::Referenced:

Public Member Functions
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
virtual void	setThreadSafeRefUnref (bool threadSafe)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const

Static Public Member Functions
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()

Protected Member Functions
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Protected Attributes
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Friends
class	DeleteHandler

Detailed Description

Base class for providing reference counted objects.

Constructor & Destructor Documentation

Referenced() [1/3]

osg::Referenced::Referenced

(

)

Referenced() [2/3]

osg::Referenced::Referenced ( bool  threadSafeRefUnref )

explicit

Referenced() [3/3]

osg::Referenced::Referenced

(

const Referenced &

)

~Referenced()

virtual osg::Referenced::~Referenced ( )

protectedvirtual

Member Function Documentation

addObserver()

void osg::Referenced::addObserver

(

Observer *

observer

)

const

Add a Observer that is observing this object, notify the Observer when this object gets deleted.

deleteUsingDeleteHandler()

void osg::Referenced::deleteUsingDeleteHandler ( ) const

protected

getDeleteHandler()

static DeleteHandler* osg::Referenced::getDeleteHandler ( )

static

Get a DeleteHandler.

getGlobalReferencedMutex()

static OpenThreads::Mutex* osg::Referenced::getGlobalReferencedMutex ( )

static

Get the optional global Referenced mutex, this can be shared between all osg::Referenced.

getObserverSet()

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

inline

Get the ObserverSet if one is attached, otherwise return NULL.

getOrCreateObserverSet()

ObserverSet* osg::Referenced::getOrCreateObserverSet

(

)

const

Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.

getRefMutex()

OpenThreads::Mutex* osg::Referenced::getRefMutex ( ) const

inline

Get the mutex used to ensure thread safety of ref()/unref().

getThreadSafeReferenceCounting()

static bool osg::Referenced::getThreadSafeReferenceCounting ( )

static

Get whether reference counting is active.

getThreadSafeRefUnref()

bool osg::Referenced::getThreadSafeRefUnref ( ) const

inline

Get whether a mutex is used to ensure ref() and unref() are thread safe.

operator=()

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

inline

ref()

int osg::Referenced::ref ( ) const

inline

Increment the reference count by one, indicating that this object has another pointer which is referencing it.

referenceCount()

int osg::Referenced::referenceCount ( ) const

inline

Return the number of pointers currently referencing this object.

removeObserver()

void osg::Referenced::removeObserver

(

Observer *

observer

)

const

Remove Observer that is observing this object.

setDeleteHandler()

static void osg::Referenced::setDeleteHandler ( DeleteHandler *  handler )

static

Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.

setThreadSafeReferenceCounting()

static void osg::Referenced::setThreadSafeReferenceCounting ( bool  enableThreadSafeReferenceCounting )

static

Set whether reference counting should use a mutex for thread safe reference counting.

setThreadSafeRefUnref()

virtual void osg::Referenced::setThreadSafeRefUnref ( bool  threadSafe )

virtual

Set whether to use a mutex to ensure ref() and unref() are thread safe.

Reimplemented in osg::StateSet, osg::Node, osg::Drawable, osgText::Text, osgText::GlyphTexture, osgText::TextBase, osgText::Glyph3D, osgSim::OverlayNode::OverlayData, osgText::Font, osg::Group, osg::Geode, osgText::GlyphGeometry, osgSim::OverlayNode, osgText::Text3D, osg::Object, osg::LightSource, osg::Program, and osg::TexGenNode.

signalObserversAndDelete()

void osg::Referenced::signalObserversAndDelete ( bool  signalDelete, bool  doDelete  ) const

protected

unref()

int osg::Referenced::unref ( ) const

inline

Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. If the reference count goes to zero, it is assumed that this object is no longer referenced and is automatically deleted.

unref_nodelete()

int osg::Referenced::unref_nodelete

(

)

const

Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. However, do not delete it, even if ref count goes to 0. Warning, unref_nodelete() should only be called if the user knows exactly who will be responsible for, one should prefer unref() over unref_nodelete() as the latter can lead to memory leaks.

Friends And Related Function Documentation

DeleteHandler

friend class DeleteHandler

friend

Member Data Documentation

_observerSet

OpenThreads::AtomicPtr osg::Referenced::_observerSet

mutableprotected

_refCount

OpenThreads::Atomic osg::Referenced::_refCount

mutableprotected

---

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

• Referenced