DtRwPlanSimulationObject Class Reference

The DtRwPlanSimulationObject is a variable that is used in the plan language to represent a simulation object. More...

Inheritance diagram for DtRwPlanSimulationObject:

Public Member Functions
	DtRwPlanSimulationObject (const DtString &name, const DtRwTranslatableStringObject &title, DtReaderWriterRegistry *const parentRegistry=0)
	CTOR. In order to create a UUID call generateUUID.
	DtRwPlanSimulationObject (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)
	DtRwPlanSimulationObject (const DtString &name, const DtRwPlanSimulationObject &, DtReaderWriterRegistry *const parentRegistry=0)
	Copy constructors.
	DtRwPlanSimulationObject (const DtRwPlanSimulationObject &, DtReaderWriterRegistry *const parentRegistry=0)
virtual	~DtRwPlanSimulationObject ()
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual void	setSimulationObject (const DtUUID &)
const DtUUID &	simulationObject () const
DtRwPlanSimulationObject &	operator= (const DtRwPlanSimulationObject &orig)
DtRwPlanSimulationObject &	operator= (const DtRwPlanVariable &orig)
bool	operator!= (const DtRwPlanSimulationObject &orig) const
bool	operator== (const DtRwPlanSimulationObject &orig) const
virtual const char *	xmlType () const
Public Member Functions inherited from DtRwPlanVariable
	DtRwPlanVariable (const DtString &name, const DtRwTranslatableStringObject &title, DtReaderWriterRegistry *const parentRegistry=0)
	CTOR. In order to create a UUID call generateUUID.
	DtRwPlanVariable (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)
	DtRwPlanVariable (const DtString &name, const DtRwPlanVariable &, DtReaderWriterRegistry *const parentRegistry=0)
	Copy constructors.
	DtRwPlanVariable (const DtRwPlanVariable &, DtReaderWriterRegistry *const parentRegistry=0)
virtual	~DtRwPlanVariable ()
void	setTitle (const DtRwTranslatableStringObject &)
const DtRwTranslatableStringObject &	title () const
virtual DtString	markingText () const
	Returns the translatable string.
DtRwPlanVariable &	operator= (const DtRwUUID &orig)
bool	operator!= (const DtRwPlanVariable &orig) const
bool	operator== (const DtRwPlanVariable &orig) const
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 void	setMarkingText (const DtString &)
	operator const DtUUID & () const
DtRwUUID &	operator= (const DtUUID &orig)
bool	operator!= (const DtRwUUID &orig) const
bool	operator== (const DtRwUUID &orig) const
bool	operator< (const DtRwUUID &rhs) const
bool	operator> (const DtRwUUID &rhs) const
const DtUUID &	uuid () const
DtUUID &	uuid ()
virtual void	clearUUID ()
virtual DtString	uuidString () const
virtual bool	isValid () 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 (DtlObjPtr args, const SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtVariableBindingsList())
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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 original 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 bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
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 &)
	Restores 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.

Static Public Member Functions
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.

Protected Attributes
DtRwUUID	mySimulationObject
Protected Attributes inherited from DtRwPlanVariable
DtRwTranslatableStringObject	myTitle
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.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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 )()
Protected Member Functions inherited from DtRwUUID
virtual void	noRwValueSpecified ()
	What to do if no reader/writer value is specified when restoring from file.
virtual void	uuidChanged ()
	No-op at this level.
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

The DtRwPlanSimulationObject is a variable that is used in the plan language to represent a simulation object.

This variable will be substituted when defined to be the simulation object specified. This is a simple container class

Constructor & Destructor Documentation

DtRwPlanSimulationObject::DtRwPlanSimulationObject	(	const DtString &	name,
		const DtRwTranslatableStringObject &	title,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

CTOR. In order to create a UUID call generateUUID.

DtRwPlanSimulationObject::DtRwPlanSimulationObject	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

DtRwPlanSimulationObject::DtRwPlanSimulationObject	(	const DtString &	name,
		const DtRwPlanSimulationObject &	,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

Copy constructors.

DtRwPlanSimulationObject::DtRwPlanSimulationObject	(	const DtRwPlanSimulationObject &	,
		DtReaderWriterRegistry *const	parentRegistry = 0
	)

virtual DtRwPlanSimulationObject::~DtRwPlanSimulationObject ( )

virtual

Member Function Documentation

virtual const char* DtRwPlanSimulationObject::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtRwUUID.

virtual void DtRwPlanSimulationObject::setSimulationObject ( const DtUUID &  )

virtual

const DtUUID& DtRwPlanSimulationObject::simulationObject ( ) const

inline

static const char* DtRwPlanSimulationObject::theXmlType ( )

static

The type that is used when archiving to an XML stream.

Reimplemented from DtRwUUID.

DtRwPlanSimulationObject& DtRwPlanSimulationObject::operator=

(

const DtRwPlanSimulationObject &

orig

)

DtRwPlanSimulationObject& DtRwPlanSimulationObject::operator= ( const DtRwPlanVariable &  orig )

inline

Reimplemented from DtRwPlanVariable.

References DtRwPlanVariable::operator=().

bool DtRwPlanSimulationObject::operator!= ( const DtRwPlanSimulationObject &  orig ) const

inline

bool DtRwPlanSimulationObject::operator==

(

const DtRwPlanSimulationObject &

orig

)

const

virtual const char* DtRwPlanSimulationObject::xmlType ( ) const

inlinevirtual

Reimplemented from DtRwUUID.

References DtRwUUID::theXmlType().

Member Data Documentation

DtRwUUID DtRwPlanSimulationObject::mySimulationObject

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfutil/rwPlanSimulationObject.h