DtSubsurfaceEntityStateRepository Class Reference

Class: DtSurfaceEntityStateRepository. More...

Inheritance diagram for DtSubsurfaceEntityStateRepository:

Public Member Functions
	DtSubsurfaceEntityStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	Constructor with parameters to set up read/writability correctly.
	DtSubsurfaceEntityStateRepository (const DtSubsurfaceEntityStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSubsurfaceEntityStateRepository &	operator= (const DtSubsurfaceEntityStateRepository &orig)
	assignment operator
virtual	~DtSubsurfaceEntityStateRepository ()
	destructor
virtual DtString	type () const
virtual const int	vrfMovingObjectStateRepositorySubType () const
virtual void	place (const DtVector &location, const DtReal heading, bool clampToGroundFlag=true, bool *dataAvailable=0, bool requireAllData=false)
	Overriden from base class to check altitude of location.
Public Member Functions inherited from DtVrfMovingObjectStateRepository
	DtVrfMovingObjectStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtVrfMovingObjectStateRepository (const DtVrfMovingObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy Constructor.
DtVrfMovingObjectStateRepository &	operator= (const DtVrfMovingObjectStateRepository &orig)
	Assignment Operator.
virtual	~DtVrfMovingObjectStateRepository ()
	Destructor.
virtual void	tick ()
	Tick function.
virtual DtSimObjectStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Clone.
virtual const int	vrfObjectStateRepositorySubType () const
	Returns DtVrfObjectStateRepositorySubTypeMoving.
virtual bool	createParameters ()
virtual void	initializeFromParameters ()
virtual const DtMovingObjectParameters *	movingObjectParameters () const
virtual bool	canPivot () const
virtual void	setCanPivot (const bool canPivot)
virtual DtReal	maxPivotSpeed () const
virtual void	setMaxPivotSpeed (DtReal maxPivotSpeed)
virtual const DtGroundInteractionPt *	rightSupport () const
	ground contact points
virtual DtGroundInteractionPt *	rightSupport ()
virtual void	setRightSupport (const DtVector &vec)
virtual const DtGroundInteractionPt *	leftSupport () const
virtual DtGroundInteractionPt *	leftSupport ()
virtual void	setLeftSupport (const DtVector &vec)
virtual const DtGroundInteractionPt *	otherSupport () const
virtual DtGroundInteractionPt *	otherSupport ()
virtual void	setOtherSupport (const DtVector &vec)
virtual DtReal	maxSpeed () const
virtual void	setMaxSpeed (const DtReal speed)
virtual DtReal	maxReverseSpeed () const
virtual void	setMaxReverseSpeed (const DtReal speed)
virtual DtReal	turningRadius () const
virtual void	setTurningRadius (const DtReal turningRadius)
virtual DtReal	maxSlope () const
virtual void	setMaxSlope (const DtReal slope)
virtual DtReal	orderedSpeed () const
	Can be set from a parameter file or by the user with a set speed command.
virtual void	setOrderedSpeed (const DtReal speed)
virtual DtReal	orderedAltitude () const
	As specifeed by a setAltitude command, or the Z parameter of a destination waypoint.
virtual void	setOrderedAltitude (DtReal orderedAltitude)
virtual DtReal	maxAcceleration () const
virtual void	setMaxAcceleration (const DtReal maxAcceleration)
virtual DtReal	maxStoppingDeceleration () const
virtual void	setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration)
virtual DtReal	maxLateralAcceleration () const
virtual void	setMaxLateralAcceleration (const DtReal maxLateralAcceleration)
virtual DtReal	fuelEfficiency () const
virtual void	setFuelEfficiency (const DtReal fuelEfficiency)
virtual DtReal	inverseStoppingDeceleration () const
	Set by setting maxStoppingDeceleration.
virtual bool	forward () const
virtual void	setForward (const bool forward)
virtual bool	amClampedToGround () const
	Specifies whether we're clamped to the ground or not.
virtual void	setAmClampedToGround (const bool clamp)
virtual bool	usingRailMovement () const
	Specifies the entity's desired movement strategy.
virtual void	setUsingRailMovement (const bool rails)
virtual void	clampToGround (const DtVector &location, const DtReal heading, bool *dataAvailable=0, bool requireAllData=false)
	Place entity on ground at location and heading.
virtual void	clampToGround (const DtVector &location, const DtReal heading, bool gravityAligned, bool *dataAvailable=0, bool requireAllData=false)
	Clamps to ground with/without being aligned to gravity.
virtual void	updateSupportPoints (const DtVector &newPosition, const DtReal newHeading)
	When reading in a scenario, want to make sure the support points get set up properly.
virtual DtVector	parentPosition ()
	Returns parentPosition in kinematic state.
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	placeAtAltitude (const DtVector &location, const DtReal heading)
	Places entity at altitude regardless of terrain.
virtual void	setDIGuyCharacterInfo (DtRwDIGuyCharacterInfo *info)
	Current DI-Guy character data–Our character type, current appearance and.
virtual DtRwDIGuyCharacterInfo *	diGuyCharacterInfo ()
virtual void	setDIGuyCharacter (const DtString &character)
	The DI-Guy Character string for this entity.
virtual const DtString &	dIGuyCharacter () const
	The DI-Guy Character string for this entity.
virtual void	setDIGuyAnimation (const DtString &animation)
	The current DI-Guy animation the entity is displaying.
virtual const DtString &	dIGuyAnimation () const
	The current DI-Guy animation the entity is displaying.
virtual void	setDIGuyAppearance (const DtString &app)
	The current Di-Guy character appearance of the entity.
virtual const DtString &	dIGuyAppearance () const
	The current Di-Guy character appearance of the entity.
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 const DtVrfObjectParameters *	vrfParameters () 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 DtString &componentName)
	Clear all the tasks with the specified component name.
virtual void	clearCurrentTaskMsg (const DtString &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 DtString &componentName) const
	Get the current task message.
virtual DtTaskMessage *	currentTaskMsg (const DtString &componentName, int taskId) const
	Get the current task message for the specified component and task ID.
virtual std::list < DtTaskMessage * >	allCurrentTaskMsg (const DtString &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 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 DtVrfObject *	leadEntity () const
virtual const DtString &	firstSubordinate () const
virtual const DtString &	lastSubordinate () const
virtual const DtString &	firstHealthySubordinate () const
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	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 myParentName 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	detachFromParent ()
virtual void	attachToParent (DtSimObjectStateRepository *parent)
	Adds this state repository to the given parent's list of attached state repositories and updates myAttachedToRepository and myRootSimStateRepository.
virtual void	attachToParent (DtString parent)
	Looks up the parent state repository using the given echelon ID and puts it in a call to attachToParent.
virtual void	addAttachedTerrain (const DtString &parent)
	Asks the sim manager to look up the object model for the requested database.
virtual void	removeAttachedTerrain (const DtString &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.
DtReal	forwardSpeed () const
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 double	sensorSignature (const DtSymbolString &sensorDomain) const
	Returns the current absolute signature for this object in the specified sensor domain.
virtual std::list< DtSymbolString >	sensorSignatureDomains () const
virtual DtVrfObjectStateRepository *	toVrfObjectStateRepository ()
virtual const DtVrfObjectStateRepository *	toVrfObjectStateRepository () 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 DtString &componentName, bool tasked)
	Set/get whether or not a given entity component currently executing a task.
virtual void	setTasked (const DtString &componentName, int taskID, bool tasked)
	Set/get whether or not a given entity component currently executing a task.
virtual bool	tasked (const DtString &componentName) const
	Set/get whether or not a given entity component currently executing a task.
virtual void	setCurrentTaskMsg (const DtString &componentName, const DtTaskMessage &taskMsg)
	Set the current task message.
virtual void	setCurrentTaskMsg (const DtString &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 DtString &componentName, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	addPendingSubtaskId (const DtString &componentName, int taskId, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual bool	findPendingSubtaskId (const DtString &componentName, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual bool	findPendingSubtaskId (const DtString &componentName, int taskId, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	removePendingSubtaskId (const DtString &componentName, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	removePendingSubtaskId (const DtString &componentName, int taskId, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	removeAllPendingSubtaskIds (const DtString &componentName)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	removeAllPendingSubtaskIds (const DtString &componentName, int taskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual void	printPendingSubtaskIds (const DtString &componentName) const
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual std::vector< int >	currentPendingSubstaskIds (const DtString &componentName) const
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual std::vector< int >	currentPendingSubstaskIds (const DtString &componentName, int taskId) const
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual DtSubtaskStatusEntry *	pendingSubtaskStatus (const DtString &componentName, int subtaskId)
	Functions for manipulating the set of pending subtask Ids for all components in the entity.
virtual DtSubtaskStatusEntry *	pendingSubtaskStatus (const DtString &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 DtSensorContactInfoList &	objectContactList ()
	Situational awareness of this object.
virtual const DtSensorContactInfoList &	objectContactList () const
	Situational awareness of this object.
virtual void	processObjectAddedCallback (DtVrfObject *vrfObject)
	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 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 DtString &parent) const
virtual const DtString &	attachedToRepositoryName ()
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 DtString &parent)
	Embarks this entity on the specified parent.
virtual bool	leftOf (const DtVector &localVector) const
virtual bool	inside (const DtVector &point) 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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtVrfObjectStateRepository *	creator (const DtString &name, DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
Static Public Member Functions inherited from DtVrfMovingObjectStateRepository
static DtVrfMovingObjectStateRepository *	isVrfMovingObjectStateRepository (DtSimObjectStateRepository *repository)
static const DtVrfMovingObjectStateRepository *	isVrfMovingObjectStateRepository (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	objectAddedCallback (DtVrfObject *vrfObject, void *usr)
	These callbacks are used to set myAttachedToStateRepository when this ent gets attached/detached to/from its parent.
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 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 DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Member Functions
	DtSubsurfaceEntityStateRepository ()
	default constructor cannot be used
Protected Member Functions inherited from DtVrfMovingObjectStateRepository
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Override getSelf to handle mapping of old pre-2.0 oob files.
	DtVrfMovingObjectStateRepository ()
	Default Constructor. Do not use.
Protected Member Functions inherited from DtVrfObjectStateRepository
	DtVrfObjectStateRepository ()
	Default Constructor. Do not use.
virtual void	initializeNextTaskId ()
	Initializes myNextTaskId to the next highest integer than the highest subtask Id currently maintained in myTaskStatusList.
virtual void	setOrientationRelativeToParent ()
	If attached to a parent, and a terrain database is present, set orientation relative to parent.
virtual DtAttachedTerrain *	createAttachedTerrain ()
virtual DtArticulatedPartStateRepository *	createArtPartStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString())
	Returns new instance of a DtArticulatedPartStateRepository.
virtual double	baseSensorSignature (const DtSymbolString &sensorDomain) const
virtual double	modifySensorSignature (const DtSymbolString &sensorDomain, double baseSignature) const
	Modifies the supplied baseSignature using the signatureModifiers for the specified sensor domain.
virtual bool	initSignatureEvaluators ()
	Sets up all the sensor signature evaluators in mySignatureEvalMap based on the parameter entry for this entity.
void	clearSignatureEvaluators ()
	Removes and deletes all signature evaluators.
virtual bool	createObjectResourceManager ()
	Creates and sets myObjectResourceManager.
virtual void	invokePostInitFromParamsCallbacks ()
	Invokes all callbacks registered via a call to addPostInitFromParamsCallback.
Protected Member Functions inherited from DtSimObjectStateRepository
	DtSimObjectStateRepository (const DtSimObjectStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtSimObjectStateRepository ()
	Default Constructor; not implemented.
const Coordinate_System *	coordinateSystem () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Types inherited from DtVrfObjectStateRepository
typedef std::list < DtSignatureModifierEvaluator * >	DtSignatureModifierEvalList
typedef std::map < DtSymbolString, DtSignatureModifierEvalList * >	DtSignatureModifierEvalMap
typedef std::map < DtSymbolString, double >	DtSensorSignatureCacheMap
typedef std::pair < DtPostInitializeFromParametersCallbackFcn, void * >	DtPostInitializeFromParametersInfo
typedef std::list < DtPostInitializeFromParametersInfo >	DtPostInitializeFromParametersCallbackList
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.
Protected Attributes inherited from DtVrfMovingObjectStateRepository
DtGroundInteractionPt	myLeftSupport
DtGroundInteractionPt	myRightSupport
DtGroundInteractionPt	myOtherSupport
DtRwReal	myOrderedSpeed
DtRwReal	myOrderedAltitude
DtRwReal	myMaxSpeed
DtRwReal	myMaxReverseSpeed
DtRwReal	myTurningRadius
DtRwReal	myMaxSlope
DtRwBoolean	myForward
DtRwReal	myMaxAcceleration
DtRwReal	myMaxStoppingDeceleration
DtRwReal	myMaxLateralAcceleration
DtRwReal	myFuelEfficiency
DtRwBoolean	myCanPivot
DtRwBoolean	myClampToGround
DtRwBoolean	myUsingRailMovement
	If true keeps the entity clamped to the route segment it is on, no steering just follows the segment.
DtRwReal	myMaxPivotSpeed
DtRwDIGuyCharacterInfo *	myDIGuyCharacterInfo
DtReal	myInverseStoppingDeceleration
	Derived quantity (1/myMaxStoppingDeceleration) - no need to make it read-write.
DtRwBoolean	myKeepGroundClampingFlag
	Records whether we should keep ground clamping b/c not all terrain was loaded.
Static Protected Attributes inherited from DtVrfObjectStateRepository
static DtSimObjectStateRepositoryFactory *	theFactory

Detailed Description

Class: DtSurfaceEntityStateRepository.

Used to override place method to correctly ground clamp or not depending on requested placed position

Constructor & Destructor Documentation

DtSubsurfaceEntityStateRepository::DtSubsurfaceEntityStateRepository ( )

protected

default constructor cannot be used

DtSubsurfaceEntityStateRepository::DtSubsurfaceEntityStateRepository	(	DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Constructor with parameters to set up read/writability correctly.

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

copy constructor

virtual DtSubsurfaceEntityStateRepository::~DtSubsurfaceEntityStateRepository ( )

virtual

destructor

Member Function Documentation

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

static

Reimplemented from DtVrfMovingObjectStateRepository.

const DtSubsurfaceEntityStateRepository& DtSubsurfaceEntityStateRepository::operator=

(

const DtSubsurfaceEntityStateRepository &

orig

)

assignment operator

virtual DtString DtSubsurfaceEntityStateRepository::type ( ) const

virtual

Returns

The string type of the repository, as defined in vrfSRTypes.h.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const int DtSubsurfaceEntityStateRepository::vrfMovingObjectStateRepositorySubType ( ) const

virtual

Returns

DtVrfMovingObjectStateRepositorySubTypeSurface.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual void DtSubsurfaceEntityStateRepository::place ( const DtVector &  location, const DtReal  heading, bool  clampToGroundFlag = true, bool *  dataAvailable = 0, bool  requireAllData = false  )

virtual

Overriden from base class to check altitude of location.

If altitude is within a certain buffer of the ground polygon (or nearest polygon) then clamp else do not clamp and set the myClampToGround flag as false. If this is a subsurface type then also clamp if trying to place in air, else let the placement go (as in torpedoes can be air launched).

Reimplemented from DtVrfMovingObjectStateRepository.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/subSurfEntSR.h