DtComponentSystemMetaData Class Reference

Contains metadata about a component system definition. More...

Inheritance diagram for DtComponentSystemMetaData:

Public Member Functions
	DtComponentSystemMetaData (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	read/writable constructor
	DtComponentSystemMetaData (const DtComponentSystemMetaData &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtComponentSystemMetaData &	operator= (const DtComponentSystemMetaData &orig)
	assignment operator
virtual	~DtComponentSystemMetaData ()
	destructor
virtual bool	allowedForStateRepositoryType (const DtString &srTypeString) const
virtual const std::map < DtString, DtString >	attributeList () const
	Accessor for system attributes.
virtual const DtSystemMetaDataEntry *	lookupMetaDataEntry (const DtString &dataType) const
	Finds the meta data entry of the specified type in the meta data entry list and returns it.
virtual bool	inSystemCategory (const DtString &category) const
bool	operator== (const DtComponentSystemMetaData &) const
	Equivalence operator.
virtual DtString	systemName () const
virtual void	setSystemName (const DtString &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 &	paramterDataList () const
virtual DtSystemParameterDataList &	paramterDataList ()
virtual const DtSystemMetaDataEntryList &	metaDataEntryList () const
virtual DtSystemMetaDataEntryList &	metaDataEntryList ()
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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.
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 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.
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.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
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.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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.
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.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Attributes
DtRwString	mySystemName
	Parameter Name: system-name Parameter Description: Plain text readable name for the system.
DtRwString	mySystemDescription
	Parameter Name: system-description Parameter Description: Text description of the system.
DtRwNLengthStringVector	myAllowedStateRepositoryTypes
	Parameter Name: allowed-state-repository-types Parameter Description: List if state repository types which this system is valid for.
DtRwNLengthStringVector	mySystemCategories
	Parameter Name: system-categories Parameter Description: List of system categories that this system belongs to.
DtSystemParameterDataList	myParameterDataList
	Parameter Name: parameter-data-list Parameter Description: List of information about parameters for this system.
DtSystemMetaDataEntryList	myMetaDataEntryList
	Parameter Name: meta-data-entry-list Parameter Description: List of meta data entries.
DtRwStringAttributeList	myAttributeList
	Parameter Name: system-attributes Parameter Description: List of key-value pairs (a pair of strings) describing arbitrary attributes of the system.
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.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

Private Member Functions
	DtComponentSystemMetaData ()
	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::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.
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 void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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

Detailed Description

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.

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

virtual

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

virtual DtString DtComponentSystemMetaData::systemDescription ( ) const

virtual

See Also

mySystemDescription

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

virtual

virtual const DtRwNLengthStringVector& DtComponentSystemMetaData::allowedStateRepositoryTypes ( ) const

virtual

See Also

myAllowedStateRepositoryTypes.

virtual DtRwNLengthStringVector& DtComponentSystemMetaData::allowedStateRepositoryTypes ( )

virtual

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

virtual const DtSystemParameterDataList& DtComponentSystemMetaData::paramterDataList ( ) const

virtual

See Also

myParameterDataList

virtual DtSystemParameterDataList& DtComponentSystemMetaData::paramterDataList ( )

virtual

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

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

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:

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfobjparam/componentSystemMetaData.h