Inheritance diagram for DtFixedWingFlightPSR:

Public Member Functions
	DtFixedWingFlightPSR (DtVrfObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)
	constructor
	DtFixedWingFlightPSR (const DtFixedWingFlightPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtFixedWingFlightPSR ()
	destructor
DtFixedWingFlightPSR &	operator= (const DtFixedWingFlightPSR &orig)
	assignment operator
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual void	setMaxThrustAccleration (double acceleration)
	maximum thrust acceleration in meters/second/second
virtual double	maxThrustAcceleration () const
virtual void	setNormalizedBodyVelocity (const DtVector &velocity)
virtual const DtVector &	normalizedBodyVelocity () const
virtual void	setLocalAngularVelocity (double velocity)
virtual double	localAngularVelocity () const
virtual void	setSpeedRatioSquared (double value)
virtual double	speedRatioSquared () const
virtual void	setFinishing (bool flag)
virtual bool	isFinishing () const
virtual void	setApproachingVertex (bool flag)
virtual bool	isApproachingVertex () const
virtual void	setBanking (bool flag)
virtual bool	isBanking () const
virtual void	setLastDistanceSquared (double value)
virtual double	lastDistanceSquared () const
virtual void	setDistanceSquared (double value)
virtual double	distanceSquared () const
virtual void	setTakeOffDir (const DtVector &takeOffDir)
virtual const DtVector &	takeOffDir () const
virtual void	setLandingDir (const DtVector &landingDir)
virtual const DtVector &	landingDir () const
virtual void	setEntityToFollow (const DtString &objectName)
	Object name of entity to follow.
virtual const DtString &	entityToFollow () const
virtual void	setFollowOffsetVector (const DtVector &offset)
	Following offset, in body coordinates of the entity being followed (meters).
virtual const DtVector &	followOffsetVector () const
virtual void	setLoiterRadius (double radius)
	Radius of circle followed when not executing a task (loitering).
virtual double	loiterRadius () const
virtual void	setLoiterClockwise (bool flag)
	Flag indicating whether loiter circle should be executed clockwise or not.
virtual bool	loiterClockwise () const
virtual void	setLoiterCenter (const DtVector &center)
	Location of center of circle to be followed when loitering (meters).
virtual const DtVector &	loiterCenter () const
virtual void	setControlPointName (const DtString &objectName)
	Object name of control object (waypoint) to move to.
virtual const DtString &	controlPointName () const
virtual void	setMovementStatus (const DtFixedWingMovementStatus movementStatus)
	Current movement status for the entity i.e.
virtual const DtFixedWingMovementStatus	movementStatus () const
virtual void	setPreviousAltitude (const double speed)
virtual const double	previousAltitude () const
virtual void	setFirstWaypointName (const DtString &objectName)
	Object name of first waypoint (in a patrol-between task).
virtual const DtString &	firstWaypointName () const
virtual void	setSecondWaypointName (const DtString &objectName)
	Object name of second waypoint (in a patrol-between task).
virtual const DtString &	secondWaypointName () const
virtual void	setReversePatrol (bool reverse)
	Reverse the direction of a patrol-between or a patrol-along task.
virtual bool	reversePatrol () const
virtual void	setRouteName (const DtString &objectName)
	Object name of route to move along.
virtual const DtString &	routeName () const
virtual void	setUseFixedPitch (bool)
	Set/get whether or not flying is using fixed pitch.
virtual bool	useFixedPitch () const
virtual void	setRouteVertices (const DtLocalVectorIterator &routeIterator)
	Set/get route vertices (local coordinates).
virtual const DtLocalVertexList &	routeVertices () const
virtual void	emptyRouteVertices ()
	Empty route vertices.
virtual DtLocalVectorIterator *	routeState () const
	Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to set myCurrentVertex from route state before writing.
virtual void	resetRouteState ()
	Sets current vertex to 0 and sets value specified to false.
virtual void	setWorldAimingPoint (const DtVector &pnt)
	Get/set the point to which this entity is moving towards for a move to location task.
virtual const DtVector &	worldAimingPoint () const
virtual void	setMovingToAltitude (bool movingToAlt)
	Should be true when processing a move to altutude task.
virtual bool	movingToAltitude () const
	Should be true when processing a move to altutude task.
virtual void	setMoveToAltitudeValue (double altitude)
	Set the requested altitude from the move to altitude task.
virtual double	moveToAltitudeValue () const
	The requested altitude from the move to altitude task.

virtual void	setWaitingToSetMovementStatus (bool)
	True when a controller is waiting for terrain data in order to set it's movement status.
virtual bool	waitingToSetMovementStatus () const
	True when a controller is waiting for terrain data in order to set it's movement status.
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry)
	Returns a newly created instance of this class.
Protected Attributes
double	myMaxThrustAcceleration
	Moved here from DtFixedWingPilotController (fixWngPltCtl.h)
DtRwVector	myNormalizedBodyVelocity
DtRwReal	myLocalAngularVelocity
DtRwReal	mySpeedRatioSquared
DtRwBoolean	myFinishing
DtRwBoolean	myApproachingVertex
DtRwBoolean	myBanking
DtRwReal	myLastDistanceSquared
DtRwReal	myDistanceSquared
DtRwVector	myTakeOffDir
DtRwVector	myLandingDir
DtRwString	myEntityToFollow
	Moved here from DtFixedWingFollowEntityController (fixWngFolwCtl.h).
DtRwVector	myOffsetVector
DtRwReal	myRadius
	Moved here from DtFixedWingDefaultController (fixWngDefCtl.h).
DtRwBoolean	myClockwise
DtRwVector	myLoiterCircleCenter
	Location of loiter circle center.
DtRwString	myControlObjectName
	Moved here from DtFixedWingMoveToController (fixWngMvToCtl.h)
DtRwInt	myMovementStatus
DtRwReal	myPreviousAltitude
	Intended to hold the previous altitude when flying or taxiing so the current altitude can be compared to help determine if the FWE is landing or taking off.
DtRwString	myFirstWaypoint
	Moved here from DtFixedWingPatrolBetweenController (fixWngPtlBtwn.h)
DtRwString	mySecondWaypoint
DtRwBoolean	myReverseFlag
DtRwString	myRouteName
	Moved here from DtFixedWingMoveAlongController (fixWngMvAlg.h).
DtLocalVectorIterator *	myRouteState
	Route state used to get info about the current route we're trying to follow (e.g.
DtLocalVertexList	myVertices
	my copy of the current route
DtRwInt	myCurrentVertex
	Read/write variables to capture route state.
DtRwVector	myWorldAimingPoint
	World point for move to location tasks.
DtRwBoolean	myMovingToAltitude
DtRwReal	myMoveToAltitudeValue
DtRwBoolean	myUseFixedPitch
DtRwBoolean	myWaitingToSetMovementStatus

Detailed Description

class DtFixedWingFlightPSR:

Instances of DtFixedWingFlightPSR are used to hold the shared/checkpointable state data associated with the process of fixed wing flight.

Constructor & Destructor Documentation

DtFixedWingFlightPSR::DtFixedWingFlightPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

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

copy constructor

virtual DtFixedWingFlightPSR::~DtFixedWingFlightPSR ( ) [virtual]

destructor

Member Function Documentation

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

assignment operator

virtual DtVrfProcessStateRepository* DtFixedWingFlightPSR::clone	(	const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const `[virtual]`

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtFixedWingFlightPSR::type ( ) const [virtual]

Returns the string type of the repository, as defined in procSRTypes.h.

(DtVrfFixedWingFlightProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

virtual void DtFixedWingFlightPSR::setMaxThrustAccleration ( double acceleration ) [virtual]

maximum thrust acceleration in meters/second/second

virtual double DtFixedWingFlightPSR::maxThrustAcceleration ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setNormalizedBodyVelocity ( const DtVector & velocity ) [virtual]

virtual const DtVector& DtFixedWingFlightPSR::normalizedBodyVelocity ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setLocalAngularVelocity ( double velocity ) [virtual]

virtual double DtFixedWingFlightPSR::localAngularVelocity ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setSpeedRatioSquared ( double value ) [virtual]

virtual double DtFixedWingFlightPSR::speedRatioSquared ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setFinishing ( bool flag ) [virtual]

virtual bool DtFixedWingFlightPSR::isFinishing ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setApproachingVertex ( bool flag ) [virtual]

virtual bool DtFixedWingFlightPSR::isApproachingVertex ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setBanking ( bool flag ) [virtual]

virtual bool DtFixedWingFlightPSR::isBanking ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setLastDistanceSquared ( double value ) [virtual]

virtual double DtFixedWingFlightPSR::lastDistanceSquared ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setDistanceSquared ( double value ) [virtual]

virtual double DtFixedWingFlightPSR::distanceSquared ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setTakeOffDir ( const DtVector & takeOffDir ) [virtual]

virtual const DtVector& DtFixedWingFlightPSR::takeOffDir ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setLandingDir ( const DtVector & landingDir ) [virtual]

virtual const DtVector& DtFixedWingFlightPSR::landingDir ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setEntityToFollow ( const DtString & objectName ) [virtual]

Object name of entity to follow.

virtual const DtString& DtFixedWingFlightPSR::entityToFollow ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setFollowOffsetVector ( const DtVector & offset ) [virtual]

Following offset, in body coordinates of the entity being followed (meters).

virtual const DtVector& DtFixedWingFlightPSR::followOffsetVector ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setLoiterRadius ( double radius ) [virtual]

Radius of circle followed when not executing a task (loitering).

(meters).

virtual double DtFixedWingFlightPSR::loiterRadius ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setLoiterClockwise ( bool flag ) [virtual]

Flag indicating whether loiter circle should be executed clockwise or not.

virtual bool DtFixedWingFlightPSR::loiterClockwise ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setLoiterCenter ( const DtVector & center ) [virtual]

Location of center of circle to be followed when loitering (meters).

virtual const DtVector& DtFixedWingFlightPSR::loiterCenter ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setControlPointName ( const DtString & objectName ) [virtual]

Object name of control object (waypoint) to move to.

virtual const DtString& DtFixedWingFlightPSR::controlPointName ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setMovementStatus ( const DtFixedWingMovementStatus movementStatus ) [virtual]

Current movement status for the entity i.e.

is it taxiing, flying, taking off, landing, etc...

virtual const DtFixedWingMovementStatus DtFixedWingFlightPSR::movementStatus ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setPreviousAltitude ( const double speed ) [virtual]

virtual const double DtFixedWingFlightPSR::previousAltitude ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setFirstWaypointName ( const DtString & objectName ) [virtual]

Object name of first waypoint (in a patrol-between task).

virtual const DtString& DtFixedWingFlightPSR::firstWaypointName ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setSecondWaypointName ( const DtString & objectName ) [virtual]

Object name of second waypoint (in a patrol-between task).

virtual const DtString& DtFixedWingFlightPSR::secondWaypointName ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setReversePatrol ( bool reverse ) [virtual]

Reverse the direction of a patrol-between or a patrol-along task.

virtual bool DtFixedWingFlightPSR::reversePatrol ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setRouteName ( const DtString & objectName ) [virtual]

Object name of route to move along.

virtual const DtString& DtFixedWingFlightPSR::routeName ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setUseFixedPitch ( bool ) [virtual]

Set/get whether or not flying is using fixed pitch.

virtual bool DtFixedWingFlightPSR::useFixedPitch ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setRouteVertices ( const DtLocalVectorIterator & routeIterator ) [virtual]

Set/get route vertices (local coordinates).

Once route is set, can access routeState() to query and set current position along route.

virtual const DtLocalVertexList& DtFixedWingFlightPSR::routeVertices ( ) const [virtual]

virtual void DtFixedWingFlightPSR::emptyRouteVertices ( ) [virtual]

Empty route vertices.

virtual DtLocalVectorIterator* DtFixedWingFlightPSR::routeState ( ) const [virtual]

Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).

virtual void DtFixedWingFlightPSR::putSelf	(	FILE *	fp,
		int	indentLevel = `0`,
		bool	writeUnspecified = `false`,
		const DtFilename &	path = `DtReaderWriter::appPath()`
	)		`[virtual]`

Override to set myCurrentVertex from route state before writing.

Reimplemented from DtReaderWriter.

virtual void DtFixedWingFlightPSR::resetRouteState ( ) [virtual]

Sets current vertex to 0 and sets value specified to false.

virtual void DtFixedWingFlightPSR::setWorldAimingPoint ( const DtVector & pnt ) [virtual]

Get/set the point to which this entity is moving towards for a move to location task.

This point is only valid for that task and is set in world (geocentric) coordinates

virtual const DtVector& DtFixedWingFlightPSR::worldAimingPoint ( ) const [virtual]

virtual void DtFixedWingFlightPSR::setMovingToAltitude ( bool movingToAlt ) [virtual]

Should be true when processing a move to altutude task.

virtual bool DtFixedWingFlightPSR::movingToAltitude ( ) const [virtual]

Should be true when processing a move to altutude task.

virtual void DtFixedWingFlightPSR::setMoveToAltitudeValue ( double altitude ) [virtual]

Set the requested altitude from the move to altitude task.

virtual double DtFixedWingFlightPSR::moveToAltitudeValue ( ) const [virtual]

The requested altitude from the move to altitude task.

virtual void DtFixedWingFlightPSR::setWaitingToSetMovementStatus ( bool ) [virtual]

True when a controller is waiting for terrain data in order to set it's movement status.

virtual bool DtFixedWingFlightPSR::waitingToSetMovementStatus ( ) const [virtual]

True when a controller is waiting for terrain data in order to set it's movement status.

static DtVrfProcessStateRepository* DtFixedWingFlightPSR::creator	(	const DtString &	rwName,
		DtVrfObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry
	)		`[static]`

Returns a newly created instance of this class.

Member Data Documentation

double DtFixedWingFlightPSR::myMaxThrustAcceleration [protected]

Moved here from DtFixedWingPilotController (fixWngPltCtl.h)

Note: myMaxThrustAcceleration is not saved to the OOB -- it is here only to share info between the actuator (which is the source of this info) and the controller, which needs to know it.

DtRwVector DtFixedWingFlightPSR::myNormalizedBodyVelocity [protected]

DtRwReal DtFixedWingFlightPSR::myLocalAngularVelocity [protected]

DtRwReal DtFixedWingFlightPSR::mySpeedRatioSquared [protected]

DtRwBoolean DtFixedWingFlightPSR::myFinishing [protected]

DtRwBoolean DtFixedWingFlightPSR::myApproachingVertex [protected]

DtRwBoolean DtFixedWingFlightPSR::myBanking [protected]

DtRwReal DtFixedWingFlightPSR::myLastDistanceSquared [protected]

DtRwReal DtFixedWingFlightPSR::myDistanceSquared [protected]

DtRwVector DtFixedWingFlightPSR::myTakeOffDir [protected]

DtRwVector DtFixedWingFlightPSR::myLandingDir [protected]

DtRwString DtFixedWingFlightPSR::myEntityToFollow [protected]

Moved here from DtFixedWingFollowEntityController (fixWngFolwCtl.h).

Set when a follow entity task is received.

DtRwVector DtFixedWingFlightPSR::myOffsetVector [protected]

DtRwReal DtFixedWingFlightPSR::myRadius [protected]

Moved here from DtFixedWingDefaultController (fixWngDefCtl.h).

DtRwBoolean DtFixedWingFlightPSR::myClockwise [protected]

DtRwVector DtFixedWingFlightPSR::myLoiterCircleCenter [protected]

Location of loiter circle center.

DtRwString DtFixedWingFlightPSR::myControlObjectName [protected]

Moved here from DtFixedWingMoveToController (fixWngMvToCtl.h)

If tasked() is true, this is the name of the control object we're moving to.

DtRwInt DtFixedWingFlightPSR::myMovementStatus [protected]

DtRwReal DtFixedWingFlightPSR::myPreviousAltitude [protected]

Intended to hold the previous altitude when flying or taxiing so the current altitude can be compared to help determine if the FWE is landing or taking off.

DtRwString DtFixedWingFlightPSR::myFirstWaypoint [protected]

Moved here from DtFixedWingPatrolBetweenController (fixWngPtlBtwn.h)

Set when a patrol between task is received.

DtRwString DtFixedWingFlightPSR::mySecondWaypoint [protected]

DtRwBoolean DtFixedWingFlightPSR::myReverseFlag [protected]

DtRwString DtFixedWingFlightPSR::myRouteName [protected]

Moved here from DtFixedWingMoveAlongController (fixWngMvAlg.h).

If tasked() is true, this is the name of the route object we're moving to.

DtLocalVectorIterator* DtFixedWingFlightPSR::myRouteState [protected]

Route state used to get info about the current route we're trying to follow (e.g.

which vertex to move toward).

DtLocalVertexList DtFixedWingFlightPSR::myVertices [protected]