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

Inherits DtObjectDebugger< DtReaderWriter >.

Inherited by DtActiveSonarBeamListEntry, DtActiveSonarModeEntry, DtActiveSonarSystemEntry, DtAddressMap, DtAggregatedMovementDescriptor::MobilityEntry, DtAggregatedResource, DtAmmoSelectEntry, DtAnimationModel, DtAnimationModel::AnimationChange, DtAssembliesReaderWriter, DtAssembliesReaderWriter::RwRootNode, DtAttachedTerrain, DtBaseTableFunction, DtCommModelDescriptor, DtComponentDescriptor, DtComponentSystemDefinition, DtComponentSystemDescriptor, DtComponentSystemMetaData, DtConnectionDescriptor, DtCounterMeasureDistractionEntry, DtCSVReaderWriter, DtDetonationDescriptor, DtDiGuyCharacterAnimationsEntry, DtDmgAngleOfIncidenceTable, DtDmgMunitionEntry, DtEmbarkationSlotEntry, DtEmbarkationSlotManager, DtEmitterBeamListEntry, DtEmitterSystemEntry, DtEntityTargetInformation, DtFeatureAreaSignatureModifierEntry, DtFireMissionInformation, DtFormationEntry, DtFormationTableEntry, DtFormationType, DtGroundInteractionPt, DtIndirectArtilleryTypesEntry, DtKinematicStateCS, DtLaserSpotData, DtLoadPoint, DtModelSetEntry, DtMtlParameterDbFileData, DtMtlParameterDbFileEntry, DtNLengthIntegerVector, DtNLengthRealVector, DtObjectMapEntry, DtObstacleAreaCompatilibility, DtPathCostEntry, DtPhysicalWorldParams, DtPlan, DtPrbProbabilityCoefficients, DtPrbRangeDeterminant, DtPromotionEntry, DtPromotionIdUUIDInformation, DtRadarModeEntry, DtRangeProbEntry, DtReaderWriterFile, DtRemoteConfigurationEntry, DtRemoteConfigurationList, DtRemoteConfigurationMapEntry, DtRemoteConfigurationMapper, DtReservedSlot, DtRwAffectableEngineeringObject, DtRwAggregateState, DtRwAltitudes, DtRwAppearance, DtRwAutoConnection, DtRwBoolean, DtRwBoundingGeometryType, DtRwBoundingVolume, DtRwChannelDescriptor, DtRwClockTime, DtRwColor, DtRwCondExpr, DtRwContaminationArea, DtRwDcm, DtRwDeadReckonThresholds, DtRwDeadReckonTypes, DtRwDetectionLevelContainer, DtRwDIGuyAnimationEntry, DtRwDIGuyCharacterInfo, DtRwEmbeddedEntity, DtRwEmbeddedEntityStatus, DtRwEmbeddedEntityTaskState, DtRwEngagementInfo, DtRwEntityIdentifier, DtRwEntityType, DtRwForceDescription, DtRwForceObjectType, DtRwForces, DtRwForceType, DtRwFormationType, DtRwGaussianPuffData, DtRwGuidanceModeType, DtRwHazardAreaInformation, DtRwHazardType, DtRwIndividualLifeFormStateType, DtRwIndividualLifeFormWeaponStateType, DtRwInt, DtRwIntegerAttribute, DtRwIntrusiveList, DtRwJoystickControl, DtRwLifeformStaticPosture, DtRwList, DtRwListedObj, DtRwNavGenConfig, DtRwNavigationProfile, DtRwNavigationProfileFeatureEntry, DtRwNavigationProfileList, DtRwNavRuntimeConfig, DtRwNavRuntimeProfileEntry, DtRwNLengthStringVector, DtRwNLengthUUIDVector, DtRwObjectType, DtRwObjectTypeInfo, DtRwPlanExecutionStackEntry, DtRwRadioEntityType, DtRwRailSegment, DtRwRangedObjectType, DtRwReal, DtRwRealAttribute, DtRwScenarioEvent, DtRwScenarioExtras, DtRwScriptInformation, DtRwScriptReactiveTaskEntry, DtRwScriptVariables, DtRwSensorContactInfo, DtRwSensorSignature, DtRwShort, DtRwSimulationAddress, DtRwSoilSpeedFactorListEntry, DtRwSpatialFilter, DtRwSpawnData, DtRwSphere, DtRwSpotReportDelta, DtRwStaticDynamicPostureListEntry, DtRwString, DtRwStringAttribute, DtRwTaitBryan, DtRwTrafficSinkListEntry, DtRwTranslatableStringObject, DtRwUnsigned, DtRwUserQuestion, DtRwUserQuestionHandler, DtRwUUID, DtRwVariableBindings, DtRwVariableBindingsList, DtRwVector, DtRwVectorObstructionType, DtScenario, DtScenarioBatch, DtScenarioBatchRecord, DtSensorFieldOfViewEntry, DtSetDataRequest, DtSignatureModifier, DtSignaturePropagatorDescriptor, DtSimArtPartDescriptor, DtSimCommand, DtSimComponent, DtSimCondExpr, DtSimKinematicState, DtSimMunition, DtSimObjectNetInterface, DtSimObjectStateRepository, DtSimReport, DtSimResource, DtSimSector, DtSimTask, DtSimTaskManager, DtSimTaskState, DtSimulationModelSet, DtSimulationObjectBaseState, DtSlotExclusion, DtSoilFactors, DtSubordinateEntry, DtSubtaskStatusEntry, DtSuspendedTaskStatusEntry, DtSystemMetaDataEntry, DtSystemParameterData, DtTargetAcquireCriteria, DtTargetPriorityEntry, DtTargetSelectionCriteria, DtTaskExecutionRules, DtTaskGroup, DtTaskMessageDescriptor, DtTaskStatusEntry, DtTerrainInterfaceConfig, DtTriggerData, DtTrueAggregateResource, DtVrfMunitionLoader, DtVrfObject, DtVrfObjectGeometry, DtVrfObjectParameters, DtVrfObjectParametersDB, DtVrfObjectSubComponentTypes, DtVrfObserverSettingsRecord, DtVrfObserverStateRecord, 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::vector< DtFilename >	SearchPaths
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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.
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 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.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.

virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

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.

virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.

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

virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const

Static Public Member Functions
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.
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 void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
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.
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
static bool	thePutIndent
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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.
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.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.

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::vector<DtFilename> DtReaderWriter::SearchPaths

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

pseudo-copy constructor

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

DtReaderWriter::DtReaderWriter	(	const DtReaderWriter &	,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

explicit

copy constructor

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	(	std::string &	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 DtRwUUID, DtVrfObject, DtPlan, DtAnimationModel, DtScenario, DtVrfObjectStateRepository, DtRwVrfObjectReference, DtSurfaceMovementPSR, DtAutomotivePSR, DtFixedWingFlightPSR, DtRotaryWingFlightPSR, DtSimKinematicState, DtVrfProcessStateRepositoryManager, DtAggregateMoveAlongPSR, DtHumanMoveAlongPSR, DtAggregatedMoveAlongPSR, DtObjectSensorPSR, Dt1DRegularTableFn, DtDamageAdjudicationComponentDescriptor, DtReaderWriterFile, DtScenarioBatchRecord, DtTaskStmt, DtSetDataRequestStmt, DtRwRailSegment, DtSimCommandStmt, DtCombatIdentificationLevelTable, DtCSVReaderWriter, DtScriptReactiveTaskControllerPSR, DtTaskMessageDescriptor, DtSuspendedTaskInfo, DtScriptMultiTaskControllerPSR, and DtRwPropertiesStructure.

virtual void DtReaderWriter::postPutSelf ( )

virtual

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

Reimplemented in DtRwActivities.

virtual void DtReaderWriter::prePutSelf ( )

virtual

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

Reimplemented in DtRwActivities.

virtual void DtReaderWriter::getSelf	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths = `SearchPaths()`,
		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.

Referenced by DtAssembliesReaderWriter::RwRootNode::getSelf().

virtual void DtReaderWriter::postGetSelf ( )

virtual

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

Reimplemented in DtHumanStateRepository, DtVrfAggregateStateRepository, DtSimObjectStateRepository, and DtRwActivities.

virtual void DtReaderWriter::preGetSelf ( )

virtual

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

Reimplemented in DtHumanStateRepository, DtVrfAggregateStateRepository, and DtSimObjectStateRepository.

virtual void DtReaderWriter::writeSelf	(	std::string &	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 DtRwProperties, DtModelSet, makVrf::DtMenu, DtCSVReaderWriter, DtIndirectArtilleryTypesManager, DtRwPropertiesList, DtRwPropertiesMap, and DtRwVariableBindings.

virtual void DtReaderWriter::putData	(	std::string &	fp,
		int	indentLevel = `0`
	)

virtual

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

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

virtual DtlObjPtr DtReaderWriter::getData	(	DtlObjPtr	args,
		const SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

virtual

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

virtual DtSymbolString DtReaderWriter::name ( ) const

virtual

Accessor for name of this readable/writable object.

Reimplemented in DtObstacleAreaCompatilibility.

Referenced by DtSimBlock::clone(), DtVariableParameterReaderWriter< _Container >::createRwStructure(), DtTypeId(), DtRwIntelCollectionArea::modifierForForce(), DtRwSensorContactInfo::setContact(), and DtRwTranslatableStringObject::translate().

static void DtReaderWriter::putIndent	(	std::string &	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 void DtReaderWriter::addAlias ( const DtString & alias )

virtual

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.

bool DtReaderWriter::isReadonly ( ) const

inline

Returns: true if object is readonly, false if not.

Reimplemented in DtRwProperties.

virtual void DtReaderWriter::reset ( )

virtual

For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.

Reimplemented in DtPlan, DtAnimationModel, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwList, DtRwProperties, DtDiGuyController, DtRwInt, DtRwString, DtSwingingPartActuator, DtRwBoolean, and DtRwReal.

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 int DtReaderWriter::alignment ( ) const

virtual

For those items that are sent over the network via HLA, this will give the network alignment.

Currently only items that are also DtRwProperty items support this method

Reimplemented in DtRwInt, DtRwReal, DtRwBoolean, and DtRwString.

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

virtual

The default value to use if the reader/writer object is a variable and that variable is not specified.

This will also be written out when the reader/writer is written

virtual DtReaderWriter* DtReaderWriter::defaultRWValue ( )

virtual

The default value to use if the reader/writer object is a variable and that variable is not specified.

This will also be written out when the reader/writer is written

virtual void DtReaderWriter::setDefaultRWValue ( DtReaderWriter * )

virtual

Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.

Set to NULL to remove any default value

virtual bool DtReaderWriter::checkAndSetDefaultRWValue	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths = `SearchPaths()`,
		const DtVariableBindingsList &	variableBindings = `nullVariableReference()`
	)

virtual

Give the stream, if the stream contains a default value then set it here.

Only call this method when a variable is present in the stream. Returns true if a default value was set

virtual DtString DtReaderWriter::toXml ( ) const

virtual

Routines to archive/dearchive from an XML Environment

Reimplemented in DtVrfObserverStateRecord.

static DtReaderWriter* DtReaderWriter::createFromXmlFile ( const DtFilename & )

static

Given a filename, returns a newly created reader/writer object from the object found within.

static DtReaderWriter* DtReaderWriter::createFromXml ( const DtString & )

static

Given a xml string, returns a newly created reader/writer object from the object found within.

static DtReaderWriter* DtReaderWriter::createFromEnvironment ( DtEnvironmentSP )

static

Given a xml environment, returns a newly created reader/writer object from the object found within.

virtual bool DtReaderWriter::toXml ( const DtFilename & ) const

virtual

Writes contents of xml result to the given filename.

virtual bool DtReaderWriter::fromXml ( const DtString & )

virtual

Restores object from given xml string. Returns true if valid.

Reimplemented in DtChangeWeatherCommand.

virtual bool DtReaderWriter::fromXmlFile ( const DtFilename & )

virtual

Restires object from given xml file.

Reimplemented in DtChangeWeatherCommand.

virtual void DtReaderWriter::putSelf	(	DtEnvironmentSP	,
		DtEnvValueSP	parent
	)		const

virtual

Routines to archive/dearchive from an XML Environment

Reimplemented in DtRwUUID.

static DtString DtReaderWriter::getAttribute	(	DtEnvironmentSP	env,
		const DtString &	name,
		DtEnvValueSP	root
	)

static

Gets the named attribute from a DtEnvValueSP.

Returns "" if the attribute is not found. Note that some attribute names are reserved, and will not work, for example "name" and "type".

Referenced by DtVrfXmlUtils::getPlatform().

virtual void DtReaderWriter::putData	(	DtEnvironmentSP	,
		DtEnvValueSP	value
	)		const

virtual

Override to add attributes of actual data.

Reimplemented in DtRwUUID, DtRwList, DtRwOffsetVector, DtFormationTable, DtRwPropertiesList, DtRwNLengthUUIDVector, DtRwNLengthStringVector, DtEmbarkationSlotEntry, DtRwEntityType, DtRwString, DtFormationTableEntry, DtRwPropertiesMap, DtSoilFactors, DtRwObjectType, DtVrfSubObjectParameterEntry, DtRwTaitBryan, DtNLengthIntegerVector, DtNLengthRealVector, DtRwEntityIdentifier, DtRwReal, DtRwIntegerAttribute, DtRwStringAttribute, DtRwBoolean, DtRwVector, DtRwBoundingVolume, DtRwInt, DtLoadPoint, DtSlotExclusion, DtRwPropertiesStructure, and DtRwBoundingGeometryType.

virtual void DtReaderWriter::putVariableReference	(	DtEnvironmentSP	,
		DtEnvValueSP	value
	)		const

virtual

Called when the item is a variable reference.

virtual void DtReaderWriter::getSelf	(	const DtEnvironmentSP	,
		const DtEnvValueSP	root,
		const SearchPaths &	searchPaths = `SearchPaths()`,
		const DtVariableBindingsList &	bindings = `DtVariableBindingsList()`
	)

virtual

Routines to archive/dearchive from an XML Environment

virtual void DtReaderWriter::getData	(	const DtEnvironmentSP	,
		const DtEnvValueSP	,
		const SearchPaths &	searchPaths = `SearchPaths()`,
		const DtVariableBindingsList &	bindings = `DtVariableBindingsList()`
	)

virtual

Gets data from the environment value.

virtual void DtReaderWriter::unrecognizedItem	(	const DtEnvironmentSP	env,
		const DtEnvValueSP	root,
		const SearchPaths &	searchPaths,
		const DtVariableBindingsList &	varBindings
	)

virtual

Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.

virtual void DtReaderWriter::getVariableReference	(	DtEnvironmentSP	,
		DtEnvValueSP	value
	)

virtual

Called when the item is a variable reference.

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

static void DtReaderWriter::setPutIndent ( bool )

static

static bool DtReaderWriter::putIndent ( )

static

const DtReaderWriterRegistry & DtReaderWriter::registry ( ) const

inline

Collection of child DtReaderWriter nodes owned by this object.

References myRegistry.

Referenced by DtVariableParameterReaderWriter< _Container >::createRwStructure(), DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >::encodeProperties(), makVrf::DtSetStatePropertyDialog::setupGui(), and DtRemoteExtendedPropertiesNetInterface< DtVrfRemoteEnvironmentalNetInterface, DtControlObjectRepository >::updatePropertyAttributesFromNet().

DtReaderWriterRegistry & DtReaderWriter::registry ( )

inline

Collection of child DtReaderWriter nodes owned by this object.

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 DtVariableParameterReaderWriter< _Container >::createRwStructure().

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

static const char* DtReaderWriter::theXmlType ( )

static

The type that is used when archiving to an XML stream.

Referenced by DtSimulationObjectBaseState::xmlType(), DtRwPropertiesStructure::xmlType(), DtRwScriptVariables::xmlType(), DtRwUserQuestion::xmlType(), DtRwBoundingGeometryType::xmlType(), DtRwPropertiesList::xmlType(), DtRwJoystickControl::xmlType(), DtRwTranslatableStringObject::xmlType(), DtSlotExclusion::xmlType(), DtRwContaminationArea::xmlType(), DtLoadPoint::xmlType(), DtRwInt::xmlType(), DtRwBoundingVolume::xmlType(), DtRwVector::xmlType(), DtRwHazardType::xmlType(), DtRwBoolean::xmlType(), DtRwReal::xmlType(), DtRwEntityIdentifier::xmlType(), DtNLengthRealVector::xmlType(), DtRwStringAttribute::xmlType(), DtRwIntegerAttribute::xmlType(), DtNLengthIntegerVector::xmlType(), DtRwScenarioEvent::xmlType(), DtRwTaitBryan::xmlType(), DtVrfSubObjectParameterEntry::xmlType(), DtRwObjectType::xmlType(), DtSoilFactors::xmlType(), DtFormationTableEntry::xmlType(), DtRwString::xmlType(), DtRwEntityType::xmlType(), DtEmbarkationSlotEntry::xmlType(), DtRwNLengthStringVector::xmlType(), DtRwNLengthUUIDVector::xmlType(), DtRwHazardAreaInformation::xmlType(), DtRwList::xmlType(), and DtRwUUID::xmlType().

virtual const char* DtReaderWriter::xmlType ( ) const

inlinevirtual

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 DtRwNLengthUUIDVector, DtRwNLengthStringVector, DtRwInt, DtRwReal, DtRwVariableBindings, DtRwEntityType, DtRwBoolean, DtRwString, DtRwVector, DtVrfObserverStateRecord, DtRwForceType, DtRwEntityIdentifier, DtRwVectorList, DtRwChannelDescriptor, and DtRwChannelSettings.

std::string DtReaderWriter::debugText ( ) const

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 void DtReaderWriter::cleanupFactory ( )

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, DtVrfObjectStateRepository, DtSimComponent, DtSimTaskManager, DtSimStatement, DtComponentDescriptor, DtSimResource, DtSimTask, DtSimCondExpr, DtSimCommand, DtSetDataRequest, DtSimObjectNetInterface, DtVrfRadioDescriptor, DtSimReport, DtSimTaskState, DtCommModelDescriptor, DtVrfProcessStateRepository, DtSubordinateEntry, DtSignaturePropagatorDescriptor, DtSystemParameterData, DtVrfStateRepositoryUserExtension, and DtSystemMetaDataEntry.

Referenced by DtVrfXmlUtils::CreateRwObject(), DtVariableParameterReaderWriter< _Container >::createRwStructure(), and DtVariableParameterReaderWriter< _Container >::DtVariableParameterReaderWriter().

virtual bool DtReaderWriter::hasVariableReference ( ) const

virtual

Returns true if this item or any item in the registry (recursive) is a variable reference.

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

virtual

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 DtPropertyInterface* DtReaderWriter::property ( )

virtual

Returns a PropertyInterface pointer of the ReaderWriter. Returns 0 by default, must by overridden by subclasses which are properties.

Reimplemented in DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, and DtRwProperties.

Referenced by DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >::encodeProperties().

virtual const DtPropertyInterface* DtReaderWriter::property ( ) const

virtual

Returns a PropertyInterface pointer of the ReaderWriter. Returns 0 by default, must by overridden by subclasses which are properties.

Reimplemented in DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, and DtRwProperties.

virtual void DtReaderWriter::recordUpdateTime ( ) const

inlinevirtual

Can be implemented in subclasses to stamp the time when updated.

Default implementation does nothing.

Reimplemented in DtRwProperty< DtRwInt >, and DtRwProperty< DtRwReal >.

virtual bool DtReaderWriter::wasUpdatedSince ( DtTime t ) const

inlinevirtual

Can be implemented in subclasses to return true if an update occurred after the specified time.

Default implementation returns true.

Reimplemented in DtRwPropertyWithThreshold< DtRwInt >, DtRwPropertyWithThreshold< DtRwReal >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, and DtRwProperties.

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.

Member Data Documentation

const DtSymbolString DtReaderWriter::myName

protected

DtReaderWriterRegistry DtReaderWriter::myRegistry

protected

Referenced by registry().

DtReaderWriterRegistry* DtReaderWriter::myParentRegistry

protected

bool DtReaderWriter::myValueSpecified

protected

bool DtReaderWriter::myReadOnlyFlag

protected

bool DtReaderWriter::myIsVariableReference

protected

DtSymbolString DtReaderWriter::myVariableName

protected

bool DtReaderWriter::myVariableIsBound

protected

DtReaderWriter* DtReaderWriter::myDefaultValue

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

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.vrf4-4-branch/include/vrfutil/readerWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation