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

Inheritance diagram for DtSystemParameterData:

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
	Returns a default value, if it exists. More...

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

virtual bool	operator== (const DtSystemParameterData &) const
	Equivalence operator. More...

virtual void	setRollUpRule (const DtString &)
	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. More...

virtual DtString	rollUpRule () const

virtual void	setListItems (const DtString &)
	Set the list items as a semi-colon separated list of Key=Display Value, for example: Item1=Ammunition;Item2=Weapon. More...

virtual const DtString &	listItems () const

virtual void	getListItems (std::vector< DtString > &keys, std::vector< DtString > &values) const
	Returns, in two vectors, the key and display values. More...

virtual void	setListDisplay (int)
	Sets how to display the list items. More...

virtual int	listDisplay () const

virtual void	setAllowEdit (const bool)
	Determines whether the parameter will show up in the system parameter dialog box in the Simulatino Object Editor as read only. More...

virtual bool	allowEdit () const

virtual void	setDisplayValue (const bool)
	Determines whether or not to show value in system editing dialog. More...

virtual bool	displayValue () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

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

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

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

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

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

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

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...

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

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

virtual void	setVariableName (const DtSymbolString variableName)

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

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

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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

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

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtSystemParameterData *	createSystemParameterData (const DtString &type)
	Uses theFactory to create a DtSystemParamterData subclass of the specified type. More...

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 ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

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
	Container for the aliases which represent alternative names for the object. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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)
	Copies values from the specified DtReaderWriter. More...

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 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.vrf4-10-branch/include/vrfobjparam/systemParameterData.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation