DtSystemParameterData Class Reference

Base class for RW objects that describe a system parameter. More...

Inheritance diagram for DtSystemParameterData:

List of all members.

Public Member Functions
	DtSystemParameterData (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSystemParameterData (const DtString &name, const DtSystemParameterData &orig, DtReaderWriterRegistry *parentRegistry=0)
DtSystemParameterData &	operator= (const DtSystemParameterData &orig)
virtual	~DtSystemParameterData ()
virtual DtString	parameterType () const =0
virtual DtSystemParameterData *	clone () const =0
virtual DtString	parameterName () const
virtual void	setParameterName (const DtString &name)
virtual DtString	variableType () const
virtual void	setVariableType (const DtString &type)
virtual DtString	displayLabel () const
virtual void	setDisplayLabel (const DtString &label)
virtual DtString	displayUnits () const
virtual void	setDisplayUnits (const DtString &units)
virtual DtString	sourceUnits () const
virtual void	setSourceUnits (const DtString &units)
virtual void	assignDefaultValueToReaderWriter (DtReaderWriter *rwToChange) const
	If this parameter data has a default value, this method will change the value of the supplied reader-writer to that default value.
Static Public Member Functions
static DtSystemParameterData *	createSystemParamterData (const DtString &type)
	Uses theFactory to create a DtSystemParamterData subclass of the specified type.
static DtSystemParameterDataFactory *	factory ()
Protected Attributes
DtRwString	myParameterName
DtRwString	myVariableType
DtRwString	myDisplayLabel
DtRwString	myDisplayUnits
DtRwString	mySourceUnits
Static Protected Attributes
static std::auto_ptr < DtSystemParameterDataFactory >	theFactory

---

Detailed Description

Base class for RW objects that describe a system parameter.

This data is used by the entity editor to provide the user the ability to edit parameters of the system. It is part of the system meta data.

---

Constructor & Destructor Documentation

DtSystemParameterData::DtSystemParameterData	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

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

virtual DtSystemParameterData::~DtSystemParameterData

(

)

[virtual]

---

Member Function Documentation

DtSystemParameterData& DtSystemParameterData::operator=

(

const DtSystemParameterData &

orig

)

virtual DtString DtSystemParameterData::parameterType

(

)

const [pure virtual]

Returns:

The type string for this parameter. Comes from systemParameterDataTypes.h.

Implemented in DtSystemBoolParameterData, DtSystemRealParameterData, DtSystemIntParameterData, DtSystemOrientationParameterData, DtSystemVectorParameterData, and DtSystemArtPartParameterData.

virtual DtSystemParameterData* DtSystemParameterData::clone

(

)

const [pure virtual]

Implemented in DtSystemBoolParameterData, DtSystemRealParameterData, DtSystemIntParameterData, DtSystemOrientationParameterData, DtSystemVectorParameterData, and DtSystemArtPartParameterData.

virtual DtString DtSystemParameterData::parameterName

(

)

const [virtual]

virtual void DtSystemParameterData::setParameterName

(

const DtString &

name

)

[virtual]

virtual DtString DtSystemParameterData::variableType

(

)

const [virtual]

virtual void DtSystemParameterData::setVariableType

(

const DtString &

type

)

[virtual]

virtual DtString DtSystemParameterData::displayLabel

(

)

const [virtual]

virtual void DtSystemParameterData::setDisplayLabel

(

const DtString &

label

)

[virtual]

virtual DtString DtSystemParameterData::displayUnits

(

)

const [virtual]

virtual void DtSystemParameterData::setDisplayUnits

(

const DtString &

units

)

[virtual]

virtual DtString DtSystemParameterData::sourceUnits

(

)

const [virtual]

virtual void DtSystemParameterData::setSourceUnits

(

const DtString &

units

)

[virtual]

virtual void DtSystemParameterData::assignDefaultValueToReaderWriter

(

DtReaderWriter *

rwToChange

)

const [virtual]

If this parameter data has a default value, this method will change the value of the supplied reader-writer to that default value.

Must be implemented by subclasses that have a default value.

Reimplemented in DtSystemBoolParameterData, DtSystemRealParameterData, DtSystemIntParameterData, DtSystemOrientationParameterData, and DtSystemVectorParameterData.

static DtSystemParameterData* DtSystemParameterData::createSystemParamterData

(

const DtString &

type

)

[static]

Uses theFactory to create a DtSystemParamterData subclass of the specified type.

static DtSystemParameterDataFactory* DtSystemParameterData::factory

(

)

[static]

Returns:

A pointer to the factory used to create subclasses of DtSystemParamterData.

Reimplemented from DtReaderWriter.

---

Member Data Documentation

DtRwString DtSystemParameterData::myParameterName [protected]

DtRwString DtSystemParameterData::myVariableType [protected]

DtRwString DtSystemParameterData::myDisplayLabel [protected]

DtRwString DtSystemParameterData::myDisplayUnits [protected]

DtRwString DtSystemParameterData::mySourceUnits [protected]

std::auto_ptr<DtSystemParameterDataFactory> DtSystemParameterData::theFactory [static, protected]

Reimplemented from DtReaderWriter.

---

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

• include/vrfobjparam/systemParameterData.h