DtFixedWingEmbarkationController is a controller used to model embarkation behavior for fixed-wing entities. More...

Inheritance diagram for DtFixedWingEmbarkationController:

Public Member Functions
	DtFixedWingEmbarkationController (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtFixedWingEmbarkationController ()
	destructor More...

virtual const char *	type () const
	Returns a string identifies the class type of component. More...

virtual void	atEmbarkationPoint ()
	If the descriptor says to stop at embarkation point, then this issues a DtStopMovingTask and sets the PSR state to DtWaitingToStop. More...

Public Member Functions inherited from DtEmbarkationController
	DtEmbarkationController (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtEmbarkationController ()
	destructor More...

Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSingleTaskControllerComponent ()
	destructor More...

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)). More...

virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task. More...

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. More...

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. More...

virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself. More...

virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()). More...

virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks. More...

virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks. More...

virtual bool	isSubtasked () const
	Returns true if this controller is currently subtasked. More...

virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component. More...

virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks. More...

virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller. More...

virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity. More...

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. More...

virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true. More...

virtual bool	taskActive (int taskId) const

virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared. More...

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type. More...

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller. More...

virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller. More...

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId)

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)

virtual	~DtTaskControllerComponent ()
	destructor More...

virtual bool	showCurrentTaskInGui () const

virtual void	setRadio (DtSimRadio *radio)
	Calls registerTaskMsgCallbacks. More...

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type. More...

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback. More...

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback(). More...

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback. More...

virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message. More...

virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component. More...

virtual void	setTasked (bool tasked)
	The current tasked state of this controller. More...

virtual bool	tasked () const

Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent ()
	destructor More...

virtual DtSimRadio *	radio ()
	The radio this component is listening to. More...

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent ()
	destructor More...

virtual void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component. More...

DtComponentSystem *	parentSystem () const

virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager. More...

virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values. More...

virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived. More...

virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as More...

virtual double	minTickPeriod () const
	access the minimum tick period More...

virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time More...

virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period More...

virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally. More...

virtual double	nextTickTime () const
	access the next tick time More...

virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...

virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at. More...

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. More...

virtual DtSimComponent *	nextComponent ()
	List management functions. More...

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)
	Used by DtComponentList. More...

virtual DtListItem *	listItem ()

virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class. More...

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored. More...

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. More...

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. More...

virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component. More...

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. More...

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. More...

virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component. More...

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. More...

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. More...

virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component. More...

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. More...

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. More...

virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component. More...

virtual int	priority () const
	Return the current connection priority for this component. More...

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. More...

double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...

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. More...

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. More...

virtual const DtComponentDescriptor *	componentDescriptor () const

virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity. More...

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in. More...

const DtPhysicalWorld *	physicalWorld () const

DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any. More...

const DtAttachedTerrain *	terrainAttachedTo () const

DtVrfObject *	entity ()
	Gets the entity. More...

const DtVrfObject *	entity () const

const DtVrfObject *	const_entity () const
	You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...

DtSimManager *	simManager ()
	Gets the sim manager. More...

const DtSimManager *	simManager () const

const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...

DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository. More...

const DtVrfObjectStateRepository *	localStateRepository () const

const DtVrfObjectStateRepository *	const_localStateRepository () const
	You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...

virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component. More...

virtual bool	taskVisualizationsEnabled () const
	Returns true if task visualizations are enabled for this component. More...

virtual bool	isThreadSafe () const
	Returns true if this component is marked as being thread safe. More...

virtual void	addVRLinkDeferredJob (const boost::function< void()> &callback)
	Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe. More...

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 DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

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

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file. More...

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

virtual void	writeSelf (std::string &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. More...

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)
	Set read-only flag. More...

bool	isReadonly () const

virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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. More...

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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. More...

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here. More...

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value. More...

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

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

Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage msg, void usr, DtSimTaskStatePtr taskState)
	Task processor callback function that acts as an adapter for the deprecated forms of addTaskProcessorCallback and removeTaskProcessorCallback (the deprecated form is is version that. More...

Static Public Member Functions inherited from DtSimComponent
static DtSimComponent *	MarkThreadSafe (DtSimComponent *)
	Marks an instance of a component as being thread safe. More...

static DtSimComponentFactory *	factory ()
	A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtVrfObject owner, DtSimManager simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Creates a DtSimComponent using the factory, then initializes it via the MTL stream. More...

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
	Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...

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 ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Static Public Member Functions inherited from DtObjectDebugger< DtSimComponent >
static DtObjectCounter::CounterType	ObjectCount ()

static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
virtual void	embark (const DtVector &loadPosition, const DtUUID &parentName, int appearance, const DtTaitBryan &orientation, const DtVector &acceleration=DtVector(), const DtVector &velocty=DtVector(), bool invisibleWhenEmbarked=false, const DtString &animation=DtString::nullString())
	Overridden to provide bounding volume offset to loadPosition Note, that after calling the parent method, if the entity is on the ground, set the current speed to 0. More...

virtual void	issueMoveAlongToIngressTask ()
	Override to issue landing task to plane. More...

virtual void	issueMoveAlongToEgressTask ()
	Override to issue takeoff task to plane. More...

virtual void	processTaskComplete (DtSimMessage *msg)
	Override to capture landing task being complete. More...

virtual void	movingToEgress ()
	If the entitiy is no longer onGround (if it was on ground), then disembark from parent. More...

virtual void	movingToIngress ()
	When fixed wing is on ground, it is considered embarked. More...

virtual bool	init ()
	Initializes any state that is needed. More...

virtual void	setLocation (const DtVector &world)
	Sends setLocation request to this entity for the specified world location. More...

Protected Member Functions inherited from DtEmbarkationController
virtual bool	createPorts ()
	Overridden to create the local ports. More...

virtual void	registerTaskMsgCallbacks ()
	Override for interest in both embarkation tasks and sets. More...

virtual void	unregisterTaskMsgCallbacks ()
	Override for uninterest in both embarkation tasks and sets. More...

virtual void	preFirstTickInit ()
	Calls setupExistingConditions() More...

virtual void	tick ()
	Ticks and performs current state. More...

virtual void	clearCurrentTaskMessage ()
	Resets state flag to DtIdle. More...

virtual void	suspendTask ()
	Overridden from parent to sent a giveUpSlot message to the object it was embarking on. More...

virtual void	clearTask ()
	Override to clear out any subtasks we might have. More...

virtual void	processDisembarkTask (DtSimMessage *msg)
	Tasks. More...

virtual void	checkAndSetEgressPosture ()
	If this is a human, set the posture to standing if in sitting posture when moving to egress. More...

virtual void	processEmbarkTask (DtSimMessage *msg)
	Sets state to be DtMoveToIngress. More...

virtual void	processEmbarkObjectCallback (DtSimMessage *msg)

virtual void	processDisembarkObjectCallback (DtSimMessage *msg)

virtual void	processEmbarkationInformationCallback (DtSimMessage *msg)

virtual void	processLoadEntity (DtSimMessage *msg)
	Sets. More...

virtual void	processUnloadEntity (DtSimMessage *msg)

virtual void	unload (const DtVector &point, int appearance=0xFFFFFFFF)
	Unloads entity at specified egress point. More...

virtual void	processDeleteVrfObjectCallback (const DtVrfObject *obj)

virtual bool	performTechnique ()
	Perform the given technique. More...

virtual bool	sendTechniqueTask (const DtSimTaskMessageType &task)
	Executes the technique, giving it the following task parameters slotName - Name of the slot the entity wants to go in (if available) slotType - Type of slot the entity wants to go in (if available) slotPosition - Body offset position the entity wants to go in/out accessPoints - body positions of ingress/egress from slot animation - Animation to perform embarkedOrientation - Orientation at which to embark at embarkedAppearance - Appearance at which to embark slotNumber - The slot number the entity wants to go in (if available) embarkOn - Who to embark on. More...

virtual void	performingEmbarkTechnique ()
	Called during the time the entity is performin a technique as part of embark. More...

virtual void	performingDisembarkTechnique ()
	Called during the time the entity is performin a technique as part of disembark. More...

virtual void	moveToEgress ()
	Moves the item to the egress point to prepare for disembarking. More...

virtual void	disembark ()
	Disembarks item by calling unload() and then resets state to idle. More...

virtual void	sendTask (const DtSimTask &task, const DtUUID &to)
	Sends task to specified receiver. More...

virtual void	removeControlPoint ()
	Removes the control point from object manager (if exists) More...

virtual void	moveToIngress (const DtUUID &parent)
	Starts a moveTo tasks, given the myIngressPoint (that is created as part of this method) as the target. More...

virtual void	createControlPoint (const DtVector &location, const DtUUID &parent)

virtual void	createRoute (const std::vector< DtVector > &, const DtUUID &parent)

virtual void	moveToEmbarkationPoint ()
	Sets state to DtMovingToEmbarkationPoint and starts task to move to embarkation point. More...

virtual void	waitingToStop ()
	Called while the entity is waiting to come to a complete stop. More...

virtual void	embarkObject (bool overridePosition, const DtVector &loadPosition, int slotNumber, const DtUUID &parent, const DtString &slotName="", const DtString &slotType="", int appearance=0xFFFFFFFF, const DtTaitBryan &orientation=DtTaitBryan(), const DtVector &acceleration=DtVector(), const DtVector &velocty=DtVector(), bool invisibleWhenEmbarked=false, const DtString &animation=DtString::nullString())
	Called as part of processLoad() message. More...

virtual void	unloadObject (const DtVector &unloadPoint, int appearance=0xFFFFFFFF)
	Called as part of processUnload Unloads entity at specified egress point. More...

virtual void	movingToEmbarkationPoint ()
	Called when moving to embarkation point. More...

virtual void	stoppedAtEmbarkedPoint ()
	Last step – embark on object. More...

virtual void	setState (DtVrfEmbarkationPSR::DtEmbarkationControllerState)
	Sets state in PSR and returns state from PSR. More...

virtual DtVrfEmbarkationPSR::DtEmbarkationControllerState	state () const

virtual bool	isEmbarkationState (DtVrfEmbarkationPSR::DtEmbarkationControllerState) const

virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager. More...

virtual void	setupExistingConditions ()
	Called only during first tick, sets up any internal variables that are needed. More...

virtual void	completeEmbarkationInformationRequest (const DtIfEmbarkationInformation *)
	Called when embarkation information has been received and we have been cleared to embark. More...

virtual void	embarkationRefused (const DtIfEmbarkationInformation *)
	Called when embarkation information has been received and we have been declined an embarkation slot. More...

virtual void	completeDisembarkationInformationRequest (const DtIfEmbarkationInformation *)
	Called when disembarkation information has been received and we have been cleared to disembark. More...

virtual void	disembarkationRefused (const DtIfEmbarkationInformation *)
	Called when disembarkation information has been received and we have been declined the request to disembark. More...

virtual DtTaitBryan	embarkedOrientation (const DtTaitBryan &, const DtUUID &parent) const
	Takes the orientation from embarkation information and transforms it to an embarkable orientation. More...

virtual void	moveToIngressPoint (const DtIfEmbarkationInformation *info)
	Creates a control point and give a DtMoveTo subtask to move to the ingress point. More...

virtual void	moveAlongToIngressPoint (const DtIfEmbarkationInformation *info)
	Creates a route and give a DtMoveAlong subtask to move along the route. More...

virtual void	moveToEgressPoint (const DtIfEmbarkationInformation *info)
	Creates a control point and give a DtMoveTo subtask to move to the egress point. More...

virtual void	moveAlongToEgressPoint (const DtIfEmbarkationInformation *info)
	Creates a route and give a DtMoveAlong subtask to move along the route to the egress point. More...

virtual void	issueMoveToEgressTask ()
	Override to issue a task that is different than the DtMoveTo for a single control point. More...

virtual void	issueMoveToIngressTask ()

virtual void	issueMoveToEmbarkationPointTask ()
	Override to issue a task that is different than the default DtMoveTo task. More...

virtual DtVector	currentBodyPosition (const DtUUID &parent) const
	Current body position and orientation on embarked parent. More...

virtual DtTaitBryan	currentBodyOrientation (const DtUUID &parent) const

virtual DtVector	currentBodyVelocity (const DtUUID &parent) const

virtual DtVector	currentBodyAcceleration (const DtUUID &parent) const

virtual bool	requestEmbarkationInformationFrom (const DtUUID &parent, bool start=false, int embarkInSlot=-1, const DtString &slotName="", const DtString &slotType="", bool anyIfTaken=true)
	Sends a request to find out ingress and embarkation location of the host entity. More...

virtual bool	requestDisembarkationInformationFrom (const DtUUID &parent, bool start=false)

virtual void	requestGiveUpSlot (const DtUUID &parent)
	Sends a request to give up a slot that might be reserved in our name. More...

virtual void	waitingForEmbarkationInformation ()

virtual void	waitingForDisembarkationInformation ()

virtual void	placeObject (bool clamp=false)
	Places object on terrain after embarkation to refresh support points. More...

virtual void	calculateAndSetHeading (const DtVector &start, const DtVector &end)
	Calculates the heading needed to disbark given the current state. More...

virtual void	sendSetRequest (DtSetDataRequest &request)
	Sends set request. More...

virtual void	processDisembarkationState (const DtVector &bodyExitPosition)

virtual void	movingToFinalDestination ()

virtual void	moveToFinalDestination ()

virtual void	preprocessEmbarkTask ()
	Currently noops, but, give an opportunity to do any preprocessing before embark or disembark task starts. More...

virtual void	preprocessDisembarkTask ()

virtual bool	checkEmbarkOk (const DtUUID &parent) const
	Returns false if entity is to embark on another entity that is not embarked on the same entity as this one (or, if they are not both disembarked) More...

virtual void	updateDisembarkedAppearanceAndAnimation (int appearance)
	Updates the appearance and animation of a disembarked object (from its current appearance). More...

virtual void	updateEmbarkedAppearanceAndAnimation (int, const DtString &)
	Updates the appearance and animation of an embarked entity. More...

virtual void	updateLifeformEmbarkedAppearanceAndAnimation (int, const DtString &)

virtual void	attachToEmbarkedParent (const DtUUID &newParent)
	Only called when disembarkation causes the entity to be embarked on a new parent (i.e. More...

virtual DtVector	fallbackOffloadPoint ()
	If an entity tries to be disembarked, but, it never hears back as to where it can disembark, this is the spot that it will be disembarked to. More...

virtual void	enable ()
	Override to add set data request and message callbacks. More...

virtual void	disable ()
	Override to remove set data request and message callbacks. More...

virtual DtIfEmbarkationInformation	createEmbarkationInformationFromProcessState () const
	Recreates the embarkation information content message from the process state information. More...

virtual bool	parentOnGround ()
	Returns true unless the parent is a FW or RW and is in the air. More...

virtual void	processSetHeading ()

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. More...

virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type. More...

virtual void	cleanupInactiveSubtaskStatus ()
	Clears out subtask status entries that are either completed or canceled which were started by this controller. More...

Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo. More...

virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends a single running subtasks of taskId, and puts the suspend info into the provided suspendInfo. More...

virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const
	In case this is aliased, return the actual script id. More...

Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor More...

	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor More...

const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator More...

virtual void	onRestore ()
	Override to iterate over the descriptor to see if there are any targetting control tables. More...

virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)

Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT. More...

bool	testInvariant () const

virtual bool	createPortGroups ()
	Called by init. More...

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager. More...

virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick. More...

virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component. More...

virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization. More...

virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name. More...

virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name. More...

virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name. More...

virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name. More...

double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked. More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()

	DtObjectDebugger (const DtObjectDebugger &)

	~DtObjectDebugger ()

Protected Attributes
DtFixedWingEntityStateRepository *	myFixedWingEntityState

Protected Attributes inherited from DtEmbarkationController
std::list< DtString >	myEmbarkedObjects

const DtVrfObject *	myControlPoint
	If this entity is embarking to an ingress point (or moving to the embarkation point), this object will be the point they are aiming for. More...

DtVrfEmbarkationPSR *	myProcessState
	Container for state data associated with this component. More...

bool	myWaiting
	If myWaiting is true, the controller is waiting for some condition to be met, so, the controller will not start working until the conditions are met. More...

DtEmbarkationDescriptor *	myEmbarkationDescriptor

double	myRequestTime

int	myRequestRetries

bool	myAreCallbacksRegistered

bool	myUseLoadOverrideIfNoSlotAvailable
	Will be set if the embarkation request is to use an override position if no slots are available. More...

DtVector	myLoadOverridePosition

DtUUID	myParentToLoadOn

bool	myResetGroundClampOnDisembark

bool	myResetGroundClampOnDisembarkValue

bool	myRemoveSetHeadingNotifyCallback

bool	myClampOnReceiveEmbarkationInformation

DtStringOutputPort *	myOrderedAnimationPort
	Output Port Name: ordered-animation Output Port Description: Specifies an animation to be used as long as the entity is not currently tasked to perform another animation. More...

Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap

std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList
	This list stores any DtTaskProcessorCallbackInfo allocated locally so that they can be deleted when the component is deleted. More...

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
	Controller components can send messages. More...

Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity

DtVrfObjectStateRepository *	myLocalStateRepository

DtSimManager *	mySimManager

DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs. More...

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myMinTickPeriod

double	myMinTickPeriodVariance

double	myNextTickTime

double	myLastTickSimTime

double	myDT

bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not. More...

bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick. More...

bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...

bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...

DtTaskVisualizationMap	myTaskVisualizations
	The visualization objects to be drawn for this component. More...

double	myNextTaskVisTickTime
	The next tick time for updating the task visualizations. More...

DtSymbolString	myFullComponentName

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Private Member Functions
	DtFixedWingEmbarkationController ()
	default constructor; not implemented More...

	DtFixedWingEmbarkationController (const DtFixedWingEmbarkationController &orig)
	copy constructor; not implemented More...

const DtFixedWingEmbarkationController &	operator= (const DtFixedWingEmbarkationController &orig)
	assignment operator; not implemented More...

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
	This map stores callbacks that have been registered to processes various tasks. More...

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

Static Protected Member Functions inherited from DtEmbarkationController
static void	disembarkTaskCallback (DtSimMessage msg, void usr)

static void	embarkTaskCallback (DtSimMessage msg, void usr)

static void	embarkObjectCallback (DtSimMessage msg, void usr)
	Processes DtIfEmbark and disembark messages. More...

static void	disembarkObjectCallback (DtSimMessage msg, void usr)

static void	embarkationInformationCallback (DtSimMessage msg, void usr)
	Called when embarkation information is received over the network. More...

static void	setLoadEntityCallback (DtSimMessage msg, void usrData)

static void	setUnloadEntityCallback (DtSimMessage msg, void usrData)

static void	deleteVrfObjectCallback (const DtVrfObject msg, void usr)
	If an object is deleted and it is the object we are trying to embark on, then stop the current embark task. More...

static void	taskCompleteReportCallback (DtSimMessage msg, void usr)
	Monitor taskReportComplete callback to see when our moveTo task is complete during embarkation so we can then set state to DtMoveToEmbarkPoint. More...

static void	setHeadingCallback (DtSimMessage , void usr)
	Used to set amClampedToGround back to original setting after disembarking from an aircraft in the air. More...

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

Detailed Description

DtFixedWingEmbarkationController is a controller used to model embarkation behavior for fixed-wing entities.

Developer Description: Overrides the DtEmbarkationController to not expect to send DtStopMovingTask, but, rather embark immediately after moved to emberkation point. Also invoke DtTaskLand to allow fixed wing to land on ingress route (if route) or DtTaskTakeOff if egress is a route.

Uses Descriptor Type: DtEmbarkationDescriptor

Constructor & Destructor Documentation

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

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).

virtual DtFixedWingEmbarkationController::~DtFixedWingEmbarkationController ( )

virtual

destructor

DtFixedWingEmbarkationController::DtFixedWingEmbarkationController ( )

private

default constructor; not implemented

DtFixedWingEmbarkationController::DtFixedWingEmbarkationController ( const DtFixedWingEmbarkationController & orig )

private

copy constructor; not implemented

Member Function Documentation

virtual const char* DtFixedWingEmbarkationController::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: DtFixedWingEmbarkationControllerType

Reimplemented from DtEmbarkationController.

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

static

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).

Returns: New instance of this class.

virtual void DtFixedWingEmbarkationController::atEmbarkationPoint ( )

virtual

If the descriptor says to stop at embarkation point, then this issues a DtStopMovingTask and sets the PSR state to DtWaitingToStop.

Otherwise, it calls stoppedAtEmbarkedPoint() which uses embark() to attach to parent, and finishes the task.

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::embark	(	const DtVector &	loadPosition,
		const DtUUID &	parentName,
		int	appearance,
		const DtTaitBryan &	orientation,
		const DtVector &	acceleration = `DtVector()`,
		const DtVector &	velocty = `DtVector()`,
		bool	invisibleWhenEmbarked = `false`,
		const DtString &	animation = `DtString::nullString()`
	)

protectedvirtual

Overridden to provide bounding volume offset to loadPosition Note, that after calling the parent method, if the entity is on the ground, set the current speed to 0.

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::issueMoveAlongToIngressTask ( )

protectedvirtual

Override to issue landing task to plane.

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::issueMoveAlongToEgressTask ( )

protectedvirtual

Override to issue takeoff task to plane.

Reimplemented from DtEmbarkationController.

virtual void DtFixedWingEmbarkationController::processTaskComplete ( DtSimMessage * msg )

protectedvirtual

Override to capture landing task being complete.