DtComponentSystemMetaData Class Reference

Contains metadata about a component system definition. Data such as name, description, and what types of entities the system is allowed to be used on. This data will typically be used by the Entity Editor, and not for any critical areas of vrfSim.

Inheritance diagram for DtComponentSystemMetaData:

Public Member Functions
	DtComponentSystemMetaData (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtComponentSystemMetaData (const DtComponentSystemMetaData &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtComponentSystemMetaData &	operator= (const DtComponentSystemMetaData &orig)
virtual	~DtComponentSystemMetaData () override
virtual bool	allowedForStateRepositoryType (const DtString &srTypeString) const
virtual std::map< DtString, DtString >	attributeList () const
virtual const DtSystemMetaDataEntry *	lookupMetaDataEntry (const DtString &dataType) const
virtual bool	inSystemCategory (const DtString &category) const
bool	operator== (const DtComponentSystemMetaData &) const
virtual void	merge (const DtComponentSystemMetaData &)
virtual bool	canCheckHealthOf (const DtString &) const
virtual DtString	systemName () const
virtual void	setSystemName (const DtString &name)
virtual const DtString &	uiFilename () const
virtual void	setUiFilename (const DtString &name)
virtual const DtString &	promotedFrom () const
virtual void	setPromotedFrom (const DtString &name)
virtual const DtRwNLengthStringVector &	onlySupportsHealthChecks () const
virtual void	setOnlySupportsHealthChecks (const DtRwNLengthStringVector &name)
virtual DtString	systemDescription () const
virtual void	setSystemDescription (const DtString &desc)
virtual const DtRwNLengthStringVector &	allowedStateRepositoryTypes () const
virtual DtRwNLengthStringVector &	allowedStateRepositoryTypes ()
virtual const DtRwNLengthStringVector &	systemCategories () const
virtual DtRwNLengthStringVector &	systemCategories ()
virtual const DtSystemParameterDataList &	parameterDataList () const
virtual DtSystemParameterDataList &	parameterDataList ()
virtual bool	mergeWithSubSystems () const
virtual void	setMergeWithSubSystems (bool)
virtual const DtSystemMetaDataEntryList &	metaDataEntryList () const
virtual DtSystemMetaDataEntryList &	metaDataEntryList ()
virtual const DtRwNLengthStringVector &	deprecatedVariableBindings () const
virtual DtRwNLengthStringVector &	deprecatedVariableBindings ()
virtual const DtRwNLengthStringVector &	additionalData () const
virtual DtRwNLengthStringVector &	additionalData ()
virtual void	mergeAllowedStateRepositoryTypes (const DtRwNLengthStringVector &)
virtual void	mergeSystemCategories (const DtRwNLengthStringVector &)
virtual void	mergeOnlySupportsHealthChecks (const DtRwNLengthStringVector &)
virtual void	mergeParameterDataList (const DtSystemParameterDataList &)
virtual void	mergeMetaDataEntryList (const DtSystemMetaDataEntryList &)
virtual void	mergeAttributeList (const std::map< DtString, DtString > &)
virtual void	mergeDeprecatedVariableBindings (const DtRwNLengthStringVector &)
virtual void	mergeAdditionalData (const DtRwNLengthStringVector &)
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	postGetSelf ()
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)

Protected Attributes
DtRwString	mySystemName
DtRwString	mySystemDescription
DtRwNLengthStringVector	myAllowedStateRepositoryTypes
DtRwNLengthStringVector	mySystemCategories
DtSystemParameterDataList	myParameterDataList
DtSystemMetaDataEntryList	myMetaDataEntryList
DtRwStringAttributeList	myAttributeList
DtRwString	myUiFilename
DtRwString	myPromotedFrom
DtRwBoolean	myMergeWithSubSystems
DtRwNLengthStringVector	myOnlySupportsHealthChecks
DtRwNLengthStringVector	myDeprecatedVariableBindings
DtRwNLengthStringVector	myAdditionalData
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

Private Member Functions
	DtComponentSystemMetaData ()

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 ()
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 inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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

Constructor & Destructor Documentation

DtComponentSystemMetaData::DtComponentSystemMetaData ( )

private

Not implemented.

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

read/writable constructor

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

copy constructor

virtual DtComponentSystemMetaData::~DtComponentSystemMetaData ( )

overridevirtual

destructor

Member Function Documentation

const DtComponentSystemMetaData& DtComponentSystemMetaData::operator=

(

const DtComponentSystemMetaData &

orig

)

assignment operator

virtual DtString DtComponentSystemMetaData::systemName ( ) const

virtual

See Also

mySystemName.

virtual void DtComponentSystemMetaData::setSystemName ( const DtString &  name )

virtual

See Also

mySystemName.

virtual const DtString& DtComponentSystemMetaData::uiFilename ( ) const

virtual

See Also

myUiFilename.

virtual void DtComponentSystemMetaData::setUiFilename ( const DtString &  name )

virtual

See Also

myUiFilename.

virtual const DtString& DtComponentSystemMetaData::promotedFrom ( ) const

virtual

See Also

myPromotedFrom.

virtual void DtComponentSystemMetaData::setPromotedFrom ( const DtString &  name )

virtual

See Also

myPromotedFrom.

virtual const DtRwNLengthStringVector& DtComponentSystemMetaData::onlySupportsHealthChecks ( ) const

virtual

See Also

myOnlySupportsHealthChecks.

virtual void DtComponentSystemMetaData::setOnlySupportsHealthChecks ( const DtRwNLengthStringVector &  name )

virtual

See Also

myOnlySupportsHealthChecks.

virtual DtString DtComponentSystemMetaData::systemDescription ( ) const

virtual

See Also

mySystemDescription

virtual void DtComponentSystemMetaData::setSystemDescription ( const DtString &  desc )

virtual

See Also

mySystemDescription

virtual const DtRwNLengthStringVector& DtComponentSystemMetaData::allowedStateRepositoryTypes ( ) const

virtual

See Also

myAllowedStateRepositoryTypes.

virtual DtRwNLengthStringVector& DtComponentSystemMetaData::allowedStateRepositoryTypes ( )

virtual

See Also

myAllowedStateRepositoryTypes.

virtual bool DtComponentSystemMetaData::allowedForStateRepositoryType ( const DtString &  srTypeString ) const

virtual

Returns

True if the specified srTypeString is in myAllowedStateRepositoryTypes.

virtual const DtRwNLengthStringVector& DtComponentSystemMetaData::systemCategories ( ) const

virtual

See Also

mySystemCategories.

virtual DtRwNLengthStringVector& DtComponentSystemMetaData::systemCategories ( )

virtual

See Also

mySystemCategories.

virtual const DtSystemParameterDataList& DtComponentSystemMetaData::parameterDataList ( ) const

virtual

See Also

myParameterDataList

virtual DtSystemParameterDataList& DtComponentSystemMetaData::parameterDataList ( )

virtual

See Also

myParameterDataList

virtual bool DtComponentSystemMetaData::mergeWithSubSystems ( ) const

virtual

See Also

myMergeWithSubSystems

virtual void DtComponentSystemMetaData::setMergeWithSubSystems ( bool  )

virtual

See Also

myMergeWithSubSystems

virtual const DtSystemMetaDataEntryList& DtComponentSystemMetaData::metaDataEntryList ( ) const

virtual

See Also

myMetaDataEntryList lookupMetaDataEntry() is an easier way to find a specific meta data entry.

virtual DtSystemMetaDataEntryList& DtComponentSystemMetaData::metaDataEntryList ( )

virtual

See Also

myMetaDataEntryList lookupMetaDataEntry() is an easier way to find a specific meta data entry.

virtual const DtRwNLengthStringVector& DtComponentSystemMetaData::deprecatedVariableBindings ( ) const

virtual

See Also

myDeprecatedVariableBindings.

virtual DtRwNLengthStringVector& DtComponentSystemMetaData::deprecatedVariableBindings ( )

virtual

See Also

myDeprecatedVariableBindings.

virtual const DtRwNLengthStringVector& DtComponentSystemMetaData::additionalData ( ) const

virtual

See Also

myAdditionalData.

virtual DtRwNLengthStringVector& DtComponentSystemMetaData::additionalData ( )

virtual

See Also

myAdditionalData.

virtual std::map<DtString, DtString> DtComponentSystemMetaData::attributeList ( ) const

virtual

Accessor for system attributes. Note that it converts the list of pairs into a std map.

virtual const DtSystemMetaDataEntry* DtComponentSystemMetaData::lookupMetaDataEntry ( const DtString &  dataType ) const

virtual

Finds the meta data entry of the specified type in the meta data entry list and returns it. Returns NULL if not found.

virtual bool DtComponentSystemMetaData::inSystemCategory ( const DtString &  category ) const

virtual

Returns

True if category is in mySystemCategories.

bool DtComponentSystemMetaData::operator==

(

const DtComponentSystemMetaData &

)

const

Equivalence operator.

virtual void DtComponentSystemMetaData::merge ( const DtComponentSystemMetaData &  )

virtual

Merges the contents of the meta data properties, meta data entry list and attributes list into this meta data No information will be removed. If items exist, they will be replaced by the merged system meta data.

virtual bool DtComponentSystemMetaData::canCheckHealthOf ( const DtString &  ) const

virtual

Returns true if this system can check the health of the given test.

virtual void DtComponentSystemMetaData::mergeAllowedStateRepositoryTypes ( const DtRwNLengthStringVector &  )

virtual

Helper merge functions.

virtual void DtComponentSystemMetaData::mergeSystemCategories ( const DtRwNLengthStringVector &  )

virtual

Helper merge functions.

virtual void DtComponentSystemMetaData::mergeOnlySupportsHealthChecks ( const DtRwNLengthStringVector &  )

virtual

Helper merge functions.

virtual void DtComponentSystemMetaData::mergeParameterDataList ( const DtSystemParameterDataList &  )

virtual

Helper merge functions.

virtual void DtComponentSystemMetaData::mergeMetaDataEntryList ( const DtSystemMetaDataEntryList &  )

virtual

Helper merge functions.

virtual void DtComponentSystemMetaData::mergeAttributeList ( const std::map< DtString, DtString > &  )

virtual

Helper merge functions.

virtual void DtComponentSystemMetaData::mergeDeprecatedVariableBindings ( const DtRwNLengthStringVector &  )

virtual

Helper merge functions.

virtual void DtComponentSystemMetaData::mergeAdditionalData ( const DtRwNLengthStringVector &  )

virtual

Helper merge functions.

Member Data Documentation

DtRwString DtComponentSystemMetaData::mySystemName

protected

Parameter Name: system-name
Parameter Description: Plain text readable name for the system.
Parameter Default Value:
Parameter Units:

DtRwString DtComponentSystemMetaData::mySystemDescription

protected

Parameter Name: system-description
Parameter Description: Text description of the system.
Parameter Default Value:
Parameter Units:

DtRwNLengthStringVector DtComponentSystemMetaData::myAllowedStateRepositoryTypes

protected

Parameter Name: allowed-state-repository-types
Parameter Description: List if state repository types which this system is valid for. These types will come from the vrfParamTypes.h. Parameter Default Value:
Parameter Units:

DtRwNLengthStringVector DtComponentSystemMetaData::mySystemCategories

protected

Parameter Name: system-categories
Parameter Description: List of system categories that this system belongs to.
Parameter Default Value:
Parameter Units:

DtSystemParameterDataList DtComponentSystemMetaData::myParameterDataList

protected

Parameter Name: parameter-data-list
Parameter Description: List of information about parameters for this system. This is where the user adds any variable bindings they might have made so that they will be available in the entityEditor when the user clicks the edit systems
Parameter Default Value:
Parameter Units:

DtSystemMetaDataEntryList DtComponentSystemMetaData::myMetaDataEntryList

protected

Parameter Name: meta-data-entry-list
Parameter Description: List of meta data entries. These entries are of subtypes of DtSystemMetaDataEntry, and can contain any data that is specific to this system.
Parameter Default Value:
Parameter Units:

DtRwStringAttributeList DtComponentSystemMetaData::myAttributeList

protected

Parameter Name: system-attributes
Parameter Description: List of key-value pairs (a pair of strings) describing arbitrary attributes of the system.
Parameter Default Value:
Parameter Units:

DtRwString DtComponentSystemMetaData::myUiFilename

protected

Parameter Name: ui-filename
Parameter Description: For the Simulation Object Editor, the default filename to use for this system when displaying information. If blank will use the system default of system-definition.ui.
Parameter Default Value:
Parameter Units:

DtRwString DtComponentSystemMetaData::myPromotedFrom

protected

Parameter Name: promoted-from
Parameter Description: For the Simulation Object Editor, if this system was promoted from another system, this value will contain the filename of the sysetm it was promoted from. This will be used to make sure to not show both systems in the Simulation Object Editor system list
Parameter Default Value:
Parameter Units:

DtRwBoolean DtComponentSystemMetaData::myMergeWithSubSystems

protected

Parameter Name: merge-with-sub-systems
Parameter Description: This variable will determine if this system, when loaded, will merge parameter and meta data contained in sub-systems. The data will only be added or replaced, if a similar named item is in this system, not removed
Parameter Default Value: True
Parameter Units:

DtRwNLengthStringVector DtComponentSystemMetaData::myOnlySupportsHealthChecks

protected

Parameter Name: only-supports-health-checks
Parameter Description: This variable will define health checks that this system will only support (semi-colon separated). If blank will support all
Parameter Default Value: ""
Parameter Units:

DtRwNLengthStringVector DtComponentSystemMetaData::myDeprecatedVariableBindings

protected

Parameter Name: deprecated-variable-bindings
Parameter Description: List of deprecated variable bindings that should be removed from .entity files. Parameter Default Value:
Parameter Units: //!

DtRwNLengthStringVector DtComponentSystemMetaData::myAdditionalData

protected

Parameter Name: additional-data
Parameter Description: List of variable string data. 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/componentSystemMetaData.h