Inheritance diagram for DtComponentSystemDefinition:

Public Member Functions
	DtComponentSystemDefinition (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	read/writable constructor More...

	DtComponentSystemDefinition (const DtComponentSystemDefinition &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...

const DtComponentSystemDefinition &	operator= (const DtComponentSystemDefinition &orig)
	assignment operator More...

virtual	~DtComponentSystemDefinition ()
	destructor More...

bool	operator== (const DtComponentSystemDefinition &) const
	Equivalence operator. More...

bool	operator!= (const DtComponentSystemDefinition &rhs) const

virtual void	postGetSelf ()
	Merge up meta data if the flag in the meta data says to. More...

virtual bool	hasComponentByDescriptorType (const DtString &) const
	Returns true if this system or any sub-systems has the given component by descriptor type. More...

virtual bool	hasComponentByComponentType (const DtString &) const
	Returns true if this system or any sub-systems has the given component by component type. More...


virtual const DtComponentSystemDescriptorList &	systemDescriptorList () const
	See mySystemDescriptorList. More...

virtual void	setSystemDescriptorList (const DtComponentSystemDescriptorList &list)


virtual const DtComponentDescriptorList &	sensorDescriptorList () const
	Accessor/mutator for mySensorDescriptorList. More...

virtual void	setSensorDescriptorList (const DtComponentDescriptorList &list)


virtual const DtComponentDescriptorList &	controllerDescriptorList () const
	Accessor/mutator for myControllerDescriptorList. More...

virtual void	setControllerDescriptorList (const DtComponentDescriptorList &list)


virtual const DtComponentDescriptorList &	actuatorDescriptorList () const
	Accessor/mutator for myActuatorDescriptorList. More...

virtual void	setActuatorDescriptorList (const DtComponentDescriptorList &list)


virtual const DtConnectionDescriptorList &	connectionDescriptorList () const
	Accessor/mutator for myConnectionDescriptorList. More...

virtual void	setConnectionDescriptorList (const DtConnectionDescriptorList &list)


virtual const DtSimResourceManager &	resources () const
	List of resources defined for this system. More...

virtual DtSimResourceManager &	resources ()

virtual void	setResources (const DtSimResourceManager &)


virtual const DtComponentSystemMetaData &	metaData (bool merged=false) const
	Metadata about the system. More...

virtual DtComponentSystemMetaData &	metaData (bool merged=false)
	Merged here is false by default such that the original meta data is returned. More...


virtual const DtRwStringList &	compatibilityPsrNames () const
	List of names for which this system PSR is registered as "compatibility" PSRs. More...

virtual DtRwStringList &	compatibilityPsrNames ()


virtual bool	canBeDisabled () const
	Can the system be disabled. More...

virtual bool	canBeDisabledSpecified () const

virtual void	setCanBeDisabled (bool yesNo)


virtual bool	isTemplate () const
	Is this system based off template. More...

virtual void	setIsTemplate (bool yesNo)

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	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. 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 bool	hasComponentByDescriptorType (const DtRwList &, const DtString &) const
	Iterates over the list, statically casting each item to a component descriptor to see if the descriptor type matches. More...

virtual bool	hasComponentByComponentType (const DtRwList &, const DtString &) const
	Iterates over the list, statically casting each item to a component descriptor to see if the component type matches. More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Attributes
DtComponentSystemDescriptorList	mySystemDescriptorList

DtComponentDescriptorList	mySensorDescriptorList

DtComponentDescriptorList	myControllerDescriptorList

DtComponentDescriptorList	myActuatorDescriptorList

DtConnectionDescriptorList	myConnectionDescriptorList

DtSimResourceManager	myResources

DtComponentSystemMetaData	myMetaData

DtComponentSystemMetaData	myMergedMetaData

DtRwStringList	myCompatibilityPsrNames

DtRwBoolean	myCanBeDisabled

DtRwBoolean	myIsTemplate

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...

Private Member Functions
	DtComponentSystemDefinition ()
	Not implemented. 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

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

virtual const DtComponentDescriptorList& DtComponentSystemDefinition::sensorDescriptorList ( ) const

virtual

Accessor/mutator for mySensorDescriptorList.

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

virtual

virtual const DtComponentDescriptorList& DtComponentSystemDefinition::controllerDescriptorList ( ) const

virtual

Accessor/mutator for myControllerDescriptorList.

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

virtual

virtual const DtComponentDescriptorList& DtComponentSystemDefinition::actuatorDescriptorList ( ) const

virtual

Accessor/mutator for myActuatorDescriptorList.

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

virtual

virtual const DtConnectionDescriptorList& DtComponentSystemDefinition::connectionDescriptorList ( ) const

virtual

Accessor/mutator for myConnectionDescriptorList.

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

virtual

virtual const DtSimResourceManager& DtComponentSystemDefinition::resources ( ) const

virtual

List of resources defined for this system.

virtual DtSimResourceManager& DtComponentSystemDefinition::resources ( )

virtual

virtual void DtComponentSystemDefinition::setResources ( const DtSimResourceManager & )

virtual

virtual const DtComponentSystemMetaData& DtComponentSystemDefinition::metaData ( bool merged = false ) 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. If merged is true for the const call (the non-const call will only ever return this systems meta data), it will return the merged meta data, if there is merge data to be had.

virtual DtComponentSystemMetaData& DtComponentSystemDefinition::metaData ( bool merged = false )

virtual

Merged here is false by default such that the original meta data is returned.

If the merged is returned changes will not be saved

virtual const DtRwStringList& DtComponentSystemDefinition::compatibilityPsrNames ( ) const

virtual

List of names for which this system PSR is registered as "compatibility" PSRs.

This means that scenarios saved out from VRF with these systems having other names and being in other locations will read into the PSRs current location

virtual DtRwStringList& DtComponentSystemDefinition::compatibilityPsrNames ( )

virtual

bool DtComponentSystemDefinition::operator== ( const DtComponentSystemDefinition & ) const

Equivalence operator.

bool DtComponentSystemDefinition::operator!= ( const DtComponentSystemDefinition & rhs ) const

inline

virtual void DtComponentSystemDefinition::postGetSelf ( )

virtual

Merge up meta data if the flag in the meta data says to.

Reimplemented from DtReaderWriter.

virtual bool DtComponentSystemDefinition::hasComponentByDescriptorType ( const DtString & ) const

virtual

Returns true if this system or any sub-systems has the given component by descriptor type.

virtual bool DtComponentSystemDefinition::hasComponentByComponentType ( const DtString & ) const

virtual

Returns true if this system or any sub-systems has the given component by component type.

virtual bool DtComponentSystemDefinition::canBeDisabled ( ) const

virtual

Can the system be disabled.

virtual bool DtComponentSystemDefinition::canBeDisabledSpecified ( ) const

virtual

virtual void DtComponentSystemDefinition::setCanBeDisabled ( bool yesNo )

virtual

virtual bool DtComponentSystemDefinition::isTemplate ( ) const

virtual

Is this system based off template.

virtual void DtComponentSystemDefinition::setIsTemplate ( bool yesNo )

virtual

virtual bool DtComponentSystemDefinition::hasComponentByDescriptorType	(	const DtRwList &	,
		const DtString &
	)		const

protectedvirtual

Iterates over the list, statically casting each item to a component descriptor to see if the descriptor type matches.

virtual bool DtComponentSystemDefinition::hasComponentByComponentType	(	const DtRwList &	,
		const DtString &
	)		const

protectedvirtual

Iterates over the list, statically casting each item to a component descriptor to see if the component type matches.

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

DtComponentSystemMetaData DtComponentSystemDefinition::myMergedMetaData

protected

DtRwStringList DtComponentSystemDefinition::myCompatibilityPsrNames

protected

DtRwBoolean DtComponentSystemDefinition::myCanBeDisabled

protected

DtRwBoolean DtComponentSystemDefinition::myIsTemplate

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation