DtComponentSystemDescriptor Class Reference

Descriptor for a DtComponentSystem. More...

Inheritance diagram for DtComponentSystemDescriptor:

Public Member Functions
	DtComponentSystemDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor More...
	DtComponentSystemDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentSystemDescriptor (const DtComponentSystemDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
DtComponentSystemDescriptor &	operator= (const DtComponentSystemDescriptor &orig)
	assignment More...
virtual	~DtComponentSystemDescriptor ()
virtual void	addVariableBindingsFromMetaData ()
	Adds variable bindings that might be found in the meta data to the variable bindings of this descriptor. More...
virtual DtComponentSystemDescriptor *	clone () const
bool	operator== (const DtComponentSystemDescriptor &) const
virtual const DtComponentSystemDefinition *	systemDefinition () const
	The definition of the system itself. More...
virtual DtComponentSystemDefinition *	systemDefinition ()
virtual void	resetSystemDefinition ()
virtual const DtReaderWriterFile &	systemDefinitionFile () const
	The definition file. More...
virtual DtReaderWriterFile &	systemDefinitionFile ()
virtual void	setSystemDefinitionFile (const DtFilename &)
virtual bool	isEnabled () const
	Should the system be enabled or disabled upon creation. More...
virtual void	setIsEnabled (bool yesNo)
virtual bool	canBeDisabled () const
	Can the system be disabled. If this is a template system will return false all the time. More...
virtual void	setCanBeDisabled (bool yesNo)
virtual bool	isTemplate () const
	Is this a template system. More...
virtual void	setIsTemplate (bool yesNo)
virtual bool	partOfRollUp () const
	Was added as part of roll-up. More...
virtual void	setPartOfRollUp (bool yesNo)
virtual void	setUseParentSystemResourceManager (bool)
	Accessor/mutator for myUseParentSystemResourceManager. More...
virtual bool	useParentSystemResourceManager () const
virtual void	setCompareSystemDefinition (bool)
bool	compareSystemDefinition () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...
bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor More...
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. More...
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...
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. More...
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...
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. More...
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. More...
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...
virtual void	setName (const DtString &)
	Set the name of the object. More...
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...
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. More...
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...
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. More...
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...
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. More...
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...
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. More...
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
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. More...
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...
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. More...
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. More...
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Protected Member Functions
virtual void	preGetSelf ()
	Override to deal with system names so they get restored correctly. More...
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Attributes
DtReaderWriterFileExtensible	mySystemDefinitionFileName
DtRwBoolean	myIsEnabled
DtRwBoolean	myPartOfRollUp
DtComponentSystemDefinition *	mySystemDefinition
DtRwBoolean	myUseParentSystemResourceManager
	If this is true uses the paren system's resource manager. More...
bool	myCompareSystemDefinition
	Whether or not to walk the chain and compare included system definitions. Default is true. More...
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. More...
bool	myInvalid
	Set to true if there is a problem reading this item. More...
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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. More...
static const DtFilename &	appPath ()
	Gets the current working directory. More...
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...
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
static DtOutputStream *	theOutputStream

Detailed Description

Descriptor for a DtComponentSystem.

Specified a system being added to an entity. This does not actually define what is in the system. For that, see DtComponentSystemDefinition.

Constructor & Destructor Documentation

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

real constructor

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

DtComponentSystemDescriptor::DtComponentSystemDescriptor	(	const DtComponentSystemDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtComponentSystemDescriptor::~DtComponentSystemDescriptor ( )

virtual

Member Function Documentation

DtComponentSystemDescriptor& DtComponentSystemDescriptor::operator=

(

const DtComponentSystemDescriptor &

orig

)

assignment

virtual const DtComponentSystemDefinition* DtComponentSystemDescriptor::systemDefinition ( ) const

virtual

The definition of the system itself.

virtual DtComponentSystemDefinition* DtComponentSystemDescriptor::systemDefinition ( )

virtual

virtual void DtComponentSystemDescriptor::resetSystemDefinition ( )

virtual

virtual const DtReaderWriterFile& DtComponentSystemDescriptor::systemDefinitionFile ( ) const

virtual

The definition file.

virtual DtReaderWriterFile& DtComponentSystemDescriptor::systemDefinitionFile ( )

virtual

virtual void DtComponentSystemDescriptor::setSystemDefinitionFile ( const DtFilename &  )

virtual

virtual void DtComponentSystemDescriptor::addVariableBindingsFromMetaData ( )

virtual

Adds variable bindings that might be found in the meta data to the variable bindings of this descriptor.

This must be called if the variable bindings are to be added as this is not called as a function of loading the system definition file

virtual bool DtComponentSystemDescriptor::isEnabled ( ) const

virtual

Should the system be enabled or disabled upon creation.

virtual void DtComponentSystemDescriptor::setIsEnabled ( bool  yesNo )

virtual

virtual bool DtComponentSystemDescriptor::canBeDisabled ( ) const

virtual

Can the system be disabled. If this is a template system will return false all the time.

virtual void DtComponentSystemDescriptor::setCanBeDisabled ( bool  yesNo )

virtual

virtual bool DtComponentSystemDescriptor::isTemplate ( ) const

virtual

Is this a template system.

virtual void DtComponentSystemDescriptor::setIsTemplate ( bool  yesNo )

virtual

virtual bool DtComponentSystemDescriptor::partOfRollUp ( ) const

virtual

Was added as part of roll-up.

Any system that was added as part of a roll-up when the roll-up happens in the entity editor will be removed.

virtual void DtComponentSystemDescriptor::setPartOfRollUp ( bool  yesNo )

virtual

virtual void DtComponentSystemDescriptor::setUseParentSystemResourceManager ( bool  )

virtual

Accessor/mutator for myUseParentSystemResourceManager.

virtual bool DtComponentSystemDescriptor::useParentSystemResourceManager ( ) const

virtual

virtual DtComponentSystemDescriptor* DtComponentSystemDescriptor::clone ( ) const

virtual

bool DtComponentSystemDescriptor::operator==

(

const DtComponentSystemDescriptor &

)

const

virtual void DtComponentSystemDescriptor::setCompareSystemDefinition ( bool  )

virtual

Accessor/mutator for myCompareSystemDefinition

bool DtComponentSystemDescriptor::compareSystemDefinition

(

)

const

virtual void DtComponentSystemDescriptor::preGetSelf ( )

protectedvirtual

Override to deal with system names so they get restored correctly.

Reimplemented from DtReaderWriter.

virtual void DtComponentSystemDescriptor::postGetSelf ( )

protectedvirtual

Called after either version of getSelf (mtl or environment). Default is no-op.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtReaderWriterFileExtensible DtComponentSystemDescriptor::mySystemDefinitionFileName

protected

DtRwBoolean DtComponentSystemDescriptor::myIsEnabled

protected

DtRwBoolean DtComponentSystemDescriptor::myPartOfRollUp

protected

DtComponentSystemDefinition* DtComponentSystemDescriptor::mySystemDefinition

protected

DtRwBoolean DtComponentSystemDescriptor::myUseParentSystemResourceManager

protected

If this is true uses the paren system's resource manager.

By default is false. This is done such that systems included as part of the new template system can be backwards compatible with existing scenario and scripts by adding the resources to the parent system rather than it's own, which is what is done pre 4.7. This means that without this flag, if a system includes another system that has a resource manager (i.e. a Hellfile) the resource would be listes as weapon|laser-guides|Hellfire rather than what is used to be which is weapon|Hellfire.

bool DtComponentSystemDescriptor::myCompareSystemDefinition

protected

Whether or not to walk the chain and compare included system definitions. Default is true.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjparam/componentSystemDescriptor.h