DtFixedWingLandingController Class Reference

DtFixedWingLandingController is a controller that models landing for fixed-wing entities. More...

Inheritance diagram for DtFixedWingLandingController:

Public Member Functions
	DtFixedWingLandingController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtFixedWingLandingController ()
	destructor
virtual bool	init ()
	Initializes any state that is needed.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual bool	tickWhileDestroyed () const
	Overridden so that controller can delete any control point it created when the entity is destroyed.
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtSingleTaskControllerComponent ()
	destructor
virtual void	postTick ()
	Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task.
virtual void	taskNotify (const DtSimTask &task)
	This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void	taskComplete (bool success=true)
	If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself.
virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks.
virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks.
virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component.
virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks.
virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller.
virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr	currentTaskState () const
virtual bool	decideToGiveUpTask () const
	This function is used to determine if the controller should give up trying to execute the current task.
virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true.
virtual bool	taskActive (int taskId) const
virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared.
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller.
virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller.
virtual std::list < DtTaskMessage * >	currentTaskMessages () const
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtTaskControllerComponent ()
	destructor
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimBaseRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback.
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback().
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback.
virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks().
virtual void	disable ()
	Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
	The current tasked state of this controller.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimBaseRadio *	radio ()
	The radio this component is listening to.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
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 double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
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
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual 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 DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions
virtual void	registerTaskMsgCallbacks ()
	Override for interest of landing tasks.
virtual void	preFirstTickInit ()
	Calls setupExistingConditions.
virtual void	tick ()
	Ticks and performs current state.
virtual void	clearCurrentTaskMessage ()
	Resets state flag to DtIdle.
virtual void	clearTask ()
	Override to clear out any subtasks we might have.
virtual void	removeControlPoint ()
	Removes any control points created by this task.
virtual bool	createPSR ()
	Tasks.
DtFixedWingFlightPSR *	lookupFixedWingFlightPSR ()
	Looks up the fixed wing flight PSR in the PSR manager, and returns it.
virtual bool	createPorts ()
	Creates the landing gear control port.
virtual void	processTaskComplete (DtSimMessage *msg)
virtual void	processLandingStripChanged (DtVrfObject *)
virtual void	processLandingTask (DtSimMessage *msg)
	Starts the processing of the landing task.
virtual void	processDeleteVrfObjectCallback (DtVrfObject *obj)
virtual bool	generateApproachRoute ()
	Creates the approach point to start the landing process (the point from which the fixed wing will move to the landing vector).
virtual bool	generateLandingRoute ()
	Creates a route for the final landing phase.
virtual void	setState (DtVrfFixedWingLandingPSR::DtLandingControllerState)
	Sets state in PSR and returns state from PSR.
virtual DtVrfFixedWingLandingPSR::DtLandingControllerState	state () const
virtual void	initRunwayCoordTransform (const DtVector &runwayStartLocal, const DtVector &runwayEndLocal, DtCoordTransform &resultTransform) const
virtual double	calculateDecelerationConstant () const
	Calculates the acceleration (average) needed to get from point A to point B, given a starting speed of the current ordered speed and ending speed of landing speed.
virtual double	calculateApproachSpeed () const
	Calculates the speed needed to have at start of approach route.
virtual void	setupExistingConditions ()
	Sets up any initial conditions on the first tick.
virtual void	setApproachSpeed ()
	Sends a setSpeed message to the entity with the appropriate approach speed.
virtual void	flyingAlongApproachRoute ()
	Called while the entity is flying along the approach route.
virtual void	moveAlongLandingStrip ()
	Called when the pre-approach task is complete and the plane will now be tasked to move along the landing strip.
virtual void	movingAlongLandingStrip ()
	Currently no-ops.
virtual bool	moveAlongLandingRouteRemainder ()
	If the landing route has more than two vertices, issue a move-along task (with start-at-closest-vertex set to true) to move the plane along the remainder of the route.
virtual bool	checkPositionOnFinalLeg ()
	Checks if the entity is positioned for the final approach leg.
virtual void	flyingTowardsApproachRoute ()
	Called until while the entity is maneuvering toward the approach route.
virtual bool	createApproachRoutePoints ()
	Sets the point for the approach route and assigns them to the current controlPoint.
virtual void	setLandingAppearanceState ()
	Sets the state when the plane is the appropriate distance from the end of the approach route.
virtual double	decelerationDistance () const
	Returns the distance required to slow from the current speed to the approach speed.
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type.

Static Protected Member Functions
static void	taskCompleteReportCallback (DtSimMessage *msg, void *usr)
	Monitor taskReportComplete callback to see when our flyTo task is complete during so we can fly to the landing strip.
static void	landingStripChanged (DtVrfObject *obj, void *userData)
	Called when points on the landing strip have changed.
static void	landingTaskCallback (DtSimMessage *msg, void *usr)
static void	deleteVrfObjectCallback (DtVrfObject *msg, void *usr)
	If an object is deleted and it is the object we are trying to land on, then stop the current land task.

Protected Attributes
DtVrfObject *	myControlPoint
	If this entity islanding, the path the entity is moving on to approach the landing strip.
DtVrfFixedWingLandingPSR *	myProcessState
	Container for state data associated with this component.
DtFixedWingLandingDescriptor *	myFixedWingLandingDescriptor
DtFixedWingEntityStateRepository *	myFixedWingEntityState
DtFixedWingFlightPSR *	myFixedWingFlightPSR
bool	myWaiting
bool	myLandingStripChanged
Ports and Port Groups
DtBooleanOutputPort *	myLandingGearControlPort
	Output Port Name: landing-gear-control Output Port Description: Desired position of the landing gear.

Private Member Functions
	DtFixedWingLandingController ()
	default constructor; not implemented
	DtFixedWingLandingController (const DtFixedWingLandingController &orig)
	copy constructor; not implemented
const DtFixedWingLandingController &	operator= (const DtFixedWingLandingController &orig)
	assignment operator; not implemented

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
Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks.
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtFixedWingLandingController is a controller that models landing for fixed-wing entities.

End User Description: It create the routes and tasks necessary to move a fixed wing aircraft into position to land on a landing strip specified in a landing task.

Uses Descriptor Type: DtFixedWingLandingDescriptor

DtFixedWingLandingController model description

Constructor & Destructor Documentation

DtFixedWingLandingController::DtFixedWingLandingController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtFixedWingLandingController::~DtFixedWingLandingController ( )

virtual

destructor

DtFixedWingLandingController::DtFixedWingLandingController ( )

private

default constructor; not implemented

DtFixedWingLandingController::DtFixedWingLandingController ( const DtFixedWingLandingController &  orig )

private

copy constructor; not implemented

Member Function Documentation

virtual bool DtFixedWingLandingController::init ( )

virtual

Initializes any state that is needed.

Reimplemented from DtControllerComponent.

virtual bool DtFixedWingLandingController::postAddComponentsInit ( )

virtual

Called after all components have been created, initialized and added to the component manager.

Override this function if you need to do any further initialization after all other components have been created.

Reimplemented from DtSimComponent.

virtual DtString DtFixedWingLandingController::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns

DtFixedWingLandingControllerType

Implements DtTaskControllerComponent.

virtual bool DtFixedWingLandingController::tickWhileDestroyed ( ) const

virtual

Overridden so that controller can delete any control point it created when the entity is destroyed.

Reimplemented from DtSimComponent.

static DtSimComponent* DtFixedWingLandingController::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

virtual void DtFixedWingLandingController::registerTaskMsgCallbacks ( )

protectedvirtual

Override for interest of landing tasks.

Reimplemented from DtTaskControllerComponent.

virtual void DtFixedWingLandingController::preFirstTickInit ( )

protectedvirtual

Calls setupExistingConditions.

Reimplemented from DtSimComponent.

virtual void DtFixedWingLandingController::tick ( )

protectedvirtual

Ticks and performs current state.

Reimplemented from DtSimComponent.

virtual void DtFixedWingLandingController::clearCurrentTaskMessage ( )

protectedvirtual

Resets state flag to DtIdle.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtFixedWingLandingController::clearTask ( )

protectedvirtual

Override to clear out any subtasks we might have.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtFixedWingLandingController::removeControlPoint ( )

protectedvirtual

Removes any control points created by this task.

virtual bool DtFixedWingLandingController::createPSR ( )

protectedvirtual

Tasks.

Creates myProcessState data member, and adds it to our process state repository manager. Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

DtFixedWingFlightPSR* DtFixedWingLandingController::lookupFixedWingFlightPSR ( )

protected

Looks up the fixed wing flight PSR in the PSR manager, and returns it.

virtual bool DtFixedWingLandingController::createPorts ( )

protectedvirtual

Creates the landing gear control port.

Reimplemented from DtSimComponent.

static void DtFixedWingLandingController::taskCompleteReportCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

Monitor taskReportComplete callback to see when our flyTo task is complete during so we can fly to the landing strip.

virtual void DtFixedWingLandingController::processTaskComplete ( DtSimMessage *  msg )

protectedvirtual

static void DtFixedWingLandingController::landingStripChanged ( DtVrfObject *  obj, void *  userData  )

staticprotected

Called when points on the landing strip have changed.

Will signal to redo the last point on the landing route

virtual void DtFixedWingLandingController::processLandingStripChanged ( DtVrfObject *  )

protectedvirtual

virtual void DtFixedWingLandingController::processLandingTask ( DtSimMessage *  msg )

protectedvirtual

Starts the processing of the landing task.

This will create the route used to approach the landing strip and then issue a move along for that route. Once that move along is complete, the move along to the landing strip will then be issued

static void DtFixedWingLandingController::landingTaskCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

static void DtFixedWingLandingController::deleteVrfObjectCallback ( DtVrfObject *  msg, void *  usr  )

staticprotected

If an object is deleted and it is the object we are trying to land on, then stop the current land task.

virtual void DtFixedWingLandingController::processDeleteVrfObjectCallback ( DtVrfObject *  obj )

protectedvirtual

virtual bool DtFixedWingLandingController::generateApproachRoute ( )

protectedvirtual

Creates the approach point to start the landing process (the point from which the fixed wing will move to the landing vector).

Once the route is generated, the plane will be given the task to move along that route and the state will be changed to DtLandingStateWaitingToSetApproachSpeed. Once the plane has started on the route, it's ordered speed will be changed to be that of the initial approach speed

virtual bool DtFixedWingLandingController::generateLandingRoute ( )

protectedvirtual

Creates a route for the final landing phase.

It will be just above the approach end of the specified runway, and then descend onto the runway surface.

virtual void DtFixedWingLandingController::setState ( DtVrfFixedWingLandingPSR::DtLandingControllerState  )

protectedvirtual

Sets state in PSR and returns state from PSR.

virtual DtVrfFixedWingLandingPSR::DtLandingControllerState DtFixedWingLandingController::state ( ) const

protectedvirtual

virtual void DtFixedWingLandingController::initRunwayCoordTransform ( const DtVector &  runwayStartLocal, const DtVector &  runwayEndLocal, DtCoordTransform &  resultTransform  ) const

protectedvirtual

virtual double DtFixedWingLandingController::calculateDecelerationConstant ( ) const

protectedvirtual

Calculates the acceleration (average) needed to get from point A to point B, given a starting speed of the current ordered speed and ending speed of landing speed.

virtual double DtFixedWingLandingController::calculateApproachSpeed ( ) const

protectedvirtual

Calculates the speed needed to have at start of approach route.

virtual void DtFixedWingLandingController::setupExistingConditions ( )

protectedvirtual

Sets up any initial conditions on the first tick.

virtual void DtFixedWingLandingController::setApproachSpeed ( )

protectedvirtual

Sends a setSpeed message to the entity with the appropriate approach speed.

Sets the approachSpeedSet() value to true in the PSR.

virtual void DtFixedWingLandingController::flyingAlongApproachRoute ( )

protectedvirtual

Called while the entity is flying along the approach route.

Currently checks to see if the last point needs to be changed due to distance tolerance

virtual void DtFixedWingLandingController::moveAlongLandingStrip ( )

protectedvirtual

Called when the pre-approach task is complete and the plane will now be tasked to move along the landing strip.

The state will then be set to DtLandingStateMovingAlongLandingStrip

virtual void DtFixedWingLandingController::movingAlongLandingStrip ( )

protectedvirtual

Currently no-ops.

virtual bool DtFixedWingLandingController::moveAlongLandingRouteRemainder ( )

protectedvirtual

If the landing route has more than two vertices, issue a move-along task (with start-at-closest-vertex set to true) to move the plane along the remainder of the route.

Sets the state to DtLandingStateMovingAlongLandingRouteRemainder in this case.

Returns

True if issues the move task, or false if there are no more vertices.

virtual bool DtFixedWingLandingController::checkPositionOnFinalLeg ( )

protectedvirtual

Checks if the entity is positioned for the final approach leg.

Returns

True if the plane is within the prescribed angle of the straight in leg to the runway.

virtual void DtFixedWingLandingController::flyingTowardsApproachRoute ( )

protectedvirtual

Called until while the entity is maneuvering toward the approach route.

This state is finished when the entity is moving along the approach route and is checkPositionOnFinalLeg() returns true.

virtual bool DtFixedWingLandingController::createApproachRoutePoints ( )

protectedvirtual

Sets the point for the approach route and assigns them to the current controlPoint.

virtual void DtFixedWingLandingController::setLandingAppearanceState ( )

protectedvirtual

Sets the state when the plane is the appropriate distance from the end of the approach route.

Called each time from waitingToSetApproachSpeed() and flyingAlongApproachRoute() until light state is on. Will set landing lights on

virtual double DtFixedWingLandingController::decelerationDistance ( ) const

protectedvirtual

Returns the distance required to slow from the current speed to the approach speed.

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

private

assignment operator; not implemented

Member Data Documentation

DtVrfObject* DtFixedWingLandingController::myControlPoint

protected

If this entity islanding, the path the entity is moving on to approach the landing strip.

DtVrfFixedWingLandingPSR* DtFixedWingLandingController::myProcessState

protected

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).

DtFixedWingLandingDescriptor* DtFixedWingLandingController::myFixedWingLandingDescriptor

protected

DtFixedWingEntityStateRepository* DtFixedWingLandingController::myFixedWingEntityState

protected

DtFixedWingFlightPSR* DtFixedWingLandingController::myFixedWingFlightPSR

protected

bool DtFixedWingLandingController::myWaiting

protected

bool DtFixedWingLandingController::myLandingStripChanged

protected

DtBooleanOutputPort* DtFixedWingLandingController::myLandingGearControlPort

protected

Output Port Name: landing-gear-control
Output Port Description: Desired position of the landing gear.

True for down, False for retracted.
Output Port Range: True/False

---

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

• include/vrfmodel/fixWngLandingController.h