OpenSceneGraph 3.6.5
osg::Identifier Class Reference

Unique Identifier class to help with efficiently comparing road classification or region via pointers. More...

#include <Identifier>

Inheritance diagram for osg::Identifier:

Public Member Functions

const std::string & name () const
const int & number () 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 &)
Referencedoperator= (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.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () 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.
Public Member Functions inherited from osg::Observer
 Observer ()
virtual ~Observer ()

Static Public Member Functions

static Identifierget (const std::string &name, int number=0, osg::Referenced *first=0, osg::Referenced *second=0)
static Identifierget (int number, osg::Referenced *first=0, osg::Referenced *second=0)
static Identifierget (osg::Referenced *first, osg::Referenced *second=0)
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 DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

Protected Member Functions

 Identifier (const std::string &name, int number, osg::Referenced *f, osg::Referenced *s)
virtual ~Identifier ()
virtual void objectDeleted (void *ptr)
 objectDeleted is called when the observed object is about to be deleted.
Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

std::string _name
int _number
osg::Referenced_first
osg::Referenced_second
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Detailed Description

Unique Identifier class to help with efficiently comparing road classification or region via pointers.

Constructor & Destructor Documentation

◆ Identifier()

osg::Identifier::Identifier ( const std::string & name,
int number,
osg::Referenced * f,
osg::Referenced * s )
protected

References name(), and number().

Referenced by get(), get(), and get().

◆ ~Identifier()

virtual osg::Identifier::~Identifier ( )
protectedvirtual

Member Function Documentation

◆ get() [1/3]

Identifier * osg::Identifier::get ( const std::string & name,
int number = 0,
osg::Referenced * first = 0,
osg::Referenced * second = 0 )
static

References Identifier(), name(), and number().

◆ get() [2/3]

Identifier * osg::Identifier::get ( int number,
osg::Referenced * first = 0,
osg::Referenced * second = 0 )
static

References Identifier(), and number().

◆ get() [3/3]

Identifier * osg::Identifier::get ( osg::Referenced * first,
osg::Referenced * second = 0 )
static

References Identifier().

◆ name()

const std::string & osg::Identifier::name ( ) const
inline

References _name.

Referenced by get(), and Identifier().

◆ number()

const int & osg::Identifier::number ( ) const
inline

References _number.

Referenced by get(), get(), and Identifier().

◆ objectDeleted()

virtual void osg::Identifier::objectDeleted ( void * )
protectedvirtual

objectDeleted is called when the observed object is about to be deleted.

The observer will be automatically removed from the observed object's observer set so there is no need for the objectDeleted implementation to call removeObserver() on the observed object.

Reimplemented from osg::Observer.

Member Data Documentation

◆ _first

osg::Referenced* osg::Identifier::_first
protected

◆ _name

std::string osg::Identifier::_name
protected

Referenced by name().

◆ _number

int osg::Identifier::_number
protected

Referenced by number().

◆ _second

osg::Referenced* osg::Identifier::_second
protected

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

osg logo
Generated at Sun Jul 27 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.