DtComponentSystemDescriptor Class Reference

Descriptor for a DtComponentSystem. More...

Inheritance diagram for DtComponentSystemDescriptor:

Public Member Functions
	DtComponentSystemDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtComponentSystemDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentSystemDescriptor (const DtComponentSystemDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentSystemDescriptor &	operator= (const DtComponentSystemDescriptor &orig)
	assignment
virtual	~DtComponentSystemDescriptor ()
virtual void	addVariableBindingsFromMetaData ()
	Adds variable bindings that might be found in the meta data to the variable bindings of this descriptor.
virtual DtComponentSystemDescriptor *	clone () const
bool	operator== (const DtComponentSystemDescriptor &) const
virtual const DtComponentSystemDefinition *	systemDefinition () const
	The definition of the system itself.
virtual DtComponentSystemDefinition *	systemDefinition ()
	The definition of the system itself.
virtual void	resetSystemDefinition ()
	The definition of the system itself.
virtual const DtReaderWriterFile &	systemDefinitionFile () const
	The definition file.
virtual DtReaderWriterFile &	systemDefinitionFile ()
	The definition file.
virtual void	setSystemDefinitionFile (const DtFilename &)
	The definition file.
virtual bool	isEnabled () const
	Should the system be enabled or disabled upon creation.
virtual void	setIsEnabled (bool yesNo)
	Should the system be enabled or disabled upon creation.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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 (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes
DtReaderWriterFileExtensible	mySystemDefinitionFileName
DtRwBoolean	myIsEnabled
DtComponentSystemDefinition *	mySystemDefinition
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
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 DtReaderWriterFactory *	factory ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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

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

The definition of the system itself.

virtual void DtComponentSystemDescriptor::resetSystemDefinition ( )

virtual

The definition of the system itself.

virtual const DtReaderWriterFile& DtComponentSystemDescriptor::systemDefinitionFile ( ) const

virtual

The definition file.

virtual DtReaderWriterFile& DtComponentSystemDescriptor::systemDefinitionFile ( )

virtual

The definition file.

virtual void DtComponentSystemDescriptor::setSystemDefinitionFile ( const DtFilename &  )

virtual

The definition file.

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

Should the system be enabled or disabled upon creation.

virtual DtComponentSystemDescriptor* DtComponentSystemDescriptor::clone ( ) const

virtual

bool DtComponentSystemDescriptor::operator==

(

const DtComponentSystemDescriptor &

)

const

Member Data Documentation

DtReaderWriterFileExtensible DtComponentSystemDescriptor::mySystemDefinitionFileName

protected

DtRwBoolean DtComponentSystemDescriptor::myIsEnabled

protected

DtComponentSystemDefinition* DtComponentSystemDescriptor::mySystemDefinition

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/compSystemDescriptor.h