DtComponentSystemMetaData Class Reference

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

Inheritance diagram for DtComponentSystemMetaData:

List of all members.

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 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
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 ()
Protected Attributes
DtRwString	mySystemName
	Plain text readable name for the system.
DtRwString	mySystemDescription
	Text description of the system.
DtRwNLengthStringVector	myAllowedStateRepositoryTypes
	List if state repository types which this system is valid for.
DtRwNLengthStringVector	mySystemCategories
	List of system categories that this system belongs to.
DtSystemParameterDataList	myParameterDataList
	List of information about parameter for this system.
DtSystemMetaDataEntryList	myMetaDataEntryList
	List of meta data entries.
Private Member Functions
	DtComponentSystemMetaData ()
	Not implemented.

---

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]

See also:

mySystemName.

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::paramterDataList

(

)

const [virtual]

See also:

myParameterDataList

virtual DtSystemParameterDataList& DtComponentSystemMetaData::paramterDataList

(

)

[virtual]

See also:

myParameterDataList

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

---

Member Data Documentation

DtRwString DtComponentSystemMetaData::mySystemName [protected]

Plain text readable name for the system.

DtRwString DtComponentSystemMetaData::mySystemDescription [protected]

Text description of the system.

DtRwNLengthStringVector DtComponentSystemMetaData::myAllowedStateRepositoryTypes [protected]

List if state repository types which this system is valid for.

These types will come from the vrfParamTypes.h.

DtRwNLengthStringVector DtComponentSystemMetaData::mySystemCategories [protected]

List of system categories that this system belongs to.

DtSystemParameterDataList DtComponentSystemMetaData::myParameterDataList [protected]

List of information about parameter for this system.

DtSystemMetaDataEntryList DtComponentSystemMetaData::myMetaDataEntryList [protected]

List of meta data entries.

These entries are of subtypes of DtSystemMetaDataEntry, and can contain any data that is specific to this system.

---

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

• include/vrfobjparam/compSystemMetaData.h