DtComponentSystemDefinition Class Reference

DtComponentSystemDefinition. More...

Inheritance diagram for DtComponentSystemDefinition:

Public Member Functions
	DtComponentSystemDefinition (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	read/writable constructor
	DtComponentSystemDefinition (const DtComponentSystemDefinition &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtComponentSystemDefinition &	operator= (const DtComponentSystemDefinition &orig)
	assignment operator
virtual	~DtComponentSystemDefinition ()
	destructor
virtual const DtComponentSystemDescriptorList &	systemDescriptorList () const
	See mySystemDescriptorList.
virtual void	setSystemDescriptorList (const DtComponentSystemDescriptorList &list)
	See mySystemDescriptorList.
virtual const DtComponentDescriptorList &	sensorDescriptorList () const
	Accessor/mutator for mySensorDescriptorList.
virtual void	setSensorDescriptorList (const DtComponentDescriptorList &list)
	Accessor/mutator for mySensorDescriptorList.
virtual const DtComponentDescriptorList &	controllerDescriptorList () const
	Accessor/mutator for myControllerDescriptorList.
virtual void	setControllerDescriptorList (const DtComponentDescriptorList &list)
	Accessor/mutator for myControllerDescriptorList.
virtual const DtComponentDescriptorList &	actuatorDescriptorList () const
	Accessor/mutator for myActuatorDescriptorList.
virtual void	setActuatorDescriptorList (const DtComponentDescriptorList &list)
	Accessor/mutator for myActuatorDescriptorList.
virtual const DtConnectionDescriptorList &	connectionDescriptorList () const
	Accessor/mutator for myConnectionDescriptorList.
virtual void	setConnectionDescriptorList (const DtConnectionDescriptorList &list)
	Accessor/mutator for myConnectionDescriptorList.
virtual const DtSimResourceManager &	resources () const
	List of resources defined for this system.
virtual DtSimResourceManager &	resources ()
	List of resources defined for this system.
virtual void	setResources (const DtSimResourceManager &)
	List of resources defined for this system.
virtual const DtComponentSystemMetaData &	metaData () const
	Metadata about the system.
virtual DtComponentSystemMetaData &	metaData ()
	Metadata about the system.
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
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 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
DtComponentSystemDescriptorList	mySystemDescriptorList
DtComponentDescriptorList	mySensorDescriptorList
DtComponentDescriptorList	myControllerDescriptorList
DtComponentDescriptorList	myActuatorDescriptorList
DtConnectionDescriptorList	myConnectionDescriptorList
DtSimResourceManager	myResources
DtComponentSystemMetaData	myMetaData
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.

Private Member Functions
	DtComponentSystemDefinition ()
	Not implemented.

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
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 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 DtReaderWriterFactory	theFactory

Detailed Description

DtComponentSystemDefinition.

Reader/Writer class which specifies the contents of a DtComponentSystem. This lists the sensors, controllers, actuators and connections of a system. It may also list subsystems that are included in this system.

Constructor & Destructor Documentation

DtComponentSystemDefinition::DtComponentSystemDefinition ( )

private

Not implemented.

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

read/writable constructor

DtComponentSystemDefinition::DtComponentSystemDefinition	(	const DtComponentSystemDefinition &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtComponentSystemDefinition::~DtComponentSystemDefinition ( )

virtual

destructor

Member Function Documentation

const DtComponentSystemDefinition& DtComponentSystemDefinition::operator=

(

const DtComponentSystemDefinition &

orig

)

assignment operator

virtual const DtComponentSystemDescriptorList& DtComponentSystemDefinition::systemDescriptorList ( ) const

virtual

See mySystemDescriptorList.

virtual void DtComponentSystemDefinition::setSystemDescriptorList ( const DtComponentSystemDescriptorList &  list )

virtual

See mySystemDescriptorList.

virtual const DtComponentDescriptorList& DtComponentSystemDefinition::sensorDescriptorList ( ) const

virtual

Accessor/mutator for mySensorDescriptorList.

virtual void DtComponentSystemDefinition::setSensorDescriptorList ( const DtComponentDescriptorList &  list )

virtual

Accessor/mutator for mySensorDescriptorList.

virtual const DtComponentDescriptorList& DtComponentSystemDefinition::controllerDescriptorList ( ) const

virtual

Accessor/mutator for myControllerDescriptorList.

virtual void DtComponentSystemDefinition::setControllerDescriptorList ( const DtComponentDescriptorList &  list )

virtual

Accessor/mutator for myControllerDescriptorList.

virtual const DtComponentDescriptorList& DtComponentSystemDefinition::actuatorDescriptorList ( ) const

virtual

Accessor/mutator for myActuatorDescriptorList.

virtual void DtComponentSystemDefinition::setActuatorDescriptorList ( const DtComponentDescriptorList &  list )

virtual

Accessor/mutator for myActuatorDescriptorList.

virtual const DtConnectionDescriptorList& DtComponentSystemDefinition::connectionDescriptorList ( ) const

virtual

Accessor/mutator for myConnectionDescriptorList.

virtual void DtComponentSystemDefinition::setConnectionDescriptorList ( const DtConnectionDescriptorList &  list )

virtual

Accessor/mutator for myConnectionDescriptorList.

virtual const DtSimResourceManager& DtComponentSystemDefinition::resources ( ) const

virtual

List of resources defined for this system.

virtual DtSimResourceManager& DtComponentSystemDefinition::resources ( )

virtual

List of resources defined for this system.

virtual void DtComponentSystemDefinition::setResources ( const DtSimResourceManager &  )

virtual

List of resources defined for this system.

virtual const DtComponentSystemMetaData& DtComponentSystemDefinition::metaData ( ) const

virtual

Metadata about the system.

This data is mainly used by the Entity Editor when allowing users to configure an entity with a system. It is not used for any critical simulation aspects of the system.

virtual DtComponentSystemMetaData& DtComponentSystemDefinition::metaData ( )

virtual

Metadata about the system.

This data is mainly used by the Entity Editor when allowing users to configure an entity with a system. It is not used for any critical simulation aspects of the system.

Member Data Documentation

DtComponentSystemDescriptorList DtComponentSystemDefinition::mySystemDescriptorList

protected

DtComponentDescriptorList DtComponentSystemDefinition::mySensorDescriptorList

protected

DtComponentDescriptorList DtComponentSystemDefinition::myControllerDescriptorList

protected

DtComponentDescriptorList DtComponentSystemDefinition::myActuatorDescriptorList

protected

DtConnectionDescriptorList DtComponentSystemDefinition::myConnectionDescriptorList

protected

DtSimResourceManager DtComponentSystemDefinition::myResources

protected

DtComponentSystemMetaData DtComponentSystemDefinition::myMetaData

protected

---

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

• include/vrfobjparam/compSystemDefinition.h