DtFixedWingPatrolRouteController is a controller that models movement along a route for fixed-wing entities.

End User Description: The route is followed until complete, then in reverse, then forward, etc., until the entity is retasked.

Uses Descriptor Type: DtFixedWingPilotControllerDescriptor

Inheritance diagram for DtFixedWingPatrolRouteController:

[legend]

Public Member Functions
	DtFixedWingPatrolRouteController (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtFixedWingPatrolRouteController ()

virtual const char *	type () const

virtual void	doLanding ()

virtual void	doFinishingForFlying ()

virtual void	doFinishingForTaxiing ()

virtual void	registerTaskMsgCallbacks ()

virtual DtSimTaskStatePtr	currentTaskState () const

Public Member Functions inherited from DtFixedWingMoveAlongController
	DtFixedWingMoveAlongController (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtFixedWingMoveAlongController ()

virtual bool	init ()

virtual void	preFirstTickInit ()

virtual void	tick ()

virtual void	doFinishing ()

virtual void	doMoving ()

virtual void	doFlying ()

virtual void	doTaxiing ()

virtual void	doTakeOff ()

virtual double	findDesiredSpeed ()

virtual bool	nearGoal ()

virtual bool	atGoal ()

virtual bool	passedGoal ()

virtual bool	processFlyAlongTask (DtSimTask *msg, DtSimTaskStatePtr taskStatePtr)

virtual bool	processMoveAlongTask (DtSimTask *msg, DtSimTaskStatePtr taskStatePtr)

virtual void	processRouteChanged ()

virtual void	processSetAltitude (DtSimMessage *msg)

virtual void	processSetOrderedAltitude (DtSimMessage *msg)

virtual void	processSetLocation (DtSimMessage *msg)

virtual void	processSetRestore (DtSimMessage *msg)

virtual void	processModifyVrfObject (DtSimMessage *msg)

virtual bool	setupRoute ()

virtual DtFixedWingFlightPSR *	getPSR ()

Public Member Functions inherited from DtFixedWingPilotController
	DtFixedWingPilotController (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtFixedWingPilotController ()

virtual double	maxTurningGs () const

virtual bool	terrainAvoidanceEnabled ()

virtual double	terrainAvoidanceLookaheadTime ()

virtual void	registerAttributeFunctions ()

virtual void	taxiTo (const DtVector &destination, double speed)

virtual void	taxi (double speed, double turnRate)

virtual double	calculateSteering (double turnAngle) const

virtual double	approximateThrottle (double speed)

virtual double	calculateCurrentBrakingDistance () const

virtual void	flyTo (const DtVector &destination, double speed, double maxTerrainAvoidanceLookaheadDist=-1)

virtual void	flyToDirect (const DtVector &destination, double speed, double maxTerrainAvoidanceLookaheadDist=-1)

virtual void	fly (double speed, double turnRate, double climbRate, double maxTerrainAvoidanceLookaheadDist=-1)

virtual void	flyFixedPitch (double speed, double turnRate, double desiredPitch, double maxTerrainAvoidanceLookaheadDist=-1)

virtual double	terrainAvoidancePitch (double speed, double desiredPitch, double maxTerrainAvoidanceLookaheadDist)

virtual bool	clearPathTo (const DtVector &localPosition, bool &dataAvailable)

virtual void	circle (const DtVector &center, double radius, double speed, double altitude, bool clockwise=true)

virtual double	calcControlForRoll (double rollRate)

virtual double	calcControlForThrottle (double speed, bool &deployFlaps)

virtual double	decelerationLimitedClimbRate (double altitudeError, double desiredSpeed, double finalClimbRate=0.0)

virtual void	calcControlForTurnAndClimb (double turnRate, double climbRate, double &stickX, double &pedal)

virtual void	calcControlForTurnAndPitch (double turnRate, double desiredPitch, double &stickX, double &pedal, double rollRate=0.0)

virtual double	calculateClimbRate (double altitude, double climbTime) const

virtual double	calculateTurnRate (double turnAngle, double additionalTurnRate=0) const

virtual double	calculateRollAngle (double turnRate, double speed) const

virtual double	calculateRollRate (double rollAngle, double turnRate)

virtual void	calculateNormalizedBodyVelocity ()

virtual void	calculateLocalAngularVelocity ()

virtual void	calculateSpeedRatioSquared ()

virtual void	initializeControllerForTick ()

virtual bool	createFixedWingControlPortGroup ()

virtual bool	createThrottlePort ()

virtual bool	createStickPort ()

virtual bool	createPedalPort ()

virtual bool	createBrakePort ()

virtual bool	createFlapsDeployedPort ()

virtual DtConstrainedAnalogOutputPort *	throttlePort ()

virtual DtConstrainedDualAxisAnalogOutputPort *	stickPort ()

virtual DtConstrainedAnalogOutputPort *	pedalPort ()

virtual DtConstrainedAnalogOutputPort *	brakePort ()

virtual DtBooleanOutputPort *	flapsDeployedPort ()

virtual void	setMaxThrustAcceleration (double maxThrustAcceleration)

virtual void	setTakeOffDir (const DtVector &takeOffDir)

virtual const DtVector &	takeOffDir () const

virtual DtReal	maxTurningGsForTask () const

virtual DtReal	maxTurnRateCutoffAngle () const

virtual DtReal	maxTaxiingTurnSpeed () const

virtual DtReal	taxiingNearDistance () const

virtual DtReal	taxiingAtDistance () const

virtual DtReal	taxiingApproachSpeed () const

virtual DtReal	maxPitchAngle () const

virtual DtReal	timeToTargetAltitude () const

Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSingleTaskControllerComponent ()

virtual void	postTick ()

virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)

virtual void	taskNotify (const DtSimTask &task)

virtual void	taskComplete (bool success=true)

virtual void	suspendTask ()

virtual int	sendSubtask (DtSimTask &task)

virtual void	clearSubtask (int subtaskId)

virtual void	addPendingSubtaskId (int subtaskId)

virtual bool	findPendingSubtaskId (int subtaskId)

virtual bool	isSubtasked () const

virtual void	removePendingSubtaskId (int subtaskId)

virtual void	removeAllPendingSubtaskIds ()

virtual std::vector< int >	currentPendingSubstaskIds () const

virtual void	clearCurrentTaskMessage ()

virtual DtTaskMessage *	currentTaskMessage () const

virtual void	giveUpTask ()

virtual bool	taskActive (int taskId) const

virtual bool	clearTopLevelTasks ()

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)

virtual void	clearTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId)

virtual std::list < DtTaskMessage * >	currentTaskMessages () const

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const

virtual void	disable ()

Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtTaskControllerComponent ()

virtual bool	showCurrentTaskInGui () const

virtual void	setRadio (DtSimRadio *radio)

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)

virtual void	enable ()

virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)

virtual bool	taskVisualizationsActive () const

virtual void	setTasked (bool tasked)

virtual bool	tasked () const

Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent ()

virtual DtSimRadio *	radio ()

virtual void	enableTaskTypes ()

virtual void	disableTaskTypes ()

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent ()

virtual void	setParentSystem (DtComponentSystem *system)

DtComponentSystem *	parentSystem () const

virtual void	timedTick ()

virtual void	setMinTickPeriod (double minTickPeriod)

virtual double	minTickPeriod () const

virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)

virtual double	minTickPeriodVariance () const

virtual void	setNextTickTime (double nextTickTime)

virtual double	nextTickTime () const

virtual double	calculateNextTickTime () const

virtual double	calculateFirstTickTime () const

virtual void	setEntity (DtLocalObject *entity)

virtual DtSimComponent *	nextComponent ()

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)

virtual DtListItem *	listItem ()

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

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

virtual void	addInputPort (DtInputPort *port)

virtual void	removeInputPort (DtInputPort *port)

virtual DtInputPort *	lookupInputPort (const DtString &portName)

virtual DtList	inputPortList () const

virtual void	addOutputPort (DtOutputPort *port)

virtual void	removeOutputPort (DtOutputPort *port)

virtual DtOutputPort *	lookupOutputPort (const DtString &portName)

virtual DtList	outputPortList () const

virtual void	addInputPortGroup (DtInputPortGroup *group)

virtual void	removeInputPortGroup (DtInputPortGroup *group)

virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)

virtual DtList	inputPortGroupList () const

virtual void	addOutputPortGroup (DtOutputPortGroup *group)

virtual void	removeOutputPortGroup (DtOutputPortGroup *group)

virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)

virtual DtList	outputPortGroupList () const

virtual int	priority () const

virtual void	setPriority (int priority)

double	dT () const

virtual void	setDT (double deltaT)

virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)

virtual const DtComponentDescriptor *	componentDescriptor () const

virtual bool	tickWhileDestroyed () const

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()

const DtPhysicalWorld *	physicalWorld () const

const DtAttachedTerrain *	terrainAttachedTo () const

DtLocalObject *	entity ()

const DtLocalObject *	entity () const

DtSimulationServices *	simulationServices ()

const DtSimulationServices *	simulationServices () const

const Coordinate_System *	coordinateSystem () const

virtual bool	taskVisualizationsEnabled () const

makVrf::DtTaskVisualizationMap &	taskVisualizations ()

virtual bool	isEnabled ()

virtual void	setIsEnabled (bool yesNo)

virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const

virtual int	notifyLevel () const

virtual DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

VRF4API_METHOD const DtSimulationServices *	simManager () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

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

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

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

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

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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

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

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

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static void	patrolRouteCallback (DtSimMessage msg, void usr, DtSimTaskStatePtr taskStatePtr)

static DtSimComponent *	creator (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

Static Public Member Functions inherited from DtFixedWingMoveAlongController
static void	setAltitudeCallback (DtSimMessage msg, void usrData)

static void	setOrderedAltitudeCallback (DtSimMessage msg, void usrData)

static void	setLocationCallback (DtSimMessage msg, void usrData)

static void	setRestoreCallback (DtSimMessage msg, void usrData)

static void	modifyVrfObjectCallback (DtSimMessage msg, void usr)

static void	moveAlongCallback (DtSimMessage msg, void usr, DtSimTaskStatePtr taskStatePtr)

static DtReaderWriter *	provideNextRoutePointIndex (void *c)

static DtSimComponent *	creator (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

Static Public Member Functions inherited from DtFixedWingPilotController
static DtSimComponent *	creator (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

static DtReaderWriter *	provideMaxThrustAcceleration (void *controller)

Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage msg, void usr, DtSimTaskStatePtr taskState)

Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject owner, DtSimulationServices simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)

static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

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

Protected Member Functions
virtual void	processPatrolRoute (const DtTaskMessage &msg, DtSimTaskStatePtr taskStatePtr)

	DtFixedWingPatrolRouteController ()

	DtFixedWingPatrolRouteController (const DtFixedWingPatrolRouteController &orig)

const DtFixedWingPatrolRouteController &	operator= (const DtFixedWingPatrolRouteController &orig)

Protected Member Functions inherited from DtFixedWingMoveAlongController
virtual void	processMoveAlong (const DtTaskMessage &msg, DtSimTaskStatePtr taskStatePtr)

	DtFixedWingMoveAlongController ()

	DtFixedWingMoveAlongController (const DtFixedWingMoveAlongController &orig)

DtFixedWingMoveAlongController &	operator= (const DtFixedWingMoveAlongController &orig)

void	clearStoredRoute ()

void	updateTakeOffDir ()

void	updateLandingDir ()

void	processEntityLocationChange ()

virtual bool	setMovementStatusFromRoute ()

virtual void	resetValues ()

virtual void	clearTask ()

virtual void	updateTaskVisualizations ()

virtual void	processEstimatedTotCalculation ()

virtual bool	createPorts ()

Protected Member Functions inherited from DtFixedWingPilotController
virtual DtReaderWriter *	processProvideMaxThrustAcceleration ()

virtual bool	createPortGroups ()

virtual void	lookupAndCacheProcessSR ()

virtual bool	postAddComponentsInit ()

virtual bool	decideToGiveUpTask () const

virtual void	updateCurrentState ()

virtual double	calculateCollisionLookAhead (const double climbRate, const double speed, const double desiredAltitude)

virtual double	convertSpeedtoGroundSpeed (double speed, double currentAlt, DtAirSpeedType speedType)

	DtFixedWingPilotController ()

	DtFixedWingPilotController (const DtFixedWingPilotController &orig)

const DtFixedWingPilotController &	operator= (const DtFixedWingPilotController &orig)

Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()

virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)

virtual void	cleanupInactiveSubtaskStatus ()

Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)

virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)

virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const

Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()

	DtControllerComponent (const DtControllerComponent &orig)

const DtControllerComponent &	operator= (const DtControllerComponent &orig)

virtual void	onRestore ()

virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)

virtual void	sendCapableSetsAndTasks ()

Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()

bool	testInvariant () const

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)

virtual void	destroyTaskVisualizations ()

virtual void	destroyTaskVisualization (const DtString &name)

virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)

virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)

virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)

virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)

double	calculateNextTaskVisTickTime () const

DtVrfObjectStateRepository *	localStateRepository ()

const DtVrfObjectStateRepository *	localStateRepository () const

void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)

void	removeSimObjectPredicateCallback (const DtSimObject , DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void userData=0)

void	invokeSimObjectPredicateCallbacks ()

virtual void	clearPredicateCallbacks ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair

typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap

Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap

typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap

typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap

typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap

Protected Attributes inherited from DtFixedWingMoveAlongController
DtSimObjectReference	myRoute

bool	myRouteHasChanged

bool	myWarnedForMovementStatus

DtVectorOutputPort *	myCurrentVertexLocationOutputPort

bool	myChangedLocation = false

Protected Attributes inherited from DtFixedWingPilotController
DtFixedWingEntityStateRepository *	myFixedWingEntityState

DtFixedWingFlightPSR *	myProcessState

DtAirspeedCalculator *	myAirSpeedCalculator

const double	DtEstimatedTotCalcInterval = 5.0

bool	myEstimatedTotCalcEnabled

double	myEstimatedTotValue

double	myEstimatedTotLastCalcTime

DtVector	myEstimatedTotTextPos

DtPlatformLocalObjectFacade	myPlatformLocalObjectFacade

DtOutputPortGroup *	myFixedWingControlPortGroup

DtConstrainedAnalogOutputPort *	myThrottlePort

DtConstrainedDualAxisAnalogOutputPort *	myStickPort

DtConstrainedAnalogOutputPort *	myPedalPort

DtConstrainedAnalogOutputPort *	myBrakePort

DtBooleanOutputPort *	myFlapsDeployedPort

DtVector	myCurrentLocalPosition

DtVector	myCurrentLocalVelocity

double	myCurrentSpeed

DtDcm	myCurrentOrientationMatrix

double	myCurrentHeading

double	myCurrentTopoPitch

double	myCurrentTopoRoll

DtDcm	myLocalToTopoDcm

Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap

std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList

bool	myTaskIsRunning

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio

bool	myTaskTypesEnabled

bool	myInitialized

Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity

DtComponentSystem *	mySystem

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myMinTickPeriod

double	myMinTickPeriodVariance

double	myNextTickTime

double	myLastTickSimTime

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

bool	myTickEveryFrame

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager	myPredicateCallbackManager

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtFixedWingPatrolRouteController::DtFixedWingPatrolRouteController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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).

virtual DtFixedWingPatrolRouteController::~DtFixedWingPatrolRouteController ( )

virtual

destructor

DtFixedWingPatrolRouteController::DtFixedWingPatrolRouteController ( )

protected

Default constructor; should not be called. Here because the compiler will generate an unprotected one otherwise.

DtFixedWingPatrolRouteController::DtFixedWingPatrolRouteController ( const DtFixedWingPatrolRouteController & orig )

protected

copy constructor; shallow; does not copy the ports.

Member Function Documentation

virtual const char* DtFixedWingPatrolRouteController::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. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns: DtFixedWingPatrolRouteControllerType

Reimplemented from DtFixedWingMoveAlongController.

virtual void DtFixedWingPatrolRouteController::doLanding ( )

virtual

Override this function to ensure that the entity taxiis to/back the touchdown point if it was the last point in the route in order to keep patrolling.

Reimplemented from DtFixedWingMoveAlongController.

virtual void DtFixedWingPatrolRouteController::doFinishingForFlying ( )

virtual

Checks to see if the entity is within two seconds of being at the waypoint, or if the entity�s distance from the waypoint is greater than it was the previous frame (by comparing myProcessState->distanceSquared() to myProcessState->lastDistanceSquared()). If so, all port values are set to 0.0, myFinishing is set to false, and taskComplete() is called. Otherwise, flyTo() is called, and myProcessState->lastDistanceSquared() is set to myDistanceSquared.

Reimplemented from DtFixedWingMoveAlongController.

virtual void DtFixedWingPatrolRouteController::doFinishingForTaxiing ( )

virtual

Only called if the entity is near its goal. Checks to see if the entity is at the goal or passed it. If so, then it stops. Otherwise, it continues to taxi, but at its approach speed if it has one.

Reimplemented from DtFixedWingMoveAlongController.

virtual void DtFixedWingPatrolRouteController::registerTaskMsgCallbacks ( )

virtual

Overrides this so it can register its interest in patrolRoute commands.

Reimplemented from DtFixedWingMoveAlongController.

static void DtFixedWingPatrolRouteController::patrolRouteCallback	(	DtSimMessage *	msg,
		void *	usr,
		DtSimTaskStatePtr	taskStatePtr
	)

static

virtual DtSimTaskStatePtr DtFixedWingPatrolRouteController::currentTaskState ( ) const

virtual

Returns: Current execution state of the task. At the base class level, returns 0. Derived classes that have tasks with DtTaskState (data associated with execution of the task) may return a new DtTaskState instance, filled out with the appropriate information about the current task execution state. Task controllers that do not need to return task state do not need to override this function.

Reimplemented from DtFixedWingMoveAlongController.

static DtSimComponent* DtFixedWingPatrolRouteController::creator	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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).

Returns: New instance of this class.

virtual void DtFixedWingPatrolRouteController::processPatrolRoute	(	const DtTaskMessage &	msg,
		DtSimTaskStatePtr	taskStatePtr
	)

protectedvirtual

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

protected

assignment operator; see comments on copy constructor!

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmodel/fixedWingPatrolRouteController.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation