DtComponentSystemDefinition Class Reference

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.

Inheritance diagram for DtComponentSystemDefinition:

Public Types
typedef DtComponentSystemDefinition *(*	ComponentSystemDefinitionCreatorFcn )(const DtString &, DtReaderWriterRegistry *parentRegistry)
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 )()

Public Member Functions
	DtComponentSystemDefinition (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtComponentSystemDefinition (const DtComponentSystemDefinition &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual const DtComponentSystemDefinition &	operator= (const DtComponentSystemDefinition &orig)
virtual	~DtComponentSystemDefinition () override
bool	operator== (const DtComponentSystemDefinition &) const
bool	operator!= (const DtComponentSystemDefinition &rhs) const
virtual void	postGetSelf () override
virtual bool	hasComponentByDescriptorType (const DtString &) const
virtual bool	hasComponentByComponentType (const DtString &) const
virtual const DtComponentSystemDescriptorList &	systemDescriptorList () const
virtual void	setSystemDescriptorList (const DtComponentSystemDescriptorList &list)
virtual const DtComponentDescriptorList &	sensorDescriptorList () const
virtual DtComponentDescriptorList &	sensorDescriptorList ()
virtual void	setSensorDescriptorList (const DtComponentDescriptorList &list)
virtual const DtComponentDescriptorList &	controllerDescriptorList () const
virtual DtComponentDescriptorList &	controllerDescriptorList ()
virtual void	setControllerDescriptorList (const DtComponentDescriptorList &list)
virtual const DtComponentDescriptorList &	actuatorDescriptorList () const
virtual DtComponentDescriptorList &	actuatorDescriptorList ()
virtual void	setActuatorDescriptorList (const DtComponentDescriptorList &list)
virtual const DtConnectionDescriptorList &	connectionDescriptorList () const
virtual DtConnectionDescriptorList &	connectionDescriptorList ()
virtual void	setConnectionDescriptorList (const DtConnectionDescriptorList &list)
virtual const DtComponentSystemMetaData &	metaData (bool merged=false) const
virtual DtComponentSystemMetaData &	metaData (bool merged=false)
virtual const DtSimResourceManager &	resourceDefaults () const
virtual DtSimResourceManager &	resourceDefaults ()
virtual DtSimResourceManager	providedResourceDefaults () const
virtual const DtRwStringList &	compatibilityPsrNames () const
virtual DtRwStringList &	compatibilityPsrNames ()
virtual bool	canBeDisabled () const
virtual bool	canBeDisabledSpecified () const
virtual void	setCanBeDisabled (bool yesNo)
virtual bool	isTemplate () const
virtual void	setIsTemplate (bool yesNo)
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static ComponentSystemDefinitionCreatorFcn	SetCreator (ComponentSystemDefinitionCreatorFcn)
static DtComponentSystemDefinition *	Create (const DtString &systemName, DtReaderWriterRegistry *parent)
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 ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
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)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual bool	hasComponentByDescriptorType (const DtRwList &, const DtString &) const
virtual bool	hasComponentByComponentType (const DtRwList &, const DtString &) const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtComponentSystemDescriptorList	mySystemDescriptorList
DtComponentDescriptorList	mySensorDescriptorList
DtComponentDescriptorList	myControllerDescriptorList
DtComponentDescriptorList	myActuatorDescriptorList
DtConnectionDescriptorList	myConnectionDescriptorList
DtComponentSystemMetaData	myMetaData
DtComponentSystemMetaData	myMergedMetaData
DtRwStringList	myCompatibilityPsrNames
DtRwBoolean	myCanBeDisabled
DtRwBoolean	myIsTemplate
DtSimResourceManager	myResourceDefaults
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
bool	myInvalid
bool	myChangedFlag

Static Protected Attributes
static ComponentSystemDefinitionCreatorFcn	theCreator
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

Private Member Functions
	DtComponentSystemDefinition ()

Member Typedef Documentation

typedef DtComponentSystemDefinition*(* DtComponentSystemDefinition::ComponentSystemDefinitionCreatorFcn)(const DtString &, DtReaderWriterRegistry *parentRegistry)

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 ( )

overridevirtual

destructor

Member Function Documentation

virtual const DtComponentSystemDefinition& DtComponentSystemDefinition::operator= ( const DtComponentSystemDefinition &  orig )

virtual

assignment operator

Reimplemented in DtComponentSystemDefinitionUpgrade, and DtSOEComponentSystemDefinition.

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 DtComponentDescriptorList& DtComponentSystemDefinition::sensorDescriptorList ( )

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 DtComponentDescriptorList& DtComponentSystemDefinition::controllerDescriptorList ( )

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 DtComponentDescriptorList& DtComponentSystemDefinition::actuatorDescriptorList ( )

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 DtConnectionDescriptorList& DtComponentSystemDefinition::connectionDescriptorList ( )

virtual

Accessor/mutator for myConnectionDescriptorList.

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

virtual

Accessor/mutator for myConnectionDescriptorList.

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 DtSimResourceManager& DtComponentSystemDefinition::resourceDefaults ( ) const

virtual

See Also

myResourceDefaults

virtual DtSimResourceManager& DtComponentSystemDefinition::resourceDefaults ( )

virtual

See Also

myResourceDefaults

virtual DtSimResourceManager DtComponentSystemDefinition::providedResourceDefaults ( ) const

virtual

Looking over all targeting control tables and resource defaults of this and sub systems, how many resources will this system provide.

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

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.

bool DtComponentSystemDefinition::operator==

(

const DtComponentSystemDefinition &

)

const

Equivalence operator.

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

inline

virtual void DtComponentSystemDefinition::postGetSelf ( )

overridevirtual

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

Reimplemented from DtReaderWriter.

Reimplemented in DtComponentSystemDefinitionUpgrade.

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

Can the system be disabled.

virtual void DtComponentSystemDefinition::setCanBeDisabled ( bool  yesNo )

virtual

Can the system be disabled.

virtual bool DtComponentSystemDefinition::isTemplate ( ) const

virtual

Is this system based off template.

virtual void DtComponentSystemDefinition::setIsTemplate ( bool  yesNo )

virtual

Is this system based off template.

static ComponentSystemDefinitionCreatorFcn DtComponentSystemDefinition::SetCreator ( ComponentSystemDefinitionCreatorFcn  )

static

Sets a creator for this class. Will be used by the component descriptor to create this definition.

static DtComponentSystemDefinition* DtComponentSystemDefinition::Create ( const DtString &  systemName, DtReaderWriterRegistry *  parent  )

static

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

DtComponentSystemMetaData DtComponentSystemDefinition::myMetaData

protected

DtComponentSystemMetaData DtComponentSystemDefinition::myMergedMetaData

protected

DtRwStringList DtComponentSystemDefinition::myCompatibilityPsrNames

protected

DtRwBoolean DtComponentSystemDefinition::myCanBeDisabled

protected

DtRwBoolean DtComponentSystemDefinition::myIsTemplate

protected

ComponentSystemDefinitionCreatorFcn DtComponentSystemDefinition::theCreator

staticprotected

DtSimResourceManager DtComponentSystemDefinition::myResourceDefaults

protected

Parameter Name: resource-defaults
Parameter Description: List of resources, that, if these resources are not present in the entity when the system is added, will add these resources to the entity. Parameter Default Value:
Parameter Units:

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjparam/componentSystemDefinition.h