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.

Inheritance diagram for DtSystemParameterData:

[legend]

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 const DtReaderWriter *	defaultRWValue () const

virtual void	assignDefaultValueToReaderWriter (DtReaderWriter *rwToChange) const

virtual bool	operator== (const DtSystemParameterData &) const

virtual void	setRollUpRule (const DtString &)

virtual DtString	rollUpRule () const

virtual void	setListItems (const DtString &)

virtual const DtString &	listItems () const

virtual void	getListItems (std::vector< DtString > &keys, std::vector< DtString > &values) const

virtual void	setListDisplay (int)

virtual int	listDisplay () const

virtual void	setAllowEdit (const bool)

virtual bool	allowEdit () const

virtual void	setDisplayValue (const bool)

virtual bool	displayValue () const

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)

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	wasUpdatedSince (DtTime t) 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 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 DtSystemParameterData *	createSystemParameterData (const DtString &type)

static DtSystemParameterDataFactory *	factory ()

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 Attributes
DtRwString	myParameterName

DtRwString	myVariableType

DtRwString	myDisplayLabel

DtRwString	myDisplayUnits

DtRwString	mySourceUnits

DtRwString	myListItems

DtRwInt	myListDisplay

DtRwBoolean	myAllowEdit

DtRwBoolean	myDisplayValue

DtRwString	myRollUpRule

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 std::auto_ptr < DtSystemParameterDataFactory >	theFactory

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

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

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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 DtSystemDiGuyParameterData, DtSystemStringParameterData, DtSystemBoolParameterData, DtSystemSensitivityParameterData, DtSystemRealParameterData, DtSystemIntParameterData, DtSystemOrientationParameterData, DtAircraftFuelUsageModelParameterData, DtSystemVectorParameterData, DtSystemArtPartParameterData, DtSystemTrajectoryTableParameterData, DtSystemArtPartTypeParameterData, and DtSystemUniqueNameParameterData.

virtual DtSystemParameterData* DtSystemParameterData::clone ( ) const

pure virtual

Implemented in DtSystemDiGuyParameterData, DtSystemStringParameterData, DtSystemBoolParameterData, DtSystemSensitivityParameterData, DtSystemRealParameterData, DtSystemIntParameterData, DtSystemOrientationParameterData, DtAircraftFuelUsageModelParameterData, DtSystemVectorParameterData, DtSystemArtPartParameterData, DtSystemTrajectoryTableParameterData, DtSystemArtPartTypeParameterData, and DtSystemUniqueNameParameterData.

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 const DtReaderWriter* DtSystemParameterData::defaultRWValue ( ) const

virtual

Returns a default value, if it exists.

Reimplemented from DtReaderWriter.

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

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 DtSystemStringParameterData, DtSystemBoolParameterData, DtSystemRealParameterData, DtSystemIntParameterData, DtSystemOrientationParameterData, and DtSystemVectorParameterData.

static DtSystemParameterData* DtSystemParameterData::createSystemParameterData ( 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.

virtual bool DtSystemParameterData::operator== ( const DtSystemParameterData & ) const

virtual

Equivalence operator.

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

virtual void DtSystemParameterData::setRollUpRule ( const DtString & )

virtual

Sets the roll up rule that will be used in the entity editor if this item is to be rolled up in a true aggregate assembly. The default rule is "none" (do not roll up). Valid values are:

sum - adds all the values together none - does not roll up value

virtual DtString DtSystemParameterData::rollUpRule ( ) const

virtual

virtual void DtSystemParameterData::setListItems ( const DtString & )

virtual

Set the list items as a semi-colon separated list of Key=Display Value, for example: Item1=Ammunition;Item2=Weapon.

There are special markers that can be used to reference assembly items. If you wish to reference assembly items (ammunition, weapons, equipment) then have the only item be ammunition, equipment or weapons

virtual const DtString& DtSystemParameterData::listItems ( ) const

virtual

virtual void DtSystemParameterData::getListItems	(	std::vector< DtString > &	keys,
		std::vector< DtString > &	values
	)		const

virtual

Returns, in two vectors, the key and display values.

virtual void DtSystemParameterData::setListDisplay ( int )

virtual

Sets how to display the list items. Currently supported: 0 - Combo box 1 - List box with a check box next to each item for multiple selection.

virtual int DtSystemParameterData::listDisplay ( ) const

virtual

virtual void DtSystemParameterData::setAllowEdit ( const bool )

virtual

Determines whether the parameter will show up in the system parameter dialog box in the Simulatino Object Editor as read only. Defaults true. This can be set false to define a variable for rolling up values of multiple systems in an Assembly (for aggregate units), but keeping its value fixed.

virtual bool DtSystemParameterData::allowEdit ( ) const

virtual

virtual void DtSystemParameterData::setDisplayValue ( const bool )

virtual

Determines whether or not to show value in system editing dialog. Set to false to not be able to display or edit. Default is true.

virtual bool DtSystemParameterData::displayValue ( ) const

virtual

Member Data Documentation

DtRwString DtSystemParameterData::myParameterName

protected

DtRwString DtSystemParameterData::myVariableType

protected

DtRwString DtSystemParameterData::myDisplayLabel

protected

DtRwString DtSystemParameterData::myDisplayUnits

protected

DtRwString DtSystemParameterData::mySourceUnits

protected

DtRwString DtSystemParameterData::myListItems

protected

DtRwInt DtSystemParameterData::myListDisplay

protected

DtRwBoolean DtSystemParameterData::myAllowEdit

protected

DtRwBoolean DtSystemParameterData::myDisplayValue

protected

DtRwString DtSystemParameterData::myRollUpRule

protected

std::auto_ptr<DtSystemParameterDataFactory> DtSystemParameterData::theFactory

staticprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjparam/systemParameterData.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation