DtRwAffectableEngineeringObject holds a the information needed to know how a unit may create a type of engineering object. More...

Inheritance diagram for DtRwAffectableEngineeringObject:

[legend]

Public Member Functions
	DtRwAffectableEngineeringObject (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtRwAffectableEngineeringObject ()
	destructor
	DtRwAffectableEngineeringObject (const DtRwAffectableEngineeringObject &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtRwAffectableEngineeringObject &	operator= (const DtRwAffectableEngineeringObject &orig)
	assignment operator: assigns value only
bool	operator< (const DtRwAffectableEngineeringObject &rhs)
bool	operator< (const DtObjectType &rhs)
bool	operator== (const DtRwAffectableEngineeringObject &rhs) const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.

virtual const DtObjectType &	objectType () const
	Get/set the object type.
virtual void	setObjectType (const DtObjectType &)

virtual double	timeToComplete () const
	Get/set the time (s) to create this object type.
virtual void	setTimeToComplete (double)

virtual double	timeToSetup () const
	Get/set the time (s) to setup to create.
virtual void	setTimeToSetup (double)

virtual double	range () const
	Get/set the creation range (m) for this object type.
virtual void	setRange (double)

virtual const DtString &	destructionResource () const
	Get/set the resource required to destroy (or breach) this object type.
virtual void	setDestructionResource (const DtString &)

virtual double	destructionResourceAmount () const
	Get/set the amount of resources required to destroy (or breach) this object type.
virtual void	setDestructionResourceAmount (double)

virtual const DtString &	createScriptId () const
	Get/set the name of the script ID to create this object type.
virtual void	setCreateScriptId (const DtString &)

virtual const DtString &	improveScriptId () const
	Get/set the name of the script ID to improve this object type.
virtual void	setImproveScriptId (const DtString &)

virtual const DtString &	destroyScriptId () const
	Get/set the name of the script ID to destroy this object type.
virtual void	setDestroyScriptId (const DtString &)

virtual const DtString &	prohibitedTerrainQueryName () const
	Get/set the name of the feature query which indicates terrain that it is prohibited to create this object on.
virtual void	setProhibitedTerrainQueryName (const DtString &)
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	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	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 const char *	xmlType () const
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 void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
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	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
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 Attributes
DtRwObjectType	myObjectType
DtRwReal	myTimeToComplete
DtRwReal	myTimeToSetup
DtRwReal	myRange
DtRwString	myDestructionResource
DtRwReal	myDestructionResourceAmount
DtRwString	myCreateScriptId
DtRwString	myImproveScriptId
DtRwString	myDestroyScriptId
DtRwString	myProhibitedTerrainQueryName
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 )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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

DtRwAffectableEngineeringObject holds a the information needed to know how a unit may create a type of engineering object.

Constructor & Destructor Documentation

DtRwAffectableEngineeringObject::DtRwAffectableEngineeringObject	(	const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

virtual DtRwAffectableEngineeringObject::~DtRwAffectableEngineeringObject ( )

virtual

destructor

DtRwAffectableEngineeringObject::DtRwAffectableEngineeringObject	(	const DtRwAffectableEngineeringObject &	orig,
		const DtString &	name = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

Member Function Documentation

DtRwAffectableEngineeringObject& DtRwAffectableEngineeringObject::operator= ( const DtRwAffectableEngineeringObject & orig )

assignment operator: assigns value only

bool DtRwAffectableEngineeringObject::operator< ( const DtRwAffectableEngineeringObject & rhs )

inline

References myObjectType.

bool DtRwAffectableEngineeringObject::operator< ( const DtObjectType & rhs )

inline

bool DtRwAffectableEngineeringObject::operator== ( const DtRwAffectableEngineeringObject & rhs ) const

inline

References myCreateScriptId, myDestroyScriptId, myDestructionResource, myDestructionResourceAmount, myImproveScriptId, myObjectType, myProhibitedTerrainQueryName, myRange, myTimeToComplete, and myTimeToSetup.

virtual const char* DtRwAffectableEngineeringObject::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 DtReaderWriter.

virtual const DtObjectType& DtRwAffectableEngineeringObject::objectType ( ) const

virtual

Get/set the object type.

virtual void DtRwAffectableEngineeringObject::setObjectType ( const DtObjectType & )

virtual

virtual double DtRwAffectableEngineeringObject::timeToComplete ( ) const

virtual

Get/set the time (s) to create this object type.

virtual void DtRwAffectableEngineeringObject::setTimeToComplete ( double )

virtual

virtual double DtRwAffectableEngineeringObject::timeToSetup ( ) const

virtual

Get/set the time (s) to setup to create.

virtual void DtRwAffectableEngineeringObject::setTimeToSetup ( double )

virtual

virtual double DtRwAffectableEngineeringObject::range ( ) const

virtual

Get/set the creation range (m) for this object type.

virtual void DtRwAffectableEngineeringObject::setRange ( double )

virtual

virtual const DtString& DtRwAffectableEngineeringObject::destructionResource ( ) const

virtual

Get/set the resource required to destroy (or breach) this object type.

virtual void DtRwAffectableEngineeringObject::setDestructionResource ( const DtString & )

virtual

virtual double DtRwAffectableEngineeringObject::destructionResourceAmount ( ) const

virtual

Get/set the amount of resources required to destroy (or breach) this object type.

virtual void DtRwAffectableEngineeringObject::setDestructionResourceAmount ( double )

virtual

virtual const DtString& DtRwAffectableEngineeringObject::createScriptId ( ) const

virtual

Get/set the name of the script ID to create this object type.

virtual void DtRwAffectableEngineeringObject::setCreateScriptId ( const DtString & )

virtual

virtual const DtString& DtRwAffectableEngineeringObject::improveScriptId ( ) const

virtual

Get/set the name of the script ID to improve this object type.

virtual void DtRwAffectableEngineeringObject::setImproveScriptId ( const DtString & )

virtual

virtual const DtString& DtRwAffectableEngineeringObject::destroyScriptId ( ) const

virtual

Get/set the name of the script ID to destroy this object type.

virtual void DtRwAffectableEngineeringObject::setDestroyScriptId ( const DtString & )

virtual

virtual const DtString& DtRwAffectableEngineeringObject::prohibitedTerrainQueryName ( ) const

virtual

Get/set the name of the feature query which indicates terrain that it is prohibited to create this object on.

virtual void DtRwAffectableEngineeringObject::setProhibitedTerrainQueryName ( const DtString & )

virtual

Member Data Documentation

DtRwObjectType DtRwAffectableEngineeringObject::myObjectType

protected

Referenced by operator<(), and operator==().

DtRwReal DtRwAffectableEngineeringObject::myTimeToComplete

protected

Referenced by operator==().

DtRwReal DtRwAffectableEngineeringObject::myTimeToSetup

protected

Referenced by operator==().

DtRwReal DtRwAffectableEngineeringObject::myRange

protected

Referenced by operator==().

DtRwString DtRwAffectableEngineeringObject::myDestructionResource

protected

Referenced by operator==().

DtRwReal DtRwAffectableEngineeringObject::myDestructionResourceAmount

protected

Referenced by operator==().

DtRwString DtRwAffectableEngineeringObject::myCreateScriptId

protected

Referenced by operator==().

DtRwString DtRwAffectableEngineeringObject::myImproveScriptId

protected

Referenced by operator==().

DtRwString DtRwAffectableEngineeringObject::myDestroyScriptId

protected

Referenced by operator==().

DtRwString DtRwAffectableEngineeringObject::myProhibitedTerrainQueryName

protected

Referenced by operator==().

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation