DtRwVrfObjectReference Class Reference

Class used as the reader/writer implementation of the DtVrfObjectReference. More...

Inheritance diagram for DtRwVrfObjectReference:

Public Member Functions
	DtRwVrfObjectReference ()
	CTOR.
	DtRwVrfObjectReference (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwVrfObjectReference (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwVrfObjectReference (const DtString &, const DtUUID &, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwVrfObjectReference (const DtSymbolString &, const DtUUID &, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwVrfObjectReference (const DtString &, const DtRwUUID &, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwVrfObjectReference (const DtSymbolString &, const DtRwUUID &, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwVrfObjectReference (const DtRwVrfObjectReference &, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwVrfObjectReference ()
virtual void	setUUID (const DtUUID &)
	Sets the UUID of the object.
virtual bool	isValid () const
	Returns true if this object is valid.
virtual bool	hasBeenDeleted () const
virtual const DtVrfObject *	object () const
	Returns the object this represents.
virtual DtVrfObject *	object ()
	operator DtVrfObject * ()
	operator const DtVrfObject * () 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)
virtual void	setObjectReference (DtSharedVrfObjectReference)
	Sets the object reference to be used by this class. Will replace current UUID and reference.
DtRwVrfObjectReference &	operator= (const DtRwVrfObjectReference &)
DtRwVrfObjectReference &	operator= (const DtSharedVrfObjectReference &)
virtual void	clearObjectReference ()
	Clears out object reference used by this RW.
DtVrfObject *	operator-> ()
	Returns the object this represents.
const DtVrfObject *	operator-> () const
	operator const DtUUID & () const
virtual DtEntityIdentifier	entityIdentifier () const
virtual DtGlobalObjectDesignator	globalObjectDesignator () const
DtSharedVrfObjectReference	objectReference ()
DtSharedVrfObjectReference	objectReference () const
virtual void	clearUUID ()
	Clears out UUID and current object being pointed to.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Will see what ID to look for (name or UUID) and then find the object in the object manager.
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Update self to write out UUID (if available)
Public Member Functions inherited from DtRwUUID
	DtRwUUID ()
	CTOR. In order to create a UUID call generateUUID.
	DtRwUUID (const char *name, DtReaderWriterRegistry *const parentRegistry=0)
	DtRwUUID (const DtString &name, DtReaderWriterRegistry *const parentRegistry)
	DtRwUUID (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry)
	DtRwUUID (const DtString &name, const DtRwUUID &, DtReaderWriterRegistry *const parentRegistry)
	Copy constructors.
	DtRwUUID (const DtSymbolString &name, const DtRwUUID &, DtReaderWriterRegistry *const parentRegistry)
	DtRwUUID (const DtSymbolString &name, const DtUUID &, DtReaderWriterRegistry *const parentRegistry)
	DtRwUUID (const DtString &name, const DtUUID &, DtReaderWriterRegistry *const parentRegistry)
	DtRwUUID (const DtString &name, const char *, DtReaderWriterRegistry *const parentRegistry)
	DtRwUUID (const DtSymbolString &name, const char *, DtReaderWriterRegistry *const parentRegistry)
	DtRwUUID (const DtRwUUID &, DtReaderWriterRegistry *const parentRegistry)
	DtRwUUID (const DtRwUUID &)
	DtRwUUID (const DtUUID &)
virtual	~DtRwUUID ()
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual void	setMarkingText (const DtString &)
virtual DtString	markingText () const
DtRwUUID &	operator= (const DtRwUUID &orig)
DtRwUUID &	operator= (const DtUUID &orig)
bool	operator!= (const DtRwUUID &orig) const
bool	operator== (const DtRwUUID &orig) const
virtual const char *	xmlType () const
const DtUUID &	uuid () const
DtUUID &	uuid ()
virtual DtString	uuidString () const
virtual void	generateUUID ()
virtual void	setUUID (const DtRwUUID &u)
virtual void	setUUID (const DtString &uuid)
virtual void	setStringUUID (const DtString &uuid)
virtual bool	isVrfUUID () const
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	getSelf (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &varBindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	putSelf (DtEnvironmentSP env, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putData (std::string &fp, int)
	Deriving class overrides these to get/put class specific data.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Member Functions
virtual void	processObjectDiscovered ()
virtual void	processObjectAboutToBeRemoved ()
virtual void	uuidChanged ()
	Called when UUID has changed – look up object again.
Protected Member Functions inherited from DtRwUUID
virtual void	noRwValueSpecified ()
	What to do if no reader/writer value is specified when restoring from file.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Static Protected Member Functions
static void	objectDiscoveredCallback (void *usr)
static void	objectAboutToBeRemovedCallback (void *usr)

Protected Attributes
DtSharedVrfObjectReference	myObject
bool	myAddedRemovedCallback
bool	myAddedDiscoveredCallback
Protected Attributes inherited from DtRwUUID
DtUUID	myUUID
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtRwUUID
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent

Detailed Description

Class used as the reader/writer implementation of the DtVrfObjectReference.

Use this class to be able to archive object information and automatically reload those objects when the object is restored

Constructor & Destructor Documentation

DtRwVrfObjectReference::DtRwVrfObjectReference

(

)

CTOR.

DtRwVrfObjectReference::DtRwVrfObjectReference	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwVrfObjectReference::DtRwVrfObjectReference	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwVrfObjectReference::DtRwVrfObjectReference	(	const DtString &	,
		const DtUUID &	,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwVrfObjectReference::DtRwVrfObjectReference	(	const DtSymbolString &	,
		const DtUUID &	,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwVrfObjectReference::DtRwVrfObjectReference	(	const DtString &	,
		const DtRwUUID &	,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwVrfObjectReference::DtRwVrfObjectReference	(	const DtSymbolString &	,
		const DtRwUUID &	,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtRwVrfObjectReference::DtRwVrfObjectReference	(	const DtRwVrfObjectReference &	,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtRwVrfObjectReference::~DtRwVrfObjectReference ( )

virtual

Member Function Documentation

virtual void DtRwVrfObjectReference::setUUID ( const DtUUID &  )

virtual

Sets the UUID of the object.

If different than the current UUID will replace the currently stored object with the new one

virtual bool DtRwVrfObjectReference::isValid ( ) const

virtual

Returns true if this object is valid.

Reimplemented from DtRwUUID.

virtual bool DtRwVrfObjectReference::hasBeenDeleted ( ) const

virtual

virtual const DtVrfObject* DtRwVrfObjectReference::object ( ) const

virtual

Returns the object this represents.

virtual DtVrfObject* DtRwVrfObjectReference::object ( )

virtual

DtRwVrfObjectReference::operator DtVrfObject * ( )

inline

DtRwVrfObjectReference::operator const DtVrfObject * ( ) const

inline

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

virtual

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

virtual

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

virtual

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

virtual

virtual void DtRwVrfObjectReference::setObjectReference ( DtSharedVrfObjectReference  )

virtual

Sets the object reference to be used by this class. Will replace current UUID and reference.

DtRwVrfObjectReference& DtRwVrfObjectReference::operator=

(

const DtRwVrfObjectReference &

)

DtRwVrfObjectReference& DtRwVrfObjectReference::operator=

(

const DtSharedVrfObjectReference &

)

virtual void DtRwVrfObjectReference::clearObjectReference ( )

virtual

Clears out object reference used by this RW.

DtVrfObject* DtRwVrfObjectReference::operator->

(

)

Returns the object this represents.

Be sure to call isValid() first to ensure that this object is valid

const DtVrfObject* DtRwVrfObjectReference::operator->

(

)

const

DtRwVrfObjectReference::operator const DtUUID & ( ) const

inline

Reimplemented from DtRwUUID.

References DtRwUUID::uuid().

virtual DtEntityIdentifier DtRwVrfObjectReference::entityIdentifier ( ) const

virtual

virtual DtGlobalObjectDesignator DtRwVrfObjectReference::globalObjectDesignator ( ) const

virtual

DtSharedVrfObjectReference DtRwVrfObjectReference::objectReference

(

)

DtSharedVrfObjectReference DtRwVrfObjectReference::objectReference

(

)

const

virtual void DtRwVrfObjectReference::clearUUID ( )

virtual

Clears out UUID and current object being pointed to.

Reimplemented from DtRwUUID.

virtual void DtRwVrfObjectReference::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths = SearchPaths(), const DtVariableBindingsList &  variableBindings = nullVariableReference()  )

virtual

Will see what ID to look for (name or UUID) and then find the object in the object manager.

Reimplemented from DtRwUUID.

virtual void DtRwVrfObjectReference::putSelf ( std::string &  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtFilename::nullFilename()  )

virtual

Update self to write out UUID (if available)

Reimplemented from DtRwUUID.

static void DtRwVrfObjectReference::objectDiscoveredCallback ( void *  usr )

staticprotected

virtual void DtRwVrfObjectReference::processObjectDiscovered ( )

protectedvirtual

static void DtRwVrfObjectReference::objectAboutToBeRemovedCallback ( void *  usr )

staticprotected

virtual void DtRwVrfObjectReference::processObjectAboutToBeRemoved ( )

protectedvirtual

virtual void DtRwVrfObjectReference::uuidChanged ( )

protectedvirtual

Called when UUID has changed – look up object again.

Reimplemented from DtRwUUID.

Member Data Documentation

DtSharedVrfObjectReference DtRwVrfObjectReference::myObject

protected

bool DtRwVrfObjectReference::myAddedRemovedCallback

protected

bool DtRwVrfObjectReference::myAddedDiscoveredCallback

protected

---

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

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