DtReaderWriter Class Reference

The base class for all objects that are part of the ReaderWriter system in VR-Forces. More...

Inherited by BHAVE::DtRwTrafficSinkListEntry, DtActiveSonarBeamListEntry, DtActiveSonarModeEntry, DtActiveSonarSystemEntry, DtAddressMap, DtAggregatedResource, DtAmmoSelectEntry, DtAnimationModel, DtAnimationModel::AnimationChange, DtAttachedTerrain, DtBaseTableFunction, DtBhavePluginOptions, DtCommModelDescriptor, DtComponentDescriptor, DtComponentSystemDefinition, DtComponentSystemDescriptor, DtComponentSystemMetaData, DtConnectionDescriptor, DtCounterMeasureDistractionEntry, DtCSVReaderWriter, DtDetonationDescriptor, DtDIGuyCharAnimationsEntry, DtDmgAngleOfIncidenceTable, DtDmgMunitionEntry, DtEmbarkationSlotEntry, DtEmbarkationSlotManager, DtEmitterBeamListEntry, DtEmitterSystemEntry, DtEntityTargetInformation, DtFireMissionInformation, DtFormationEntry, DtFormationTableEntry, DtFormationType, DtIndirectArtilleryTypesEntry, DtJoyDeviceManager, DtKinematicStateCS, DtLaserSpotData, DtLoadPoint, DtModelSetEntry, DtMtlParameterDbFileData, DtMtlParameterDbFileEntry, DtNLengthIntegerVector, DtNLengthRealVector, DtObjectMapEntry, DtObstacleAreaCompatilibility, DtPathSoilFactor, DtPhysicalWorldParams, DtPlan, DtPrbProbabilityCoefficients, DtPrbRangeDeterminant, DtPromotionEntry, DtPromotionIdObjectNameInformation, DtRadarModeEntry, DtRangeProbEntry, DtReaderWriterFile, DtReaderWriterMember, DtRemoteConfigurationEntry, DtRemoteConfigurationList, DtRemoteConfigurationMapEntry, DtRemoteConfigurationMapper, DtReservedSlot, DtRwAggregateState, DtRwAppearance, DtRwAutoConnection, DtRwBoolean, DtRwBoundingGeometryType, DtRwBoundingVolume, DtRwClockTime, DtRwCondExpr, DtRwDcm, DtRwDeadReckonThresholds, DtRwDeadReckonTypes, DtRwDetectionLevelContainer, DtRwDIGuyAnimationEntry, DtRwDIGuyCharacterInfo, DtRwEntityType, DtRwForceDescription, DtRwForceObjectType, DtRwForces, DtRwForceType, DtRwFormationType, DtRwGaussianPuffData, DtRwGroundInteractionPt, DtRwGuidanceModeType, DtRwIndividualLifeFormStateType, DtRwIndividualLifeFormWeaponStateType, DtRwInt, DtRwIntegerAttribute, DtRwIntrusiveList, DtRwLifeformStaticPosture, DtRwList, DtRwListedObj, DtRwNLengthStringVector, DtRwObjectType, DtRwObjectTypeInfo, DtRwPlanExecutionStackEntry, DtRwRadioEntityType, DtRwRailSegment, DtRwRangedObjectType, DtRwReal, DtRwRealAttribute, DtRwScenarioExtras, DtRwScriptInformation, DtRwScriptReactiveTaskEntry, DtRwSensorContactInfo, DtRwSensorSignature, DtRwShort, DtRwSimulationAddress, DtRwSoilSpeedFactorListEntry, DtRwSpatialFilter, DtRwSpawnData, DtRwSphere, DtRwStaticDynamicPostureListEntry, DtRwString, DtRwStringAttribute, DtRwTaitBryan, DtRwUnsigned, DtRwVariableBindings, DtRwVariableBindingsList, DtRwVector, DtRwVectorObstructionType, DtScenario, DtScenarioBatch, DtScenarioBatchRecord, DtSetDataRequest, DtSignatureModifier, DtSignaturePropagatorDescriptor, DtSimArtPartDescriptor, DtSimCommand, DtSimComponent, DtSimCondExpr, DtSimKinematicState, DtSimMunition, DtSimObjectNetInterface, DtSimObjectStateRepository, DtSimReport, DtSimResource, DtSimSector, DtSimTask, DtSimTaskManager, DtSimTaskState, DtSimulationModelSet, DtSlotExclusion, DtSoilFactors, DtSubordinateEntry, DtSubtaskStatusEntry, DtSuspendedTaskStatusEntry, DtSystemMetaDataEntry, DtSystemParameterData, DtTargetAcquireCriteria, DtTargetPriorityEntry, DtTargetSelectionCriteria, DtTaskExecutionRules, DtTaskGroup, DtTaskMessageDescriptor, DtTaskStatusEntry, DtTerrainConfigurationOptions, DtTerrainInterfaceConfig, DtTriggerData, DtTrueAggregateResource, DtVrfMunitionLoader, DtVrfObject, DtVrfObjectGeometry, DtVrfObjectParameters, DtVrfObjectParametersDB, DtVrfObjectSubComponentTypes, DtVrfProcessStateRepository, DtVrfRadioDescriptor, DtVrfRadioTransmitterParams, DtVrfStateRepositoryUserExtension, DtVrfSubObjectParameterEntry, and makVrf::DtMenuEntry.

Public Types
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()

Public Member Functions
	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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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 (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
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 DtReaderWriterFactory *	factory ()

Protected Member Functions
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

Static Protected Attributes
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Detailed Description

The base class for all objects that are part of the ReaderWriter system in VR-Forces.

ReaderWriter classes and the ReaderWriter system provide a mechanism for serializing objects to a text file that us human readable and editable, and reading that data back into a C++ structure. The data is written to the file in an "mtl" format, which is a list-like format, using key-value pairs.

ReaderWriter objects can be nested within other ReaderWriter objects to create a hierarchy. Each ReaderWriter object reads and writes its immediate children, and relies on those children to read and write their own contents. The ordering of the values within a single block of reader writer data is not relevant, since it is treated as a key-value pair set.

Each DtReaderWriter subclass that contains ReaderWriter children creates those children in its constructor, and gives them both types and names (keys) at that time. When a class is read from file, each key encountered in the file is looked up in the reading class, and the stream is passed to that child for reading. Writing work in a similar way in reverse.

Not all children items of a DtReaderWriter need to exist in the file that is being read. If a particular key is not present in the file being read, then the default value (assigned in the constructor) for that value is used, and that member has it valueSpecified() flag set to false.

Aliases

It is possible to create aliases for a particular key so that multiple keys will cause data to be read into the same data member. This is useful when newer versions of code are reading older files, and some members have changed names, but need to be able to read the old files. See the addAlias() and hasAlias() methods.

Variable Bindings

The ReaderWriter system also supports a concept called variable bindings. This allows substitutions to be made as a file is read by a reader writer class. The class DtRwVariableBindings holds a set of bindings between string variable names and DtReaderWriter instances which will be used in place of those variables when encountered in the reading of a file. The $ character is used as a special variable designation character for this purpose. The types of the DtReaderWriter objects are explicitly indicated in the DtRwVariableBindings, and must match the type of DtReaderWriter object being read when the variable is encountered for the substitution to be successful.

The DtRwVariableBindings class itself is also a DtReaderWriter subclass, and as such can also be placed in the file structures. Each DtReaderWriter block in a file may contain a special "variable-bindings" section at the start, which specifies any variables that will be substituted, and what they will be substituted with for all of its members, as well as all its child members.

As a special case, variables appearing within DtRwString members will be substituted if there is a string type variable defined with the specified name.

Examples

• convertParamDb

Member Typedef Documentation

typedef std::vector<DtSymbolString> DtReaderWriter::aliasContainer

typedef std::vector<DtSymbolString>::iterator DtReaderWriter::aliasIter

typedef std::vector<DtSymbolString>::const_iterator DtReaderWriter::aliasConstIter

typedef std::pair<DtSymbolString, DtString> DtReaderWriter::DtVariableNameType

typedef DtReaderWriterFactory*(* DtReaderWriter::DtReaderWriterFactoryCreatorFcn)()

Constructor & Destructor Documentation

DtReaderWriter::DtReaderWriter

(

)

default constructor

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

real constructor Setting the readonly flag prevents object from writing itself to the stream.

By default, DtReaderWriter objects are read/write.

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

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

copy constructor

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

virtual DtReaderWriter::~DtReaderWriter ( )

virtual

destructor

Member Function Documentation

const DtReaderWriter& DtReaderWriter::operator=

(

const DtReaderWriter &

orig

)

assignment operator

bool DtReaderWriter::operator==

(

const DtReaderWriter &

)

const

Equivalence operator.

Referenced by DtSuspendedTaskInfo::operator!=().

bool DtReaderWriter::operator!= ( const DtReaderWriter &  rhs )

inline

virtual void DtReaderWriter::putSelf ( FILE *  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtFilename::nullFilename()  )

virtual

Top level call to write itself to file.

If write unspecified is true, will write entries that are unspecified, in the format (name <use-default>). Path is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the path is specified with a non-NULL string, then the path prepended to the filename before writing the entry to file.

Reimplemented in DtPlan, DtAnimationModel, DtScenario, DtSurfaceMovementPSR, DtAutomotivePSR, DtVrfObjectStateRepository, DtMissileStateRepository, DtVrfObject, DtFixedWingFlightPSR, DtVrfProcessStateRepositoryManager, DtSimKinematicState, DtRotaryWingFlightPSR, DtAggregateMoveAlongPSR, DtDamageComponentDescriptor, DtPseudoAggregateMovementPSR, DtAggregatedMoveAlongPSR, DtHumanMoveAlongPSR, Dt1DRegularTableFn, DtDamageAdjudicationComponentDescriptor, DtObjectSensorPSR, DtScenarioBatchRecord, DtMissileDistractionPSR, DtVrfOccupancyDirectorPSR, DtReaderWriterFile, DtTaskStmt, DtSetDataRequestStmt, DtRwRailSegment, DtSimCommandStmt, DtCombatIdentificationLevelTable, DtAggregateMoveToPSR, DtCSVReaderWriter, DtScriptReactiveTaskControllerPSR, DtTaskMessageDescriptor, DtSuspendedTaskInfo, and DtScriptMultiTaskControllerPSR.

virtual void DtReaderWriter::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath = DtFilename::nullFilename(), const DtVariableBindingsList &  variableBindings = nullVariableReference()  )

virtual

Top level to read itself from an input stream.

searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

virtual void DtReaderWriter::writeSelf ( FILE *  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtFilename::nullFilename()  )

virtual

Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.

Reimplemented in makVrf::DtMenu, DtModelSet, DtCSVReaderWriter, DtIndirectArtilleryTypesManager, and DtRwVariableBindings.

virtual DtSymbolString DtReaderWriter::name ( ) const

virtual

Accessor for name of this readable/writable object.

Reimplemented in DtObstacleAreaCompatilibility.

Referenced by DtSimBlock::clone(), DtRwToXml::DtSoilFactorsToEnvValue(), vrfXml::RwTypeToXmlType(), DtRwSensorContactInfo::setContactName(), DtFireMissionInformation::setTargetName(), DtEntityTargetInformation::setTargetName(), and DtStringRepHelper::stringRep().

static void DtReaderWriter::putIndent ( FILE *  fp, int  indentLevel  )

static

static const DtVariableBindingsList& DtReaderWriter::nullVariableReference ( )

static

Returns

An empty DtVariableBindingList, which can be passed to getSelf() methods if there are no variables to bind.

virtual void DtReaderWriter::setValueSpecified ( bool  specified, bool  recurse = false  )

virtual

The specified flags are used for optional values.

On construction, all objects are marked as specified (for backward compatibility). If an object should be optional, the deriving constructor can mark it as unspecified. Objects are marked as specified if read (by getSelf) and unspecified objects are not written. The user should mark such optional objects as specified in any mutator that provides it with a real value. The specified accessor can be used by an including object to see if an object has had a value specified for it. If recurse is true, calls setValueSpecified() on its myRegistry data member, recursively calling setValueSpecified() over the structure. If recurse is false, the specified flag is only set in this object and not in any of the members in myRegistry.

Referenced by DtVrfIffPSR::setIffInformation().

virtual bool DtReaderWriter::valueSpecified ( ) const

virtual

The specified flags are used for optional values.

On construction, all objects are marked as specified (for backward compatibility). If an object should be optional, the deriving constructor can mark it as unspecified. Objects are marked as specified if read (by getSelf) and unspecified objects are not written. The user should mark such optional objects as specified in any mutator that provides it with a real value. The specified accessor can be used by an including object to see if an object has had a value specified for it. If recurse is true, calls setValueSpecified() on its myRegistry data member, recursively calling setValueSpecified() over the structure. If recurse is false, the specified flag is only set in this object and not in any of the members in myRegistry.

virtual void DtReaderWriter::addAlias ( const DtSymbolString &  alias )

virtual

Add an alias as an alternative name for this object.

virtual bool DtReaderWriter::hasAlias ( const DtSymbolString &  alias )

virtual

Returns

true if we have the given alias, false if not.

virtual const aliasContainer& DtReaderWriter::aliases ( ) const

virtual

Returns

Container of all aliases set for this item.

virtual void DtReaderWriter::setReadonly ( bool  flag )

virtual

Set read-only flag.

virtual bool DtReaderWriter::isReadonly ( ) const

virtual

Returns

true if object is readonly, false if not.

virtual bool DtReaderWriter::isVariableReference ( ) const

virtual

Specifies whether or not this reader writer is really a variable that is specified elsewhere.

virtual void DtReaderWriter::setIsVariableReference ( bool  value )

virtual

Note

Be sure to set a variable name if setting the object to be a variable reference.

virtual void DtReaderWriter::clearAllVariableReferenceFlags ( )

virtual

Clears out all variable reference flags from all readerwriter items in registry recursively.

virtual DtSymbolString DtReaderWriter::variableName ( ) const

virtual

The variable name, if this object is a variable reference.

The variable name is only used if the object is also set to be a variable reference.

See Also

isVariableReference().

virtual void DtReaderWriter::setVariableName ( const DtSymbolString  variableName )

virtual

The variable name, if this object is a variable reference.

The variable name is only used if the object is also set to be a variable reference.

See Also

isVariableReference().

virtual bool DtReaderWriter::variableIsBound ( ) const

virtual

Returns

True if this reader writer is a variable reference, and the variable is currently bound to a value. This value can only be set by calling bindVariables on this object or an object in its parent hierarchy.

virtual void DtReaderWriter::unbindVariable ( )

virtual

Sets the myVariableIsBound flag to false.

This will force the variable name to be written out instead of the value if the RW object is written. This should only be used if a variable name has been assigned.

static void DtReaderWriter::setPostGetSelfCallback ( DtGetSelfCallbackFcn  fcn, void *  usrData  )

static

static void DtReaderWriter::setPrePutSelfCallback ( DtPutSelfCallbackFcn  fcn, void *  usrData  )

static

const DtReaderWriterRegistry & DtReaderWriter::registry ( ) const

inline

Collection of child DtReaderWriter nodes owned by this object.

Reimplemented in DtReaderWriterMember.

References myRegistry.

Referenced by DtBufferSerialize::decode(), and DtStringRepHelper::stringRep().

DtReaderWriterRegistry & DtReaderWriter::registry ( )

inline

Collection of child DtReaderWriter nodes owned by this object.

Reimplemented in DtReaderWriterMember.

References myRegistry.

virtual void DtReaderWriter::setName ( const DtString &  )

virtual

Set the name of the object.

Uses the myName variable. Only set if you understand that this could have effects on other parts of the system that are unknown (especially if this item has already been added to a registry).

Under normal usage, this name is set as a process of creating an item from a factory or as part of a constructor. Only use this method if an item is created from a factory, and the name is not known until after created from that factory, before adding to the registry of another item

Referenced by DtXmlToRw::DtEnvValueToRwSoilFactors().

virtual const char* DtReaderWriter::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented in DtAnimationModel, DtReaderWriterMember, DtRwListedObj, DtRwAnimationModelString, DtRwOrSpatialFilter, DtRwObjectName, DtRwIntrusiveList, DtSimResource, DtReaderWriterFile, DtRwList, DtRwOffsetVector, DtSensorContactInfoList, DtRwAndSpatialFilter, DtRwRangedObjectType, DtRwUnsigned, DtFormationTable, DtRwEntityType, DtEmbarkationSlotEntry, DtRwGuidanceModeType, DtRwNLengthStringVector, DtRwShort, DtCombatIdentificationLevelTable, DtRwInt, DtSoilList, DtRwIndividualLifeFormStateType, DtRwReal, DtRwVariableBindings, DtSimMunition, DtRwDIGuyAnimationsList, DtRwVectorObstructionTypeList, DtTargetPriorityList, DtRwStringAttributeList, DtSoilFactors, DtDmgMunitionTable, DtCSVReaderWriter, DtFormationType, DtRwObjectTypeList, DtVrfSubObjectParameterEntry, DtRwDcm, DtRwFormationType, DtRwObjectType, DtRwRailSegment, DtSimArtPartDescriptorList, DtSimMunitionList, DtCombatIdentificationLevelTableEntry, DtRwRealAttributeList, DtEmitterBeamList, DtBaseTableFunction, DtRwIndividualLifeFormWeaponStateType, DtRwIntegerAttributeList, DtSimArtPartParamList, DtActiveSonarBeamList, DtRwRadioEntityType, DtRwSoilSpeedFactorList, DtRwTemplatedListPtr< T, T_autoDelete >, DtRwTemplatedListPtr< DtRwAutoConnection >, DtRwTemplatedListPtr< DtTargetAcquireCriteria >, DtRwTemplatedListPtr< DtRwObjectTypeInfo >, DtRwTemplatedListPtr< DtPathSoilFactor >, DtRwTemplatedListPtr< DtTaskGroup >, DtRwTemplatedListPtr< DtRwString >, DtRwTemplatedListPtr< DtSubtaskStatusEntry >, DtRwTemplatedListPtr< DtSuspendedTaskStatusEntry, true >, DtRwTemplatedListPtr< DtSlotExclusion >, DtRwTemplatedListPtr< DtRwTrafficSinkListEntry >, DtRwTemplatedListPtr< DtRwSensorSignature >, DtRwTemplatedListPtr< DtRwGaussianPuffData >, DtRwTemplatedListPtr< DtMtlParameterDbFileEntry >, DtRwTemplatedListPtr< DtSuspendedTaskInfo, true >, DtRwTemplatedListPtr< DtPromotionIdObjectNameInformation >, DtRwTemplatedListPtr< DtRwScriptReactiveTaskEntry >, DtRwTemplatedListPtr< DtLoadPoint >, DtRwTemplatedListPtr< DtRwVector >, DtRwTemplatedListPtr< DtRwRailSegment >, DtRwTemplatedListPtr< DtRwScriptInformation >, DtRwTemplatedListPtr< DtLaserSpotData >, DtRwTemplatedListPtr< DtReservedSlot >, DtRadarModeList, DtRwBoolean, Dt1DRegularTableFn, DtActiveSonarModeList, DtSimResourceList, DtRwLifeformStaticPosture, DtRwBoundingVolume, DtRwClockTime, DtRwGaussianPuffData, DtRwSphere, DtRwTaitBryan, DtRwAggregateState, DtRwDeadReckonTypes, DtRwString, Dt1DTableFn, DtCombatIdentificationDetectionIntervalEntry, DtNLengthIntegerVector, DtRwForceType, DtTrueAggregateResourceList, DtRwForces, DtRwVectorObstructionType, DtRwVector, DtFormationTableEntry, DtSimResourceManager, DtRwAppearance, DtRwDeadReckonThresholds, DtNLengthRealVector, DtRwIntegerAttribute, DtRwRealAttribute, DtRwStaticDynamicPostureList, DtRwStringAttribute, DtAttachedTerrain, DtVrfSubObjectParameterList, DtRwSpawnData, DtRwSimulationAddress, DtRwSpawnDataList, DtMunitionResource, DtRwSetDataRequestList, DtComponentDescriptorList, DtRwFrustumSpatialFilter, DtRwVariableBindingsList, DtRwNotSpatialFilter, DtRwBoundingGeometryType, DtConnectionDescriptorList, DtRwRangeSpatialFilter, DtLoadPoint, DtComponentSystemDescriptorList, DtSlotExclusion, DtRwObjectTypeInfo, DtRwSpatialFilterContainer, DtSignatureModifierList, DtAggregatedResourceList, DtRwStringList, DtSubordinateObjectsList, DtRwScenarioExtras, DtSystemMetaDataEntryList, DtSystemParameterDataList, DtRwSensorSignatureList, DtRwSoilSpeedFactorListEntry, DtRwDIGuyCharacterInfo, DtRwAutoConnection, and DtRwScriptReactiveTaskEntry.

Referenced by DtRwToXml::Converter::convert(), DtXmlToRw::Converter::convert(), and vrfXml::RwTypeToXmlType().

virtual DtString DtReaderWriter::prettyPrint ( ) const

virtual

Routine to return a human readable form of the reader/writer variable.

Not all reader/writer classes implement this feature. Default is to return an empty string

Reimplemented in DtRwNLengthStringVector, DtRwVariableBindings, DtRwEntityType, DtRwInt, DtRwReal, DtRwString, DtRwBoolean, DtRwForceType, and DtRwVector.

Referenced by DtRwToXml::DtBasicTypeToEnvValue(), and DtStringRepHelper::stringRep().

virtual void DtReaderWriter::bindVariables ( DtVariableBindingsList  variableBindings )

virtual

Runs a variable binding pass on this reader writer and any of its children.

The list passed in specified pointers to DtRwVariableBindings instances. Variables are searched for starting at the beginning of the list, so if any variables are listed twice, then the ones earlier in the list take precedence. This method recurses by calling bindVariables() on all the children objects of this reader writer after first adding this objects variable bindings to the start of the list.

virtual std::list<DtVariableNameType> DtReaderWriter::unboundVariables ( ) const

virtual

Returns

A list containing all the currently unbound variables from this RW object, and all of its children. List contains the names and types of the variables.

static const DtFilename& DtReaderWriter::appPath ( )

static

Gets the current working directory.

The first time this accessor is called, it determines the current working directory, sets it in theAppPath, and returns theAppPath. Subsequent calls to this function just return theAppPath.

Reimplemented in DtReaderWriterFile.

bool DtReaderWriter::invalid ( ) const

inline

References myInvalid.

virtual bool DtReaderWriter::hasChild ( const DtReaderWriter *  p ) const

virtual

Returns true if this variable has a child p in it's chain.

static void DtReaderWriter::setFactoryCreatorFunction ( DtReaderWriterFactoryCreatorFcn  fcn )

static

Sets the function to create the DtReaderWriterFactory.

static void DtReaderWriter::createReaderWriterFactory ( )

static

static DtReaderWriterFactory* DtReaderWriter::factory ( )

static

Returns

A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented in DtVrfObject, DtVrfObjectParameters, DtSimComponent, DtVrfObjectStateRepository, DtSimTaskManager, DtSimStatement, DtComponentDescriptor, DtSimCondExpr, DtSimResource, DtSimTask, DtSimCommand, DtSetDataRequest, DtSimObjectNetInterface, DtVrfRadioDescriptor, DtSimReport, DtSimTaskState, DtCommModelDescriptor, DtVrfProcessStateRepository, DtSubordinateEntry, DtSignaturePropagatorDescriptor, DtVrfStateRepositoryUserExtension, DtSystemParameterData, and DtSystemMetaDataEntry.

Referenced by DtXmlUtils::CreateRwObject().

virtual void DtReaderWriter::bindToRwAsVariable ( const DtReaderWriter *  rw )

protectedvirtual

Copies values from the specified DtReaderWriter.

rw must point to the same subclassed type of DtReaderWriter as this instance is. Sets myVariableIsBound to true if variable binding is successful.

virtual void DtReaderWriter::bindLocalVariables ( const DtVariableBindingsList &  variableBindings )

protectedvirtual

Checks to see if this RW object is a variable reference that can be bound using the provided bindings.

If so, it binds it. Does not check any children objects of this object.

virtual void DtReaderWriter::putData ( FILE *  fp, int  indentLevel = 0  )

protectedvirtual

Deriving class overrides these to get/put class specific data.

Reimplemented in DtVrfObjectStateRepository, DtVrfObjectParameters, DtReaderWriterMember, DtSimComponent, DtEmbarkationSlotManager, DtRemoteConfigurationMapper, DtRemoteConfigurationList, DtRemoteConfigurationMapEntry, DtSimObjectStateRepository, Dt1DRegularTableFn, DtVrfRadioDescriptor, DtRwRangedObjectType, DtSimTask, DtCSVReaderWriter, Dt1DTableFn, DtSetDataRequest, DtRwUnsigned, DtRwEntityType, DtComponentDescriptor, DtSimCommand, DtRwGuidanceModeType, DtRwNLengthStringVector, DtRwShort, DtRwInt, DtRwReal, DtSimResource, DtSendTaskMessageTask, DtSetDataCommand, DtSendSetMessageTask, DtTaskCommand, DtCommModelDescriptor, DtRwDcm, DtRwObjectType, DtFormationType, DtBaseTableFunction, DtRwIndividualLifeFormWeaponStateType, DtSimReport, DtRwFormationType, DtRwRadioEntityType, DtRwBoolean, DtRwIndividualLifeFormStateType, DtSimTaskState, DtRwLifeformStaticPosture, DtRwBoundingVolume, DtRwClockTime, DtRwSphere, DtRwTaitBryan, DtRwDeadReckonTypes, DtRwString, DtSignaturePropagatorDescriptor, DtRwAppearance, DtRwForceType, DtRwCondExpr, DtRwForces, DtTaskMessageDescriptor, DtConnectionDescriptor, DtPrbRangeTableEntry, DtNLengthIntegerVector, DtRwAggregateState, DtRwIntegerAttribute, DtRwRealAttribute, DtRwStringAttribute, DtRwVector, DtNLengthRealVector, DtRwSimulationAddress, DtPrbProbabilityCoefficients, DtRwBoundingGeometryType, and DtRwGroundInteractionPt.

virtual DtlObjPtr DtReaderWriter::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

Deriving class overrides these to get/put class specific data.

Member Data Documentation

const DtSymbolString DtReaderWriter::myName

protected

DtReaderWriterRegistry DtReaderWriter::myRegistry

protected

Referenced by registry().

bool DtReaderWriter::myValueSpecified

protected

bool DtReaderWriter::myReadOnlyFlag

protected

bool DtReaderWriter::myIsVariableReference

protected

DtSymbolString DtReaderWriter::myVariableName

protected

bool DtReaderWriter::myVariableIsBound

protected

aliasContainer DtReaderWriter::myAliases

protected

Container for the aliases which represent alternative names for the object.

DtString DtReaderWriter::theUnspecifiedValue

staticprotected

DtGetSelfCallbackInfo DtReaderWriter::thePostGetSelfCallback

staticprotected

DtPutSelfCallbackInfo DtReaderWriter::thePrePutSelfCallback

staticprotected

const DtVariableBindingsList DtReaderWriter::theEmptyVariableBindingsList

staticprotected

bool DtReaderWriter::theCreatorFcnSet

staticprotected

DtReaderWriterFactory* DtReaderWriter::theFactory

staticprotected

DtReaderWriterFactoryCreatorFcn DtReaderWriter::theFactoryCreatorFcn

staticprotected

bool DtReaderWriter::myInvalid

protected

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

Referenced by invalid().

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/rdrWritr.h