This repository holds all information that is common to all the forms of all objects within VR-Forces that can move. More...

Inheritance diagram for DtWeatherStateRepository:

[legend]

Public Member Functions
	DtWeatherStateRepository (DtVrfObject vrfObject, const DtObjectType &objectType, DtVrfObjectParameters parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtWeatherStateRepository (const DtWeatherStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy Constructor.
DtWeatherStateRepository &	operator= (const DtWeatherStateRepository &orig)
	Assignment Operator.
virtual	~DtWeatherStateRepository ()
	Destructor.
virtual void	resetToDefaults ()
	Called by the constructor to initialize all environment values.
virtual DtSimObjectStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Clone.
virtual DtString	type () const
	returns DtSimObjectStateRepositoryType

virtual void	setAirTurbidity (double value)
	See myAirTurbidity.
virtual double	airTurbidity () const
	See myAirTurbidity.

virtual void	setAmbientAirTemperature (double value)
	See myAmbientAirTemperature.
virtual double	ambientAirTemperature () const
	See myAmbientAirTemperature.

virtual void	setCloudState (DtVrfWeatherCloudState current)
	See myCloudState.
virtual DtVrfWeatherCloudState	cloudState () const
	See myCloudState.

virtual void	setPrecipitationIntensity (double value)
	See myPrecipitationIntensity.
virtual double	precipitationIntensity () const
	See myPrecipitationIntensity.

virtual void	setPrecipitationType (DtVrfWeatherPrecipitationType value)
	See myPrecipitationType.
virtual DtVrfWeatherPrecipitationType	precipitationType () const
	See myPrecipitationType.

virtual void	setWindSpeed (double value)
	See myWindSpeed.
virtual double	windSpeed () const
	See myWindSpeed.

virtual void	setWindDirection (double value)
	See myWindDirection.
virtual double	windDirection () const
	See myWindDirection.

virtual void	setVisibility (double value)
	See myVisibility.
virtual double	visibility () const
	See myVisibility.

virtual void	setPriority (int value)
virtual int	priority () const

virtual void	setUnderwaterVisibility (double underwaterVisibility)
	Underwater visibility in meters.
virtual double	underwaterVisibility () const
	Underwater visibility in meters.

virtual void	setSurfaceTransparency (double transparency)
	Surface transparency (percentage)
virtual double	surfaceTransparency () const
	Surface transparency (percentage)

virtual void	setWaterCurrentSpeed (double waterCurrentSpeed)
	Water velocity in meters per second.
virtual double	waterCurrentSpeed () const
	Water velocity in meters per second.

virtual void	setWaterCurrentDirection (double waterCurrentDirection)
	Water direction in radians clockwise from 0 (north)
virtual double	waterCurrentDirection () const
	Water direction in radians clockwise from 0 (north)

virtual void	setAmbientWaterTemperature (double waterTemperature)
	Ambient water temperature in Celsius.
virtual double	ambientWaterTemperature () const
	Ambient water temperature in Celsius.

virtual void	setTidalOffset (double tidalOffset)
	Tidal offset in meters from the water polygons in the database.
virtual double	tidalOffset () const
	Tidal offset in meters from the water polygons in the database.

virtual void	setTidalDirection (bool tidalDirection)
	Tidal direction where true represents the tide going in and false represents the tide going out.
virtual bool	tidalDirection () const
	Tidal direction where true represents the tide going in and false represents the tide going out.

virtual void	setSwellState (unsigned int state)
	Swell state according to the Douglas Sea Scale (integer 0 - 9)
virtual unsigned int	swellState () const
	Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual void	setSwellStateDirection (double direction)
	Swell direction in in radians clockwise from 0 (north)
virtual double	swellStateDirection () const
	Swell direction in in radians clockwise from 0 (north)

virtual void	setSeaState (unsigned int state)
	Swell state according to the Douglas Sea Scale (integer 0 - 9)
virtual unsigned int	seaState () const
	Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual void	setSeaStateDirection (double direction)
	Swell direction in in radians clockwise from 0 (north)
virtual double	seaStateDirection () const
	Swell direction in in radians clockwise from 0 (north)

virtual void	setWindDrivenSeaStateEnabled (bool b)
	Determines if the sea state is set based on the wind.
virtual bool	windDrivenSeaStateEnabled () const
	Determines if the sea state is set based on the wind.

virtual void	setChoppiness (double choppiness)
	Wave choppiness (0..1)
virtual double	choppiness () const
	Wave choppiness (0..1)

virtual void	setSurgeDepth (double depth)
	Surge depth (meters)
virtual double	surgeDepth () const
	Surge depth (meters)

virtual void	setThermoclineLayer1Depth (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer1Depth () const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer1Permeability (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer1Permeability () const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer2Depth (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer2Depth () const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer2Permeability (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer2Permeability () const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer3Depth (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer3Depth () const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer3Permeability (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer3Permeability () const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer4Depth (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer4Depth () const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer4Permeability (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer4Permeability () const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer5Depth (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer5Depth () const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer5Permeability (double depth)
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer5Permeability () const
	Thermocline depth (in meters) and permeability (0..1).
Public Member Functions inherited from DtVrfOverlayObjectStateRepository
	DtVrfOverlayObjectStateRepository (DtVrfObject vrfObject, const DtObjectType &objectType, DtVrfObjectParameters parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtVrfOverlayObjectStateRepository (const DtVrfOverlayObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy Constructor.
const DtVrfOverlayObjectStateRepository &	operator= (const DtVrfOverlayObjectStateRepository &orig)
	Assignment Operator.
virtual	~DtVrfOverlayObjectStateRepository ()
	Destructor.
virtual double	sensorSignature (const DtSymbolString &sensorDomain) const
	If this item is an event or something that has a sensor signature, return that sensor signate for the given domain here.
virtual void	setSensorSignature (const DtSymbolString &domain, double)
	Adds a new sensor signature for the domain.
virtual void	removeSensorSignature (const DtSymbolString &)
	Removes the sensor signature for the domain.
virtual const std::map < DtSymbolString, double > &	sensorSignatures () const
	Returns sensor signatures.
virtual const int	vrfObjectStateRepositorySubType () const
	Returns DtVrfObjectStateRepositorySubTypeOverlay.
virtual bool	activated () const
	Returns true if this object is active.
virtual void	setActivated (bool)
virtual void	updateBasedOnActivationState ()
virtual bool	shouldActivate ()
	Returns true if environmental should be activated.
virtual bool	shouldDeactivate ()
	Returns true if environmental should be deactivated.
virtual void	attachToParent (DtSimObjectStateRepository *parent)
	Since this does not have dead reckoning, slow down the publisher (if local) to prevent network flood when object is moving.
virtual void	attachToParent (const DtUUID &parent)
	Looks up the parent state repository using the given echelon ID and puts it in a call to attachToParent.
virtual void	detachFromParent ()
virtual void	setAttachedTickRateForPublication (double)
	Default is 1 seconds.
virtual double	attachedTickRateForPublication () const
virtual int	color () const
virtual void	setColor (int color)
virtual void	setColor (DtU8 red, DtU8 green, DtU8 blue, DtU8 alpha)
virtual const DtString &	parentName () const
virtual void	setParentName (const DtString &parentName)
virtual void	setUserData (const char *data, int dataLen)
virtual const DtString &	userData () const
virtual double	ceiling () const
	Note that if the ceiling becomes lower than the floor the floor will change to match Ceiling is the floor plus the physical line height.
virtual void	setCeiling (double)
virtual void	setPhysicalLineHeight (double)
virtual double	physicalLineHeight () const
virtual bool	ceilingSet () const
virtual double	floor () const
	The floor is taken as the altitude of the first point.
virtual void	setFloor (double)
virtual double	physicalLineWidth () const
	Physical (database) width of a line.
virtual void	setPhysicalLineWidth (double)
virtual double	intelAreaModifierForForce (int force) const
virtual boost::tribool	onTerrainSurface () const
virtual void	setExtendedDataMap (const ExtendedData &)
virtual void	setExtendedDataMap (const std::map< std::string, std::string > &e)
virtual void	setExtendedData (const DtString &key, const DtString &value)
virtual void	updateCollectionAreaInformation ()
virtual void	updatePhysicalLineWidthInformation ()
virtual void	updatePhysicalLineHeightInformation ()
virtual void	updateCeilingInformation ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Override getSelf to handle mapping of old pre-2.0 oob files.
virtual bool	inside (const DtVector &point) const
	Override to check floor/ceiling if defined.
virtual bool	useActivationTimes () const
virtual void	setUseActivationTimes (bool)
virtual bool	activationTimesAreSimulationTime () const
	Calls to set/get activation/deactivation times.
virtual void	setActivationTimesAreSimulationTime (bool)
virtual void	setActivationTime (double)
virtual double	activationTime () const
virtual void	setDeactivationTime (double)
virtual double	deactivationTime () const
Public Member Functions inherited from DtVrfObjectStateRepository
	DtVrfObjectStateRepository (DtVrfObject vrfObject, const DtObjectType &objectType, DtVrfObjectParameters parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtVrfObjectStateRepository (const DtVrfObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy Constructor.
const DtVrfObjectStateRepository &	operator= (const DtVrfObjectStateRepository &orig)
	Assignment Operator.
virtual	~DtVrfObjectStateRepository ()
	Destructor.
virtual const int	objectStateRepositorySubType () const
	Returns DtSimObjectStateRepositorySubTypeVrfObject.
virtual bool	init ()
	Our 'virtual' constructor. Calls all the create<>() methods.
virtual bool	createParameters ()
virtual void	initializeFromParameters ()
virtual const DtVrfObjectParameters *	vrfParameters () const
virtual void	setJoystickMovementControlled (bool)
	If true movement is controlled by joystick so will not be able to be taskable as a subordinate.
virtual bool	joystickMovementControlled () const
virtual DtVrfStateRepositoryUserExtension *	userExtension () const
	User extension to state repository class.
virtual void	restoreEntity ()
	Called on a setRestore command, sets destroyed to false and sets resources to initial (parameter file) levels.
virtual void	restoreResourcesFromParameters ()
virtual bool	inSOR (const DtVrfObject *entity) const
virtual const DtString &	engagementRules () const
virtual void	setEngagementRules (const DtString &engagementRules)
virtual bool	isTasked () const
	Returns true if entity is currently executing a task (at least one component must be tasked), false otherwise.
virtual void	clearCurrentTaskMsg (const DtSymbolString &componentName)
	Clear all the tasks with the specified component name.
virtual void	clearCurrentTaskMsg (const DtSymbolString &componentName, int taskId)
	Clear the task with specified taskId and the specified component name.
virtual const DtTaskStatusList *	taskStatusList () const
virtual DtTaskStatusList *	taskStatusList ()
virtual DtSuspendedTaskStatusList *	suspendedTaskStatusList ()
virtual DtTaskMessage *	currentTaskMsg (const DtSymbolString &componentName) const
	Get the current task message.
virtual DtTaskMessage *	currentTaskMsg (const DtSymbolString &componentName, int taskId) const
	Get the current task message for the specified component and task ID.
virtual std::list < DtTaskMessage * >	allCurrentTaskMsg (const DtSymbolString &componentName) const
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Top level call to write itself to file.
virtual bool	placePoints (DtAttachedTerrain &attachedTerrain, std::vector< DtGroundInteractionPt * > groundInteractionPts, bool *terrainDataAvailable=0)
	Positions list of ground interaction points on the terrain surface closest to the specified location.
virtual void	updateSupportPoints (const DtVector &newPosition, const DtReal newHeading)
	reading in a scenario, want to make sure the support points get set up properly.
virtual const DtVrfObjectParameters *	parameters () const
virtual DtVrfObjectParameters *	modifiableParameters ()
	A modifiable local copy of parameters.
virtual void	setupParameterInheritance ()
	Called by init().
virtual bool	createAttachments ()
	Override to create derived DtVrfAttachmentManager.
void	addPart (DtArticulatedPartStateRepository *part)
	These will be replaced by equivalents in the attachment manager.
void	removePart (DtArticulatedPartStateRepository *part)
DtArticulatedPartStateRepository *	part (DtArtPartType partType)
DtArticulatedPartStateRepository *	findDescendantByType (DtArtPartType childType)
bool	isEntity () const
bool	isLocal () const
bool	isAggregate () const
void	addSubordinate (DtVrfObject *subordinateEntity)
	Adds an entity as a subordinate.
void	removeSubordinate (DtVrfObject *subordinateEntity)
	Removes entity from our list of subordinates.
virtual DtSharedVrfObjectReference	leadEntity () const
virtual DtSharedVrfObjectReference	firstSubordinate () const
virtual DtSharedVrfObjectReference	lastSubordinate () const
virtual DtSharedVrfObjectReference	firstHealthySubordinate () const
virtual void	tick ()
	This method is called each simulation frame, and may include any processing that needs to be done on this object state each tick.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived (myNextTickTime <= exerciseClock()->approximateElapsedRealTime()).
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual bool	createSubordinates ()
virtual DtVrfSubordinateManager *	vrfSubordinates ()
virtual const DtVrfSubordinateManager *	vrfSubordinates () const
virtual bool	createProcessStateRepositoryManager ()
virtual const DtTaitBryan &	localOrientationWrtDatabase () const
	Euler angles with respect to the local (database) coordinate system, in radians.
virtual void	setLocalOrientationWrtDatabase (const DtTaitBryan &localOrientation)
virtual DtVrfWeaponPSR *	firstWeaponPSR () const
	This is provided for backward compatibility with setTarget capabilities.
virtual void	processObjectGeometry (const DtList &vertices)
	Processes a list of DtVectors, such as might come in a create or modify message.
virtual void	processObjectGeometry (const DtLocalVertexList &vertices)
virtual void	processObjectGeometry ()
	This form allows processObjectGeometry()'s bounding volume calculations to be done on it's current geometry (by making a copy first).
virtual const DtVrfObjectParameters *	vrfBaseParameters () const
virtual DtGroundInteractionPt *	groundCenter ()
virtual const DtGroundInteractionPt *	groundCenter () const
virtual const DtVector &	getPartAttachPoint (const int partType) const
virtual void	place (const DtVector &location, bool *dataAvailable=0, bool requireAllData=false)
	Place entity at 'location', on the ground, keeping its current heading.
virtual void	place (const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
	Give entity the specified 'heading', but stay at its current location.
virtual void	place (const DtVector &location, const DtReal heading, bool clampToGroundFlag=true, bool *dataAvailable=0, bool requireAllData=false)
	Place entity at specified 'location' and 'heading' on the ground.
virtual void	updatePositionFromModelVertices ()
	Note that this is not currently ever called.
virtual void	updateBVolFromModelVertices ()
virtual DtReal	mass () const
virtual void	setMass (const DtReal mass)
virtual const DtArticulatedPartCollection *	artPartList () const
	Get the list of articulated parts specified in the component descriptor.
virtual void	createParts ()
	This causes the art part tree to be created.
virtual DtTime	lastTimeFiredUpon () const
virtual void	setLastTimeFiredUpon (const DtTime time)
virtual bool	underFire () const
virtual void	setUnderFire (bool underFire)
virtual DtDeadReckonTypes	deadReckoningAlgorithm () const
virtual void	setDeadReckoningAlgorithm (DtDeadReckonTypes deadReckoningAlgorithm)
virtual void	putData (FILE *fp, int indentLevel=0)
	Override putData to set myParent using the organization manager before saving.
virtual int	nextTaskId ()
	Returns next unique task id for this entity.
virtual int	nextSuspendId ()
virtual DtTaskMessage *	pendingSubtask (int subtaskId, DtString &controller) const
	Returns the current subtask with the specified id.
virtual bool	taskedBySuperiorUponTaskComplete () const
	Returns true if entity should automatically resume being tasked by superior upon completion of its current top-level task, false otherwise.
virtual void	setParentWasDestroyedWhenEmbarked (bool)
virtual bool	parentWasDestroyedWhenEmbarked () const
virtual void	addAttachedTerrain (const DtUUID &parent)
	Asks the sim manager to look up the object model for the requested database.
virtual void	removeAttachedTerrain (const DtUUID &parent)
	Decreases reference count of terrain model by name of object.
Dt3dBoundingVolume *	boundingVolume () const
	Convenience method for accessing entity's bounding volume, stored in myObjectGeometry.
DtVector	localBoundingVolumeCenterPosition () const
	Gets the local coordinates of the bounding volume center.
DtReal	forwardSpeed () const
virtual void	restoreStateProperties ()
	Restores state properties to their default settings.
virtual void	initStatePropertiesNotToBeRestored ()
	Initializes the list of state properties which should not be restored.
virtual void	addRangeItem (const DtRangeItem &)
	Adds, removes and returns items in the range item list.
virtual void	removeRangeItem (int index)
virtual void	setRangeItems (const DtRangeItems &)
const DtRangeItems &	rangeItems () const
DtRangeItems &	rangeItems ()
virtual void	clearRangeItems ()
DtAttachedTerrain *	terrainAttachedTo () const
virtual std::list< DtSymbolString >	sensorSignatureDomains () const
virtual DtVrfObjectStateRepository *	toVrfObjectStateRepository ()
virtual const DtVrfObjectStateRepository *	toVrfObjectStateRepository () const
virtual void	clearExtendedData ()
virtual void	removeExtendedData (const DtString &key)
virtual DtString	extendedData (const DtString &key) const
const ExtendedData &	extendedDataMap () const
virtual void	setupExtendedDataFromParameterData ()
	If publishing parameter data also include that in the extended data map by name.
virtual void	setExtendedLabel (int, const DtString &value)
virtual void	clearExtendedLabels ()
virtual DtString	extendedLabel (int index) const
virtual ExtendedLabels	extendedLabels () const
virtual void	setExtendedLabels (const ExtendedLabels &)
virtual void	addJoystickControls (const DtRwJoystickControls &)
virtual const JoystickControls &	joystickControls () const
virtual void	setActivity (const DtString &)
virtual DtString	activity () const
virtual const DtObjectResourceManager *	objectResourceManager () const
virtual DtObjectResourceManager *	objectResourceManager ()
virtual const DtSimResourceManager &	oldResourceManager () const
	Returns a reference to our resource manager.
virtual DtSimResourceManager &	oldResourceManager ()
	Returns a reference to our resource manager.
virtual DtSimResource *	oldLookupResource (const DtString &resourceName)
	Gets a pointer to the resource named resourceName.
virtual const DtSimResource *	oldLookupResource (const DtString &resourceName) const
	Returns a reference to our resource manager.
virtual void	oldAddResource (DtSimResource *resource)
	This does a clone of the resource and puts it on our main list, as well as adding the resource to the hash index.
virtual void	oldRemoveResource (DtSimResource *resource)
	This removes and deletes the specified resource.
virtual void	setSOR (DtReal center, DtReal size)
	Sector of responsibility.
virtual DtReal	SORSize () const
	Sector of responsibility.
virtual DtReal	SORCenter () const
	Sector of responsibility.
virtual const DtSimSector &	SOR () const
	Sector of responsibility.
virtual void	setRequestTaskNeeded (bool value)
	Set/get whether or not this needs to send a request task needed message.
virtual bool	requestTaskNeeded () const
	Set/get whether or not this needs to send a request task needed message.
virtual void	setTasked (const DtSymbolString &componentName, bool tasked)
	Set/get whether or not a given entity component currently executing a task.
virtual void	setTasked (const DtSymbolString &componentName, int taskID, bool tasked)
	Set/get whether or not a given entity component currently executing a task.
virtual bool	tasked (const DtSymbolString &componentName) const
	Set/get whether or not a given entity component currently executing a task.
virtual void	setCurrentTaskMsg (const DtSymbolString &componentName, const DtTaskMessage &taskMsg)
	Set the current task message.
virtual void	setCurrentTaskMsg (const DtSymbolString &componentName, const DtTaskMessage &taskMsg, int taskId)
	Set the current task message.
virtual void	setIndependentlyTasked (bool value)
	Set/get whether or not this entity is currently independently tasked (separately from its unit).
virtual bool	independentlyTasked () const
	Set/get whether or not this entity is currently independently tasked (separately from its unit).
virtual const DtVrfObjectParameters *	parameterEntry () const
	If a clone has been created, this call will return the cloned entry as a const pointer, else returns the original pointer.
virtual void	setParameterEntry (DtVrfObjectParameters *parameterEntry)
	If a clone has been created, this call will return the cloned entry as a const pointer, else returns the original pointer.
virtual DtForceType	forceType () const
	Get/Set the force type (team) of this entity.
virtual void	setForceType (DtForceType force)
	Get/Set the force type (team) of this entity.
virtual bool	createAppearance ()
	Encapsulates all the appearance related data and methods currently in the entity state repository.
virtual const DtAppearance *	appearance () const
	Encapsulates all the appearance related data and methods currently in the entity state repository.
virtual DtAppearance *	appearance ()
	Encapsulates all the appearance related data and methods currently in the entity state repository.
virtual void	setCapabilities (int cap)
	Gets/sets capabilities of entity This is treated as the DIS capabilities bit field, and does not necessarily change any behaviors of the object.
virtual int	capabilities () const
	Gets/sets capabilities of entity This is treated as the DIS capabilities bit field, and does not necessarily change any behaviors of the object.
void	setDestroyed (bool isDestroyed)
	Destroyed status of entity (whether or not appearance()->damageState() is set to DtDamageDestroyed).
bool	isDestroyed () const
	Destroyed status of entity (whether or not appearance()->damageState() is set to DtDamageDestroyed).
DtReal	healthPct () const
void	setHealthPct (DtReal pct)
bool	firePowerKilled () const
	Convenience methods for setting setting entity's appearance bits in DtAppearance.
void	setFirePowerKilled (const bool firePowerKilled)
	Convenience methods for setting setting entity's appearance bits in DtAppearance.
bool	mobilityKilled () const
	Convenience methods for setting setting entity's appearance bits in DtAppearance.
void	setMobilityKilled (const bool mobilityKilled)
	Convenience methods for setting setting entity's appearance bits in DtAppearance.
bool	flaming () const
	Convenience methods for setting setting entity's appearance bits in DtAppearance.
void	setFlaming (const bool flaming)
	Convenience methods for setting setting entity's appearance bits in DtAppearance.
bool	smoking () const
	Convenience methods for setting setting entity's appearance bits in DtAppearance.
void	setSmoking (const bool smoking)
	Convenience methods for setting setting entity's appearance bits in DtAppearance.
virtual DtVrfSubordinateManager *	subordinates ()
virtual const DtVrfSubordinateManager *	subordinates () const
virtual DtSimManager *	simManager ()
virtual const DtSimManager *	simManager () const
virtual DtPhysicalWorld *	physicalWorld ()
virtual const DtPhysicalWorld *	physicalWorld () const
virtual const DtVrfProcessStateRepositoryManager *	systemProcessStateRepositoryManager () const
virtual DtVrfProcessStateRepositoryManager *	systemProcessStateRepositoryManager ()
virtual const DtThresholder &	deadReckoningThresholder () const
	Dead-reckoning threshold parameters.
virtual void	setDeadReckoningThresholder (const DtThresholder &thresholder)
	Dead-reckoning threshold parameters.
virtual const DtEntityIdentifier &	occupyingObjectId () const
	We hold the id of the object we are occupying.
virtual void	setOccupyingObjectId (const DtEntityIdentifier &objId)
	We hold the id of the object we are occupying.
virtual void	setEchelonId (const DtEchelonId &echelonId)
	The echelon ID of this object, if it is an organized object.
virtual DtEchelonId &	echelonId ()
	The echelon ID of this object, if it is an organized object.
virtual const DtEchelonId &	echelonId () const
	The echelon ID of this object, if it is an organized object.
virtual void	setIsSubordinateOfForceLevel (bool yesNo)
	Indicates if this object's direct superior is a Force level object.
virtual bool	isSubordinateOfForceLevel () const
	Indicates if this object's direct superior is a Force level object.
virtual int	spawningTaskId (int subtaskId) const
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	addPendingSubtaskId (const DtSymbolString &componentName, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	addPendingSubtaskId (const DtSymbolString &componentName, int taskId, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual bool	findPendingSubtaskId (const DtSymbolString &componentName, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual bool	isSubtasked (const DtSymbolString &componentName) const
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual bool	findPendingSubtaskId (const DtSymbolString &componentName, int taskId, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	removePendingSubtaskId (const DtSymbolString &componentName, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	removePendingSubtaskId (const DtSymbolString &componentName, int taskId, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	removeAllPendingSubtaskIds (const DtSymbolString &componentName)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	removeAllPendingSubtaskIds (const DtSymbolString &componentName, int taskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	printPendingSubtaskIds (const DtSymbolString &componentName) const
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual std::vector< int >	currentPendingSubstaskIds (const DtSymbolString &componentName) const
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual std::vector< int >	currentPendingSubstaskIds (const DtSymbolString &componentName, int taskId) const
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual DtSubtaskStatusEntry *	pendingSubtaskStatus (const DtSymbolString &componentName, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual DtSubtaskStatusEntry *	pendingSubtaskStatus (const DtSymbolString &componentName, int taskId, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
DtReal	currentSpeed () const
	Returns magnitude of relative velocity in state repository.
DtReal	currentHeading () const
	Heading in radians. Calls down to DtVrfKinematicState for heading.
void	setCurrentHeading (const DtReal heading)
	Heading in radians. Calls down to DtVrfKinematicState for heading.
virtual void	addPostInitFromParamsCallback (DtPostInitializeFromParametersCallbackFcn fcn, void *usr)
	Add/remove callback function to be invoked immediately following execution of initializeFromParameters.
virtual void	removePostInitFromParamsCallback (DtPostInitializeFromParametersCallbackFcn fcn, void *usr)
	Add/remove callback function to be invoked immediately following execution of initializeFromParameters.
virtual DtRwProperties &	stateProperties ()
	Accesses to the properties.
virtual const DtRwProperties &	stateProperties () const
	Accesses to the properties.
virtual DtRwProperties &	parameterProperties ()
	Access to static (parameter) properties.
virtual const DtRwProperties &	parameterProperties () const
	Access to static (parameter) properties.
virtual DtSensorContactInfoList &	objectContactList ()
	Situational awareness of this object.
virtual const DtSensorContactInfoList &	objectContactList () const
	Situational awareness of this object.
virtual bool	processCompleteAttachment (DtVrfObject *)
	These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
virtual void	processObjectAboutToBeRemovedCallback (DtVrfObject *vrfObject)
	These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
virtual suppressionLevels	suppressionLevel () const
	The current suppression level.
virtual void	setSuppressionLevel (const suppressionLevels l)
	The current suppression level.
virtual bool	isSuppressed () const
	The current suppression level.
virtual void	processTaskComplete (const DtVrfObjectMessage *msg)
	Handles state changes for the subtask status list.
Public Member Functions inherited from DtSimObjectStateRepository
	DtSimObjectStateRepository (DtVrfObject simObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)
const DtSimObjectStateRepository &	operator= (const DtSimObjectStateRepository &orig)
virtual	~DtSimObjectStateRepository ()
virtual const DtObjectType &	objectType () const
virtual void	setObjectType (const DtObjectType &objectType)
virtual bool	createKinematicState ()
	Creates a DtVrfKinematicState.
virtual DtVrfKinematicState *	vrfKinematicState ()
virtual const DtVrfKinematicState *	vrfKinematicState () const
virtual bool	createObjectGeometry ()
virtual DtVrfObjectGeometry *	vrfObjectGeometry ()
virtual const DtVrfObjectGeometry *	vrfObjectGeometry () const
virtual DtAttachmentManager *	attachments ()
virtual const DtAttachmentManager *	attachments () const
virtual DtSimObjectStateRepository *	parent ()
virtual const DtSimObjectStateRepository *	parent () const
virtual bool	isEmbarkedOn (const DtUUID &parent) const
virtual const DtUUID &	attachedToRepository ()
virtual DtSimObjectStateRepository *	findRootSimStateRepository ()
virtual const DtSimObjectStateRepository *	findRootSimStateRepository () const
virtual void	ancestorObjectChanged ()
virtual void	preGetSelf ()
	Hook function called immediately prior to getSelf().
virtual void	postGetSelf ()
	Hook function called immediately following getSelf().
virtual void	setCoordinateSystem (const Coordinate_System *coordinateSystem)
	Sets the coordinate system in myObjectGeometry and myKinematicState.
virtual DtVrfObject *	vrfObject ()
virtual const DtVrfObject *	vrfObject () const
virtual void	setVrfObject (DtVrfObject *vrfObject)
virtual DtSimKinematicState *	kinematicState ()
virtual const DtSimKinematicState *	kinematicState () const
virtual DtVrfObjectGeometry *	objectGeometry ()
virtual const DtVrfObjectGeometry *	objectGeometry () const
virtual const DtVector &	bodyPosition () const
	Now superseded by kinematic state parentCS functions.
virtual void	setBodyPosition (const DtVector &pos)
	Formerly setMeInParent.
virtual void	setBodyPosition (DtFloat64 x, DtFloat64 y, DtFloat64 z)
const DtDcm &	bodyOrientationMatrix () const
	Formerly meToParent().
virtual void	embarkOnParent (const DtUUID &parent)
	Embarks this entity on the specified parent.
virtual bool	leftOf (const DtVector &localVector) const
virtual double	distanceToLocalVector (const DtVector &localVector) const
	Returns the distance from a position in local.
const Coordinate_System *	coordinateSystem () const
virtual void	removeVertex (int iIndex)
	These routines simply call down to the kinematic state to get/set the results.
virtual void	addLocalVertex (const DtVector &vertex)
	These routines simply call down to the kinematic state to get/set the results.
virtual void	addLocalVertex (const DtVector &vertex, DtVector &newGeometricCenter)
	These routines simply call down to the kinematic state to get/set the results.
virtual void	setLocalVertices (const DtLocalVertexList &vertices, DtVector &newGeometricCenter)
	These routines simply call down to the kinematic state to get/set the results.
virtual void	setLocalVertices (const DtList &vertices, DtVector &newGeometricCenter)
	These routines simply call down to the kinematic state to get/set the results.
virtual const DtLocalVertexList &	localVertices () const
	These routines simply call down to the kinematic state to get/set the results.
virtual const DtLocalVectorIterator &	localVertexIterator () const
	These routines simply call down to the kinematic state to get/set the results.
virtual void	addWorldVertex (const DtVector &vertex, DtVector &newGeometricCenter)
	These routines simply call down to the kinematic state to get/set the results.
virtual void	setWorldVertices (const DtVertexList &vertices, DtVector &newGeometricCenter)
	These routines simply call down to the kinematic state to get/set the results.
virtual void	setWorldVertices (const DtList &vertices, DtVector &newGeometricCenter)
	These routines simply call down to the kinematic state to get/set the results.
virtual const DtVertexList &	worldVertices () const
	These routines simply call down to the kinematic state to get/set the results.
virtual const DtRwVectorIterator &	worldVertexIterator () const
	These routines simply call down to the kinematic state to get/set the results.
virtual void	setRelativeVertices (const DtLocalVertexList &vertices)
	Access/modify vertices relative to to the parent to which this object is attached.
virtual void	setRelativeVertices (const DtList &vertices)
	Access/modify vertices relative to to the parent to which this object is attached.
virtual const DtLocalVertexList &	relativeVertices () const
	Access/modify vertices relative to to the parent to which this object is attached.
virtual const DtLocalVectorIterator &	relativeVertexIterator () const
	Access/modify vertices relative to to the parent to which this object is attached.
const DtVector &	localPosition () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setLocalPosition (const DtVector &pos)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVector &	localVelocity () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setLocalVelocity (const DtVector &vel)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVector &	localAcceleration () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setLocalAcceleration (const DtVector &acc)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVector &	relativeVelocity () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setRelativeVelocity (const DtVector &vel)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVector &	relativeAcceleration () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setRelativeAcceleration (const DtVector &acc)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtTaitBryan &	localOrientation () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setLocalOrientation (const DtTaitBryan &angles)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVector &	worldPosition () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setWorldPosition (const DtVector &pos)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVector &	worldVelocity () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setWorldVelocity (const DtVector &vel)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVector &	worldAcceleration () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setWorldAcceleration (const DtVector &acc)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtTaitBryan &	worldOrientation () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setWorldOrientation (const DtTaitBryan &angles)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtVector &	rotationalVelocity () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setRotationalVelocity (const DtVector &rotationalVelocity)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
const DtDcm &	localOrientationMatrix () const
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
void	setLocalOrientationMatrix (const DtDcm &orient)
	Convenience methods for accessing corresponding methods in DtVrfKinematicState.
Public Member Functions inherited from DtReaderWriter
	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	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	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 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.
virtual 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 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
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 Public Member Functions
static DtVrfObjectStateRepository *	creator (const DtString &name, DtVrfObject vrfObject, const DtObjectType &objectType, DtVrfObjectParameters parameters, DtReaderWriterRegistry *parentRegistry)
static DtWeatherStateRepository *	isWeatherStateRepository (DtSimObjectStateRepository *repository)
Static Public Member Functions inherited from DtVrfOverlayObjectStateRepository
static DtVrfOverlayObjectStateRepository *	isVrfOverlayObjectStateRepository (DtSimObjectStateRepository *repository)
static const DtVrfOverlayObjectStateRepository *	isVrfOverlayObjectStateRepository (const DtSimObjectStateRepository *repository)
Static Public Member Functions inherited from DtVrfObjectStateRepository
static DtVrfObjectStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject simObject, const DtObjectType &objectType, DtVrfObjectParameters parameters, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the factory.
static void	addSimObjectStateRepositoryCreatorFcn (const DtString &type, DtSimObjectStateRepositoryCreatorFcn fcn)
static DtVrfObjectStateRepository *	isVrfObjectStateRepository (DtSimObjectStateRepository *repository)
static const DtVrfObjectStateRepository *	isVrfObjectStateRepository (const DtSimObjectStateRepository *repository)
static DtSimObjectStateRepositoryFactory *	factory ()
	a DtSimObjectStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtSimObjectStateRepositoryFactory *factory)
	a DtSimObjectStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	objectAboutToBeRemovedCallback (DtVrfObject vrfObject, void usr)
	These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
static void	taskCompleteCallback (const DtVrfObjectMessage msg, void usr)
	Handles state changes for the subtask status list.
Static Public Member Functions inherited from DtSimObjectStateRepository
static void	completeAttachmentCallback (DtVrfObject simObject, void usr)
	These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
static DtSimObjectStateRepository *	isSimObjectStateRepository (DtSimObjectStateRepository *repository)
static const DtSimObjectStateRepository *	isSimObjectStateRepository (const DtSimObjectStateRepository *repository)
Static Public Member Functions inherited from DtReaderWriter
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 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 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.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Attributes
parameters
These parameters are available for setting in the physicalWorldParams.
DtRwReal	myAirTurbidity
	Parameter Name: air-turbidity Parameter Description: Turbidity of the air Default Value: 0.0.
DtRwReal	myAmbientAirTemperature
	Parameter Name: ambient-air-temperature Parameter Description: Ambient temperature of the air in Celsius Default Value: 15.0.
DtRwInt	myCloudState
	Parameter Name: cloud-state Parameter Description: A string describing the cloud state Clear, Mostly Clear, Cloudy, Partly Cloudy, Mostly Cloudy Default Value: DtVrfWeatherCloudStateClear.
DtRwReal	myPrecipitationIntensity
	Parameter Name: precipitation-intensity Parameter Description: Precipitation intensity Default Value: 0.0.
DtRwInt	myPrecipitationType
	Parameter Name: precipitation-type Parameter Description: A string describing the type of precipitation None, Snow, or Rain Default Value: DtVrfWeatherPrecipitationNone.
DtRwReal	myWindSpeed
	Parameter Name: wind-speed Parameter Description: Speed of the wind Default Value: 0.0 Units: meters/second.
DtRwReal	myWindDirection
	Parameter Name: wind-direction Parameter Description: Indicates what direction the wind is blowing from Default Value: 0.0 Units: radians.
DtRwInt	myPriority
	The priority that this weather area will take over overlapping weather areas.
DtRwReal	myVisibility
	Parameter Name: visibility Parameter Description: How far one can see and still distinguish things Default Value: Units: meters.
DtRwReal	myUnderwaterVisibility
	Parameter Name: underwater-visibility Parameter Description: How far one can see and still distinguish things underwater Default Value: 10.0 Units: meters.
DtRwReal	mySurfaceTransparency
	Parameter Name: surface-transparency Parameter Description: Surface transparency (only affects the visuals) Default Value: 0.0 Units: percentage.
DtRwReal	myWaterCurrentSpeed
	Parameter Name: water-current-speed Parameter Description: How fast the water currents are moving Default Value: 0.0 Units: meters per second.
DtRwReal	myWaterCurrentDirection
	Parameter Name: water-current-direction Parameter Description: The direction the water currents are flowing in Default Value: 0.0 Units: radians clockwise from 0 (north)
DtRwReal	myAmbientWaterTemperature
	Parameter Name: ambient-water-temperature Parameter Description: The ambient temperature of the water Default Value: 17.0 Units: degrees Celsius.
DtRwReal	myTidalOffset
	Parameter Name: tidal-offset Parameter Description: The value of sea level relative to the water polygons in the database Default Value: 0.0 Units: meters.
DtRwBoolean	myTidalDirection
	Parameter Name: tidal-direction Parameter Description: Direction of the tide Default Value: false Units: boolean (true = tide is going on, false = tide is going out)
DtRwInt	mySwellState
	Parameter Name: swell-state Parameter Description: Swell state according to the Douglas Sea Scale Default Value: 0 Units: integer (0 - 9)
DtRwReal	mySwellStateDirection
	Parameter Name: swell-state-direction Parameter Description: Direction of the swell for Triton Default Value: 0.0 Units: radians clockwise from 0 (north)
DtRwInt	mySeaState
	Parameter Name: sea-state Parameter Description: Sea state according to the Douglas Sea Scale Default Value: 0 Units: integer (0 - 9)
DtRwReal	mySeaStateDirection
	Parameter Name: sea-state-direction Parameter Description: Direction of the sea state for Triton Default Value: 0.0 Units: radians clockwise from 0 (north)
DtRwBoolean	myWindDrivenSeaStateEnabled
	Parameter Name: wind-driven-sea-state-enabled Parameter Description: Determines if the sea state is set automatically based on the wind Default Value: false Units: boolean.
DtRwReal	myChoppiness
	Parameter Name: choppiness Parameter Description: Wave choppiness for Triton Default Value: 0.0 Units: 0.0 - 1.0 percentage for Triton.
DtRwReal	mySurgeDepth
	Parameter Name: surge-depth Parameter Description: Surge depth for Triton Default Value: 0.0 Units: meters.
DtRwReal	myThermoclineLayer1Depth
	Parameter Name: "thermocline-layer1-depth" Parameter Description: Thermocline depth.
DtRwReal	myThermoclineLayer1Permeability
	Parameter Name: "thermocline-layer1-permeability" Parameter Description: Thermocline depth.
DtRwReal	myThermoclineLayer2Depth
	Parameter Name: "thermocline-layer2-depth" Parameter Description: Thermocline depth.
DtRwReal	myThermoclineLayer2Permeability
	Parameter Name: air-turbidity Parameter Description: Turbidity of the air Default Value: 0.0.
DtRwReal	myThermoclineLayer3Depth
	Parameter Name: "thermocline-layer3-depth" Parameter Description: Thermocline depth.
DtRwReal	myThermoclineLayer3Permeability
	Parameter Name: air-turbidity Parameter Description: Turbidity of the air Default Value: 0.0.
DtRwReal	myThermoclineLayer4Depth
	Parameter Name: "thermocline-layer4-depth" Parameter Description: Thermocline depth.
DtRwReal	myThermoclineLayer4Permeability
	Parameter Name: air-turbidity Parameter Description: Turbidity of the air Default Value: 0.0.
DtRwReal	myThermoclineLayer5Depth
	Parameter Name: "thermocline-layer5-depth" Parameter Description: Thermocline depth.
DtRwReal	myThermoclineLayer5Permeability
	Parameter Name: air-turbidity Parameter Description: Turbidity of the air Default Value: 0.0.
Protected Attributes inherited from DtVrfOverlayObjectStateRepository
DtRwInt	myColor
DtRwString	myParentName
DtRwReal	myPhysicalLineHeight
DtRwReal	myPhysicalLineWidth
DtRwString	myUserData
	Must be a printable format to write out to .oob file.
std::map< DtSymbolString, double >	mySensorSignatures
DtRwIntelCollectionArea *	myIntelCollectionAreaInformation
	If this is a collection area this pointer will be non-null.
double	myAttachedTickRateForPublication
Protected Attributes inherited from DtVrfObjectStateRepository
DtVrfStateRepositoryUserExtension *	myStateRepositoryUserExtension
DtRwAppearance *	myAppearance
DtRwInt	myCapabilities
DtRwForceType	myForceType
DtVrfSubordinateManager *	mySubordinates
	each of these has_a DtSubObjectManager
DtRwUUID	myParent
	if this object is a subordinate, this is used to write out the name of the parent
DtVrfProcessStateRepositoryManager *	mySystemProcessSRManager
DtLegacyProcessStateRepositoryManager *	myLegacyPSRManager
	Used only to read in scenarios from pre VRF 3.11.
DtSimManager *	mySimManager
DtGroundInteractionPt	myGroundCenter
bool	myUnderFire
	Under fire parameters.
DtTime	myLastTimeFiredUpon
DtRwInt	mySuppressionLevel
	The current enumerated level of suppression, derived from the value.
DtReal	myMass
DtDeadReckonTypes	myDeadReckoningAlgorithm
DtThresholder	myDeadReckoningThresholder
DtEntityIdentifier	myOccupyingObjectId
DtArticulatedPartCollection	myArtPartList
	This is created in createParts, and kept around to make setup of the network repository easier.
DtManagedObjectListConstPtr	myVisibilityFilterList
	Shared list of visibility blocking objects.
DtRwVector	myLocalPosition
	For backward compatibility with pre-2.0 VR-Forces oob files Registered as read-only, so they do not get written out to new oob files.
DtRwTaitBryan	myLocalOrientation
DtRwBoolean	myIsDestroyedFlag
DtEchelonId	myEchelonId
DtRwBoolean	myIsSubordinateOfForceLevel
DtRwInt	myDesignator
	myDesignator is used for reading and writing only and is not valid at runtime.
DtRwBoolean	myIndependentlyTasked
DtSimResourceManager	myResourceManager
	This resource manager is used for all the top-level resource only.
DtObjectResourceManager *	myObjectResourceManager
DtRwString	myEngagementRules
DtSimSector	mySectorOfResponsibility
	These really apply to a single weapon, and should be part of a weapon controller/actuator suite of some sort.
DtRwBoolean	myRequestTaskNeeded
	Moved here from the DtLocalTaskManager class.
DtTaskStatusList	myTaskStatusList
	Contains the myTasked and myCurrentTaskMsg members from the DtTaskControllerComponent class.
DtSuspendedTaskStatusList	mySuspendedTaskStatusList
DtRwInt	myNextTaskId
	The next available ID that can be assigned to a task for this entity.
DtRwInt	myNextSuspendId
DtRwBoolean	myParentWasDestroyedWhenEmbarked
	Set to true when the entity is embarked on a destroyed parent so they do not become destroyed.
const DtVrfObjectParameters *	myParameterEntry
	For performance and memory usage reasons, the copy of the parameter entry that used to be made when creating a state repository is no longer made when the state repository is initialized.
DtVrfObjectParameters *	myParameters
	this is the parameter entry that this repository created.
double	myMinTickPeriod
	For variable tick rate support.
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
DtAttachedTerrain *	myTerrainAttachedTo
DtSignatureModifierEvalMap	mySignatureModifierEvalMap
	Map which holds a set of lists of signature modifier evaluators indexed by sensor domain.
DtSensorSignatureCacheMap	myMutableSensorSignatureCacheMap
	Maintains the current sensor signature (indexed by sensor domain) for this entity.
DtSensorContactInfoList	myObjectContactList
	The situational awareness of this object.
DtPostInitializeFromParametersCallbackList	myPostInitFromParamsCallbackList
DtRangeItems	myRangeItems
	Range item information.
std::vector< DtRangeItem >	myFixedRangeItems
DtRwProperties	myStateProperties
	Additional properties that are part of this state repository.
DtRwProperties	myParameterProperties
ExtendedData	myExtendedData
std::vector< DtString >	myStatePropertiesNotToBeRestored
	The list of state properties that should not be updated by restoreStateProperties.
tbb::mutex	myEvaluateSensorSignatureMutex
JoystickControls	myJoystickControls
	Map of available joystick controls for this particular entity.
bool	myJoystickMovementControlled
	If true movement is controlled by joystick so will not be able to be taskable as a subordinate.
Protected Attributes inherited from DtSimObjectStateRepository
DtVrfObject *	mySimObject
DtRwObjectType	myObjectType
DtVrfObjectGeometry *	myObjectGeometry
DtVrfKinematicState *	myKinematicState
DtAttachmentManager *	myAttachments
DtSimObjectStateRepository *	myAttachedToRepository
DtRwUUID	myAttachedToRepositoryUUID
	used for reading & writing the name of myAttachedToRepository
DtSimObjectStateRepository *	myRootSimStateRepository
const Coordinate_System *	myCoordinateSystemPtr
	Caches pointer to coordinate system so it can set it after myKinematic state is created.
DtKinematicStateCS *	myEmbarkedKinematicState
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.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtWeatherStateRepository ()
	Default Constructor. Do not use.

Additional Inherited Members
Public Types inherited from DtVrfObjectStateRepository
typedef std::map< DtString, DtString >	ExtendedData
typedef std::map< int, DtString >	ExtendedLabels
typedef std::map< DtString, std::map< DtString, DtRwJoystickControl > >	JoystickControls
	Controls by function group.
enum	suppressionLevels { DtNoSuppression = 0, DtSuppressed1 = 1, DtSuppressed2 = 2, DtSuppressed3 = 3 }
	The current suppression level. More...
Protected Types inherited from DtVrfObjectStateRepository
typedef std::list < DtSignatureModifierEvaluator * >	DtSignatureModifierEvalList
typedef std::map < DtSymbolString, DtSignatureModifierEvalList * >	DtSignatureModifierEvalMap
typedef tbb::concurrent_hash_map < unsigned int, double >	DtSensorSignatureCacheMap
typedef std::pair < DtPostInitializeFromParametersCallbackFcn, void * >	DtPostInitializeFromParametersInfo
typedef std::list < DtPostInitializeFromParametersInfo >	DtPostInitializeFromParametersCallbackList
Protected Member Functions inherited from DtVrfOverlayObjectStateRepository
	DtVrfOverlayObjectStateRepository ()
	Default Constructor. Do not use.
Static Protected Member Functions inherited from DtVrfObjectStateRepository
static bool	visibilityFilter (const DtVrfObject object, void usr)
	Used by isVisible to determine which objects can block visibility.
Static Protected Attributes inherited from DtVrfObjectStateRepository
static DtSimObjectStateRepositoryFactory *	theFactory

Detailed Description

This repository holds all information that is common to all the forms of all objects within VR-Forces that can move.

Constructor & Destructor Documentation

DtWeatherStateRepository::DtWeatherStateRepository	(	DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Constructor.

DtWeatherStateRepository::DtWeatherStateRepository	(	const DtWeatherStateRepository &	orig,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Copy Constructor.

virtual DtWeatherStateRepository::~DtWeatherStateRepository ( )

virtual

Destructor.

DtWeatherStateRepository::DtWeatherStateRepository ( )

private

Default Constructor. Do not use.

Member Function Documentation

DtWeatherStateRepository& DtWeatherStateRepository::operator= ( const DtWeatherStateRepository & orig )

Assignment Operator.

virtual void DtWeatherStateRepository::resetToDefaults ( )

virtual

Called by the constructor to initialize all environment values.

Also used by the DtEnvironmentalStateManager::processObjectRemoved to reset all values when the scenario is closed. The defaults are based on the default record from VR-Vantage's default_EnvironmentList.enlx.

Reimplemented in DtGlobalEnvironmentStateRepository.

static DtVrfObjectStateRepository* DtWeatherStateRepository::creator	(	const DtString &	name,
		DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		DtReaderWriterRegistry *	parentRegistry
	)

static

Reimplemented from DtVrfOverlayObjectStateRepository.

Reimplemented in DtGlobalEnvironmentStateRepository.

static DtWeatherStateRepository* DtWeatherStateRepository::isWeatherStateRepository ( DtSimObjectStateRepository * repository )

static

virtual DtSimObjectStateRepository* DtWeatherStateRepository::clone	(	const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

virtual

Clone.

Reimplemented from DtVrfOverlayObjectStateRepository.

Reimplemented in DtGlobalEnvironmentStateRepository.

virtual DtString DtWeatherStateRepository::type ( ) const

virtual

returns DtSimObjectStateRepositoryType

Reimplemented from DtVrfOverlayObjectStateRepository.

Reimplemented in DtGlobalEnvironmentStateRepository.

virtual void DtWeatherStateRepository::setAirTurbidity ( double value )

virtual

See myAirTurbidity.

virtual double DtWeatherStateRepository::airTurbidity ( ) const

virtual

See myAirTurbidity.

virtual void DtWeatherStateRepository::setAmbientAirTemperature ( double value )

virtual

See myAmbientAirTemperature.

virtual double DtWeatherStateRepository::ambientAirTemperature ( ) const

virtual

See myAmbientAirTemperature.

virtual void DtWeatherStateRepository::setCloudState ( DtVrfWeatherCloudState current )

virtual

See myCloudState.

virtual DtVrfWeatherCloudState DtWeatherStateRepository::cloudState ( ) const

virtual

See myCloudState.

virtual void DtWeatherStateRepository::setPrecipitationIntensity ( double value )

virtual

See myPrecipitationIntensity.

virtual double DtWeatherStateRepository::precipitationIntensity ( ) const

virtual

See myPrecipitationIntensity.

virtual void DtWeatherStateRepository::setPrecipitationType ( DtVrfWeatherPrecipitationType value )

virtual

See myPrecipitationType.

virtual DtVrfWeatherPrecipitationType DtWeatherStateRepository::precipitationType ( ) const

virtual

See myPrecipitationType.

virtual void DtWeatherStateRepository::setWindSpeed ( double value )

virtual

See myWindSpeed.

virtual double DtWeatherStateRepository::windSpeed ( ) const

virtual

See myWindSpeed.

virtual void DtWeatherStateRepository::setWindDirection ( double value )

virtual

See myWindDirection.

virtual double DtWeatherStateRepository::windDirection ( ) const

virtual

See myWindDirection.

virtual void DtWeatherStateRepository::setVisibility ( double value )

virtual

See myVisibility.

virtual double DtWeatherStateRepository::visibility ( ) const

virtual

See myVisibility.

virtual void DtWeatherStateRepository::setPriority ( int value )

virtual

See Also: myPriority

virtual int DtWeatherStateRepository::priority ( ) const

virtual

See Also: myPriority

virtual void DtWeatherStateRepository::setUnderwaterVisibility ( double underwaterVisibility )

virtual

Underwater visibility in meters.

virtual double DtWeatherStateRepository::underwaterVisibility ( ) const

virtual

Underwater visibility in meters.

virtual void DtWeatherStateRepository::setSurfaceTransparency ( double transparency )

virtual

Surface transparency (percentage)

virtual double DtWeatherStateRepository::surfaceTransparency ( ) const

virtual

Surface transparency (percentage)

virtual void DtWeatherStateRepository::setWaterCurrentSpeed ( double waterCurrentSpeed )

virtual

Water velocity in meters per second.

virtual double DtWeatherStateRepository::waterCurrentSpeed ( ) const

virtual

Water velocity in meters per second.

virtual void DtWeatherStateRepository::setWaterCurrentDirection ( double waterCurrentDirection )

virtual

Water direction in radians clockwise from 0 (north)

virtual double DtWeatherStateRepository::waterCurrentDirection ( ) const

virtual

Water direction in radians clockwise from 0 (north)

virtual void DtWeatherStateRepository::setAmbientWaterTemperature ( double waterTemperature )

virtual

Ambient water temperature in Celsius.

virtual double DtWeatherStateRepository::ambientWaterTemperature ( ) const

virtual

Ambient water temperature in Celsius.

virtual void DtWeatherStateRepository::setTidalOffset ( double tidalOffset )

virtual

Tidal offset in meters from the water polygons in the database.

virtual double DtWeatherStateRepository::tidalOffset ( ) const

virtual

Tidal offset in meters from the water polygons in the database.

virtual void DtWeatherStateRepository::setTidalDirection ( bool tidalDirection )

virtual

Tidal direction where true represents the tide going in and false represents the tide going out.

virtual bool DtWeatherStateRepository::tidalDirection ( ) const

virtual

Tidal direction where true represents the tide going in and false represents the tide going out.

virtual void DtWeatherStateRepository::setSwellState ( unsigned int state )

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual unsigned int DtWeatherStateRepository::swellState ( ) const

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual void DtWeatherStateRepository::setSwellStateDirection ( double direction )

virtual

Swell direction in in radians clockwise from 0 (north)

virtual double DtWeatherStateRepository::swellStateDirection ( ) const

virtual

Swell direction in in radians clockwise from 0 (north)

virtual void DtWeatherStateRepository::setSeaState ( unsigned int state )

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual unsigned int DtWeatherStateRepository::seaState ( ) const

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual void DtWeatherStateRepository::setSeaStateDirection ( double direction )

virtual

Swell direction in in radians clockwise from 0 (north)

virtual double DtWeatherStateRepository::seaStateDirection ( ) const

virtual

Swell direction in in radians clockwise from 0 (north)

virtual void DtWeatherStateRepository::setWindDrivenSeaStateEnabled ( bool b )

virtual

Determines if the sea state is set based on the wind.

virtual bool DtWeatherStateRepository::windDrivenSeaStateEnabled ( ) const

virtual

Determines if the sea state is set based on the wind.

virtual void DtWeatherStateRepository::setChoppiness ( double choppiness )

virtual

Wave choppiness (0..1)

virtual double DtWeatherStateRepository::choppiness ( ) const

virtual

Wave choppiness (0..1)

virtual void DtWeatherStateRepository::setSurgeDepth ( double depth )

virtual

Surge depth (meters)

virtual double DtWeatherStateRepository::surgeDepth ( ) const

virtual

Surge depth (meters)

virtual void DtWeatherStateRepository::setThermoclineLayer1Depth ( double depth )

virtual