DtVrfObjectReference Class Reference

Class used to track an object, or, to supply information (UUID, entity identifier, etc) about an object, and, if this object does not exist, will add a callback with the object manager for when that particular object is discovered. More...

Public Member Functions
	DtVrfObjectReference ()
	Only use this CTOR as a placeholder for returning the fact that this object will never exist.
	DtVrfObjectReference (DtVrfObject *object)
	CTOR.
	DtVrfObjectReference (const DtString &objectNameToWaitFor)
	DtVrfObjectReference (const DtUUID &objectUUIDToWaitFor)
	DtVrfObjectReference (const DtRwUUID &objectUUIDToWaitFor)
	DtVrfObjectReference (const DtEntityIdentifier &objectUUIDToWaitFor)
virtual	~DtVrfObjectReference ()
const DtVrfObject *	object () const
DtVrfObject *	object ()
	operator DtVrfObject * ()
	operator const DtVrfObject * () const
virtual bool	isValid () const
virtual bool	hasBeenDeleted () const
virtual const DtString &	waitingForName () const
virtual void	registerRemovedCallback ()
virtual DtUUID	uuid () const
virtual void	addObjectDiscoveredCallback (DtNoArgumentCallbackList::DtCallbackFunctionType, void *usr)
virtual void	removeObjectDiscoveredCallback (DtNoArgumentCallbackList::DtCallbackFunctionType, void *usr)
virtual void	addObjectAboutToBeRemovedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType, void *usr)
virtual void	removeObjectAboutToBeRemovedCallback (DtNoArgumentCallbackList::DtCallbackFunctionType, void *usr)

Static Public Member Functions
static void	setVrfObjectManager (DtVrfObjectManager *)
static DtVrfObjectManager *	vrfObjectManager ()

Protected Member Functions
virtual void	processObjectAdded (DtVrfObject *)
virtual void	processObjectAboutToBeRemoved (DtVrfObject *)

Static Protected Member Functions
static void	objectAddedCallback (DtVrfObject *, void *)
static void	objectAboutToBeRemovedCallback (DtVrfObject *, void *)

Protected Attributes
DtVrfObject *	myObject
DtString	myWaitingForName
DtVrfObjectDeletionHandle	myObjectDeletionHandle
DtNoArgumentCallbackList	myObjectDiscoveredCallbacks
DtNoArgumentCallbackList	myObjectAboutToBeRemovedCallbacks
bool	myRemoveRegistered

Static Protected Attributes
static DtVrfObjectManager *	theVrfObjectManager

Private Member Functions
	DtVrfObjectReference (const DtVrfObjectReference &)
	Copying not allowed.
DtVrfObjectReference &	operator= (const DtVrfObjectReference &)

Detailed Description

Class used to track an object, or, to supply information (UUID, entity identifier, etc) about an object, and, if this object does not exist, will add a callback with the object manager for when that particular object is discovered.

If the object of this class is 0 then the object has been removed from the system

Constructor & Destructor Documentation

DtVrfObjectReference::DtVrfObjectReference

(

)

Only use this CTOR as a placeholder for returning the fact that this object will never exist.

DtVrfObjectReference::DtVrfObjectReference

(

DtVrfObject *

object

)

CTOR.

If object does not exist uses the object manager until the requested object does exist

DtVrfObjectReference::DtVrfObjectReference

(

const DtString &

objectNameToWaitFor

)

DtVrfObjectReference::DtVrfObjectReference

(

const DtUUID &

objectUUIDToWaitFor

)

DtVrfObjectReference::DtVrfObjectReference

(

const DtRwUUID &

objectUUIDToWaitFor

)

DtVrfObjectReference::DtVrfObjectReference

(

const DtEntityIdentifier &

objectUUIDToWaitFor

)

virtual DtVrfObjectReference::~DtVrfObjectReference ( )

virtual

DtVrfObjectReference::DtVrfObjectReference ( const DtVrfObjectReference &  )

private

Copying not allowed.

Member Function Documentation

const DtVrfObject* DtVrfObjectReference::object

(

)

const

DtVrfObject* DtVrfObjectReference::object

(

)

DtVrfObjectReference::operator DtVrfObject * ( )

inline

DtVrfObjectReference::operator const DtVrfObject * ( ) const

inline

virtual bool DtVrfObjectReference::isValid ( ) const

virtual

static void DtVrfObjectReference::setVrfObjectManager ( DtVrfObjectManager *  )

static

static DtVrfObjectManager* DtVrfObjectReference::vrfObjectManager ( )

static

virtual bool DtVrfObjectReference::hasBeenDeleted ( ) const

virtual

virtual const DtString& DtVrfObjectReference::waitingForName ( ) const

virtual

virtual void DtVrfObjectReference::registerRemovedCallback ( )

virtual

virtual DtUUID DtVrfObjectReference::uuid ( ) const

virtual

virtual void DtVrfObjectReference::addObjectDiscoveredCallback ( DtNoArgumentCallbackList::DtCallbackFunctionType  , void *  usr  )

virtual

virtual void DtVrfObjectReference::removeObjectDiscoveredCallback ( DtNoArgumentCallbackList::DtCallbackFunctionType  , void *  usr  )

virtual

virtual void DtVrfObjectReference::addObjectAboutToBeRemovedCallback ( DtNoArgumentCallbackList::DtCallbackFunctionType  , void *  usr  )

virtual

virtual void DtVrfObjectReference::removeObjectAboutToBeRemovedCallback ( DtNoArgumentCallbackList::DtCallbackFunctionType  , void *  usr  )

virtual

static void DtVrfObjectReference::objectAddedCallback ( DtVrfObject *  , void *    )

staticprotected

virtual void DtVrfObjectReference::processObjectAdded ( DtVrfObject *  )

protectedvirtual

static void DtVrfObjectReference::objectAboutToBeRemovedCallback ( DtVrfObject *  , void *    )

staticprotected

virtual void DtVrfObjectReference::processObjectAboutToBeRemoved ( DtVrfObject *  )

protectedvirtual

DtVrfObjectReference& DtVrfObjectReference::operator= ( const DtVrfObjectReference &  )

private

Member Data Documentation

DtVrfObject* DtVrfObjectReference::myObject

protected

DtString DtVrfObjectReference::myWaitingForName

protected

DtVrfObjectDeletionHandle DtVrfObjectReference::myObjectDeletionHandle

protected

DtNoArgumentCallbackList DtVrfObjectReference::myObjectDiscoveredCallbacks

protected

DtNoArgumentCallbackList DtVrfObjectReference::myObjectAboutToBeRemovedCallbacks

protected

bool DtVrfObjectReference::myRemoveRegistered

protected

DtVrfObjectManager* DtVrfObjectReference::theVrfObjectManager

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/vrfObjectReference.h