DtEmbarkationController is a controller that supports base level embarkation/disembarkation for entities in the system.

Developer Description: If an entity requires specialized handling of any of the tasks or sets that are used for embarkation functionality, then override this class to handle that.

Uses Descriptor Type: DtEmbarkationDescriptor

DtEmbarkationController model description

Inheritance diagram for DtEmbarkationController:

[legend]

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

virtual	~DtEmbarkationController ()

virtual bool	init ()

virtual const char *	type () 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 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 DtTaskMessage *	currentTaskMessage () const

virtual DtSimTaskStatePtr	currentTaskState () const

virtual bool	decideToGiveUpTask () 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

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	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 bool	postAddComponentsInit ()

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	registerAttributeFunctions ()

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 DtSimComponent *	creator (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

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 bool	createPorts ()

virtual void	registerTaskMsgCallbacks ()

virtual void	unregisterTaskMsgCallbacks ()

virtual void	preFirstTickInit ()

virtual void	tick ()

virtual void	clearCurrentTaskMessage ()

virtual void	suspendTask ()

virtual void	clearTask ()

virtual void	processDisembarkTask (DtSimMessage *msg)

virtual void	checkAndSetEgressPosture ()

virtual void	processEmbarkTask (DtSimMessage *msg)

virtual void	processEmbarkObjectCallback (DtSimMessage *msg)

virtual void	processDisembarkObjectCallback (DtSimMessage *msg)

virtual void	processEmbarkationInformationCallback (DtSimMessage *msg)

virtual void	processLoadEntity (DtSimMessage *msg)

virtual void	processUnloadEntity (DtSimMessage *msg)

virtual void	unload (const DtVector &point, int appearance=0xFFFFFFFF)

virtual void	processDeleteVrfObjectCallback (const DtLocalObject *obj)

virtual void	processTaskComplete (DtSimMessage *msg)

virtual bool	performTechnique ()

virtual bool	sendTechniqueTask (const DtSimTaskMessageType &task)

virtual void	performingEmbarkTechnique ()

virtual void	performingDisembarkTechnique ()

virtual void	moveToEgress ()

virtual void	movingToEgress ()

virtual void	disembark ()

virtual void	sendTask (const DtSimTask &task, const DtUUID &to)

virtual void	removeControlPoint ()

virtual void	moveToIngress (const DtUUID &parent)

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

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

virtual void	moveToEmbarkationPoint ()

virtual void	atEmbarkationPoint ()

virtual void	waitingToStop ()

virtual void	movingToIngress ()

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

virtual void	unloadObject (const DtVector &unloadPoint, int appearance=0xFFFFFFFF)

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

virtual void	movingToEmbarkationPoint ()

virtual void	stoppedAtEmbarkedPoint ()

virtual void	setState (DtVrfEmbarkationPSR::DtEmbarkationControllerState)

virtual DtVrfEmbarkationPSR::DtEmbarkationControllerState	state () const

virtual bool	isEmbarkationState (DtVrfEmbarkationPSR::DtEmbarkationControllerState) const

virtual bool	createPSR ()

virtual void	setupExistingConditions ()

virtual void	completeEmbarkationInformationRequest (const DtIfEmbarkationInformation *)

virtual void	embarkationRefused (const DtIfEmbarkationInformation *)

virtual void	completeDisembarkationInformationRequest (const DtIfEmbarkationInformation *)

virtual void	disembarkationRefused (const DtIfEmbarkationInformation *)

virtual DtTaitBryan	embarkedOrientation (const DtTaitBryan &, const DtUUID &parent) const

virtual void	moveToIngressPoint (const DtIfEmbarkationInformation *info)

virtual void	moveAlongToIngressPoint (const DtIfEmbarkationInformation *info)

virtual void	moveToEgressPoint (const DtIfEmbarkationInformation *info)

virtual void	moveAlongToEgressPoint (const DtIfEmbarkationInformation *info)

virtual void	issueMoveToEgressTask ()

virtual void	issueMoveToIngressTask ()

virtual void	issueMoveAlongToEgressTask ()

virtual void	issueMoveAlongToIngressTask ()

virtual void	issueMoveToEmbarkationPointTask ()

virtual DtVector	currentBodyPosition (const DtUUID &parent) const

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)

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

virtual void	requestGiveUpSlot (const DtUUID &parent)

virtual void	waitingForEmbarkationInformation ()

virtual void	waitingForDisembarkationInformation ()

virtual void	placeObject (bool clamp=false)

virtual void	placeObject (const DtVector &geocLocation, const DtTaitBryan &orientation, bool clamp)

virtual void	setLocation (const DtVector &)

virtual void	calculateAndSetHeading (const DtVector &start, const DtVector &end)

virtual void	sendSetRequest (DtSetDataRequest &request)

virtual void	processDisembarkationState (const DtVector &bodyExitPosition)

virtual void	movingToFinalDestination ()

virtual void	moveToFinalDestination ()

virtual void	preprocessEmbarkTask ()

virtual void	preprocessDisembarkTask ()

virtual bool	checkEmbarkOk (const DtUUID &parent) const

virtual void	updateDisembarkedAppearanceAndAnimation (int appearance)

virtual void	updateEmbarkedAppearanceAndAnimation (int, const DtString &)

virtual void	updateLifeformEmbarkedAppearanceAndAnimation (int, const DtString &)

virtual void	attachToEmbarkedParent (const DtUUID &newParent)

virtual DtVector	fallbackOffloadPoint ()

virtual void	enable ()

virtual void	disable ()

virtual DtIfEmbarkationInformation	createEmbarkationInformationFromProcessState () const

virtual bool	parentOnGround ()

virtual void	processSetHeading ()

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

virtual bool	createPortGroups ()

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

virtual void	updateTaskVisualizations ()

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)

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

static void	embarkTaskCallback (DtSimMessage msg, void usr)

static void	embarkObjectCallback (DtSimMessage msg, void usr)

static void	disembarkObjectCallback (DtSimMessage msg, void usr)

static void	embarkationInformationCallback (DtSimMessage msg, void usr)

static void	setLoadEntityCallback (DtSimMessage msg, void usrData)

static void	setUnloadEntityCallback (DtSimMessage msg, void usrData)

static void	deleteVrfObjectCallback (const DtLocalObject msg, void usr)

static void	taskCompleteReportCallback (DtSimMessage msg, void usr)

static void	setHeadingCallback (DtSimMessage , void usr)

Protected Attributes
std::list< DtString >	myEmbarkedObjects

DtVrfEmbarkationPSR *	myProcessState

bool	myWaiting

DtEmbarkationDescriptor *	myEmbarkationDescriptor

double	myRequestTime

int	myRequestRetries

bool	myAreCallbacksRegistered

bool	myUseLoadOverrideIfNoSlotAvailable

DtVector	myLoadOverridePosition

DtUUID	myParentToLoadOn

bool	myResetGroundClampOnDisembark

bool	myResetGroundClampOnDisembarkValue

bool	myRemoveSetHeadingNotifyCallback

bool	myClampOnReceiveEmbarkationInformation

DtStringOutputPort *	myOrderedAnimationPort

bool	myResetAnimationIfNoLongerEmbarked

DtMovementLocalObjectFacade	myMovementLocalObjectFacade

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

Private Member Functions
	DtEmbarkationController ()

	DtEmbarkationController (const DtEmbarkationController &orig)

const DtEmbarkationController &	operator= (const DtEmbarkationController &orig)

virtual void	processEmbarkationLocked (DtSimMessage *msg)

static void	setEmbarkationLockedCallback (DtSimMessage msg, void usrData)

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

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

DtEmbarkationController::DtEmbarkationController	(	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 DtEmbarkationController::~DtEmbarkationController ( )

virtual

destructor

DtEmbarkationController::DtEmbarkationController ( )

private

default constructor; not implemented

DtEmbarkationController::DtEmbarkationController ( const DtEmbarkationController & orig )

private

copy constructor; not implemented

Member Function Documentation

virtual bool DtEmbarkationController::init ( )

virtual

Initializes any state that is needed.

Reimplemented from DtControllerComponent.

Reimplemented in DtFixedWingEmbarkationController.

virtual const char* DtEmbarkationController::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: DtEmbarkationControllerType

Implements DtTaskControllerComponent.

Reimplemented in DtDisaggregatedEmbarkationController, DtFixedWingEmbarkationController, and DtRotaryWingEmbarkationController.

static DtSimComponent* DtEmbarkationController::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 bool DtEmbarkationController::createPorts ( )

protectedvirtual

Overridden to create the local ports.

Reimplemented from DtSimComponent.

virtual void DtEmbarkationController::registerTaskMsgCallbacks ( )

protectedvirtual

Override for interest in both embarkation tasks and sets.

Reimplemented from DtTaskControllerComponent.

Reimplemented in DtDisaggregatedEmbarkationController.

virtual void DtEmbarkationController::unregisterTaskMsgCallbacks ( )

protectedvirtual

Override for uninterest in both embarkation tasks and sets.

virtual void DtEmbarkationController::preFirstTickInit ( )

protectedvirtual

Calls setupExistingConditions()

Reimplemented from DtSimComponent.

virtual void DtEmbarkationController::tick ( )

protectedvirtual

Ticks and performs current state.

Reimplemented from DtSimComponent.

Reimplemented in DtDisaggregatedEmbarkationController.

virtual void DtEmbarkationController::clearCurrentTaskMessage ( )

protectedvirtual

Resets state flag to DtIdle.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtEmbarkationController::suspendTask ( )

protectedvirtual

Overridden from parent to sent a giveUpSlot message to the object it was embarking on.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtEmbarkationController::clearTask ( )

protectedvirtual

Override to clear out any subtasks we might have.

Reimplemented from DtSingleTaskControllerComponent.

Reimplemented in DtDisaggregatedEmbarkationController.

virtual void DtEmbarkationController::processDisembarkTask ( DtSimMessage * msg )

protectedvirtual

Tasks.

Calls down to immediately disembark the item to the egress point

static void DtEmbarkationController::disembarkTaskCallback	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

virtual void DtEmbarkationController::checkAndSetEgressPosture ( )

protectedvirtual

If this is a human, set the posture to standing if in sitting posture when moving to egress. Override if you want to add more postures to this.

virtual void DtEmbarkationController::processEmbarkTask ( DtSimMessage * msg )

protectedvirtual

Sets state to be DtMoveToIngress. The DtMoveToIngress state will start at DtMoveToTask as a subtask to move to the ingress point. Once that task is complete, the state will be changed to DtMoveToEmbarkationPoint, after which the entity will be considered embarked.

Reimplemented in DtDisaggregatedEmbarkationController.

static void DtEmbarkationController::embarkTaskCallback	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

static void DtEmbarkationController::embarkObjectCallback	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

Processes DtIfEmbark and disembark messages. If there is a load override, does not query the occupancy controller for embark point.

virtual void DtEmbarkationController::processEmbarkObjectCallback ( DtSimMessage * msg )

protectedvirtual

Reimplemented in DtDisaggregatedEmbarkationController.

static void DtEmbarkationController::disembarkObjectCallback	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

virtual void DtEmbarkationController::processDisembarkObjectCallback ( DtSimMessage * msg )

protectedvirtual

Reimplemented in DtDisaggregatedEmbarkationController.

static void DtEmbarkationController::embarkationInformationCallback	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

Called when embarkation information is received over the network. If our name is attached and we are awaiting embarkation information, then complete the embarkation (or disembarkation) process.

virtual void DtEmbarkationController::processEmbarkationInformationCallback ( DtSimMessage * msg )

protectedvirtual

virtual void DtEmbarkationController::processLoadEntity ( DtSimMessage * msg )

protectedvirtual

Sets.

virtual void DtEmbarkationController::processUnloadEntity ( DtSimMessage * msg )

protectedvirtual

static void DtEmbarkationController::setLoadEntityCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

staticprotected

static void DtEmbarkationController::setUnloadEntityCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

staticprotected

static void DtEmbarkationController::setEmbarkationLockedCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

staticprotected

sets DtVrfEmbarkationPSR::myEmbarkationLocked

virtual void DtEmbarkationController::processEmbarkationLocked ( DtSimMessage * msg )

protectedvirtual

sets DtVrfEmbarkationPSR::myEmbarkationLocked

virtual void DtEmbarkationController::unload	(	const DtVector &	point,
		int	appearance = `0xFFFFFFFF`
	)

protectedvirtual

Unloads entity at specified egress point. Appearance will be the default appearance to set on a disembarked object. If 0xFFFFFFFF this will mean to default for humans to stand. All others will leave appearance the same.

Reimplemented in DtRotaryWingEmbarkationController.

static void DtEmbarkationController::deleteVrfObjectCallback	(	const DtLocalObject *	msg,
		void *	usr
	)

staticprotected

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

virtual void DtEmbarkationController::processDeleteVrfObjectCallback ( const DtLocalObject * obj )

protectedvirtual

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

staticprotected

Monitor taskReportComplete callback to see when our moveTo task is complete during embarkation so we can then set state to DtMoveToEmbarkPoint.

virtual void DtEmbarkationController::processTaskComplete ( DtSimMessage * msg )

protectedvirtual

Reimplemented in DtDisaggregatedEmbarkationController, and DtFixedWingEmbarkationController.

virtual bool DtEmbarkationController::performTechnique ( )

protectedvirtual

Perform the given technique. If there is any kind of failure then return false and continue with "normal" embarkation. Will continue with "normal" embarkation if the task also fails to complete.

virtual bool DtEmbarkationController::sendTechniqueTask ( const DtSimTaskMessageType & task )

protectedvirtual

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.

virtual void DtEmbarkationController::performingEmbarkTechnique ( )

protectedvirtual

Called during the time the entity is performin a technique as part of embark.

virtual void DtEmbarkationController::performingDisembarkTechnique ( )

protectedvirtual

Called during the time the entity is performin a technique as part of disembark.

virtual void DtEmbarkationController::moveToEgress ( )

protectedvirtual

Moves the item to the egress point to prepare for disembarking. Currently simply sets state to DtDisembark.

Reimplemented in DtDisaggregatedEmbarkationController.

virtual void DtEmbarkationController::movingToEgress ( )

protectedvirtual

Called while entity is moving to egress point. Currently no-ops.

Reimplemented in DtFixedWingEmbarkationController.

virtual void DtEmbarkationController::disembark ( )

protectedvirtual

Disembarks item by calling unload() and then resets state to idle.

Reimplemented in DtRotaryWingEmbarkationController.

virtual void DtEmbarkationController::sendTask	(	const DtSimTask &	task,
		const DtUUID &	to
	)

protectedvirtual

Sends task to specified receiver.

virtual void DtEmbarkationController::removeControlPoint ( )

protectedvirtual

Removes the control point from object manager (if exists)

virtual void DtEmbarkationController::moveToIngress ( const DtUUID & parent )

protectedvirtual

Starts a moveTo tasks, given the myIngressPoint (that is created as part of this method) as the target. It then sets it's state to DtMovingToIngress.

Reimplemented in DtDisaggregatedEmbarkationController.

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

protectedvirtual

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

protectedvirtual

virtual void DtEmbarkationController::moveToEmbarkationPoint ( )

protectedvirtual

Sets state to DtMovingToEmbarkationPoint and starts task to move to embarkation point.

virtual void DtEmbarkationController::atEmbarkationPoint ( )

protectedvirtual

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 in DtDisaggregatedEmbarkationController, DtFixedWingEmbarkationController, and DtRotaryWingEmbarkationController.

virtual void DtEmbarkationController::waitingToStop ( )

protectedvirtual

Called while the entity is waiting to come to a complete stop. Does nothing.

virtual void DtEmbarkationController::movingToIngress ( )

protectedvirtual

Called while the entity is moving to ingress point. If ingress is actually a route, when the entity gets to the first point of the route, embark it so it will avoid obstacles.

Reimplemented in DtFixedWingEmbarkationController.

virtual void DtEmbarkationController::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()`
	)

protectedvirtual

Called as part of processLoad() message.

Reimplemented in DtDisaggregatedEmbarkationController.

virtual void DtEmbarkationController::unloadObject	(	const DtVector &	unloadPoint,
		int	appearance = `0xFFFFFFFF`
	)

protectedvirtual

Called as part of processUnload Unloads entity at specified egress point. Appearance will be the default appearance to set on a disembarked object. If 0xFFFFFFFF this will mean to default for humans to stand. All others will leave appearance the same.

Reimplemented in DtDisaggregatedEmbarkationController.

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

protectedvirtual

Called to complete embarkation via task.

Reimplemented in DtFixedWingEmbarkationController, and DtRotaryWingEmbarkationController.

virtual void DtEmbarkationController::movingToEmbarkationPoint ( )

protectedvirtual

Called when moving to embarkation point. Sets state to DtAtEmbarkationPoint.

virtual void DtEmbarkationController::stoppedAtEmbarkedPoint ( )

protectedvirtual

Last step – embark on object.

virtual void DtEmbarkationController::setState ( DtVrfEmbarkationPSR::DtEmbarkationControllerState )

protectedvirtual

Sets state in PSR and returns state from PSR.

virtual DtVrfEmbarkationPSR::DtEmbarkationControllerState DtEmbarkationController::state ( ) const

protectedvirtual

virtual bool DtEmbarkationController::isEmbarkationState ( DtVrfEmbarkationPSR::DtEmbarkationControllerState ) const

protectedvirtual

virtual bool DtEmbarkationController::createPSR ( )

protectedvirtual

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.

virtual void DtEmbarkationController::setupExistingConditions ( )

protectedvirtual

Called only during first tick, sets up any internal variables that are needed.

virtual void DtEmbarkationController::completeEmbarkationInformationRequest ( const DtIfEmbarkationInformation * )

protectedvirtual

Called when embarkation information has been received and we have been cleared to embark.

virtual void DtEmbarkationController::embarkationRefused ( const DtIfEmbarkationInformation * )

protectedvirtual

Called when embarkation information has been received and we have been declined an embarkation slot.

virtual void DtEmbarkationController::completeDisembarkationInformationRequest ( const DtIfEmbarkationInformation * )

protectedvirtual

Called when disembarkation information has been received and we have been cleared to disembark.

virtual void DtEmbarkationController::disembarkationRefused ( const DtIfEmbarkationInformation * )

protectedvirtual

Called when disembarkation information has been received and we have been declined the request to disembark.

virtual DtTaitBryan DtEmbarkationController::embarkedOrientation	(	const DtTaitBryan &	,
		const DtUUID &	parent
	)		const

protectedvirtual

Takes the orientation from embarkation information and transforms it to an embarkable orientation.

virtual void DtEmbarkationController::moveToIngressPoint ( const DtIfEmbarkationInformation * info )

protectedvirtual

Creates a control point and give a DtMoveTo subtask to move to the ingress point.

virtual void DtEmbarkationController::moveAlongToIngressPoint ( const DtIfEmbarkationInformation * info )

protectedvirtual

Creates a route and give a DtMoveAlong subtask to move along the route.

virtual void DtEmbarkationController::moveToEgressPoint ( const DtIfEmbarkationInformation * info )

protectedvirtual

Creates a control point and give a DtMoveTo subtask to move to the egress point.

virtual void DtEmbarkationController::moveAlongToEgressPoint ( const DtIfEmbarkationInformation * info )

protectedvirtual

Creates a route and give a DtMoveAlong subtask to move along the route to the egress point.

virtual void DtEmbarkationController::issueMoveToEgressTask ( )

protectedvirtual

Override to issue a task that is different than the DtMoveTo for a single control point.

virtual void DtEmbarkationController::issueMoveToIngressTask ( )

protectedvirtual

virtual void DtEmbarkationController::issueMoveAlongToEgressTask ( )

protectedvirtual

Override to issue a task that is different than the default DtMoveAlong task.

Reimplemented in DtFixedWingEmbarkationController.

virtual void DtEmbarkationController::issueMoveAlongToIngressTask ( )

protectedvirtual

Reimplemented in DtFixedWingEmbarkationController.

virtual void DtEmbarkationController::issueMoveToEmbarkationPointTask ( )

protectedvirtual

Override to issue a task that is different than the default DtMoveTo task.

Reimplemented in DtRotaryWingEmbarkationController.

virtual DtVector DtEmbarkationController::currentBodyPosition ( const DtUUID & parent ) const

protectedvirtual

Current body position and orientation on embarked parent.

virtual DtTaitBryan DtEmbarkationController::currentBodyOrientation ( const DtUUID & parent ) const

protectedvirtual

virtual DtVector DtEmbarkationController::currentBodyVelocity ( const DtUUID & parent ) const

protectedvirtual

virtual DtVector DtEmbarkationController::currentBodyAcceleration ( const DtUUID & parent ) const

protectedvirtual

virtual bool DtEmbarkationController::requestEmbarkationInformationFrom	(	const DtUUID &	parent,
		bool	start = `false`,
		int	embarkInSlot = `-1`,
		const DtString &	slotName = `"*"`,
		const DtString &	slotType = `"*"`,
		bool	anyIfTaken = `true`
	)

protectedvirtual

Sends a request to find out ingress and embarkation location of the host entity. The entity can return with the requested information, and, possibly a new parent to embark on. It also sets the machine state to DtWaitingForEmbarkationInformtaion (or Disembarkation). If return information has not been received in the timeout period of time, then, a new request will be made. If a receipt has not been received in the retry amount of times, then, the embarkation will fail.

If start is true, then reset retries to 1

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

protectedvirtual

virtual void DtEmbarkationController::requestGiveUpSlot ( const DtUUID & parent )

protectedvirtual

Sends a request to give up a slot that might be reserved in our name.

virtual void DtEmbarkationController::waitingForEmbarkationInformation ( )

protectedvirtual

virtual void DtEmbarkationController::waitingForDisembarkationInformation ( )

protectedvirtual

virtual void DtEmbarkationController::placeObject ( bool clamp = false )

protectedvirtual

Places object on terrain after embarkation to refresh support points.

virtual void DtEmbarkationController::placeObject	(	const DtVector &	geocLocation,
		const DtTaitBryan &	orientation,
		bool	clamp
	)

protectedvirtual

Places object on terrain after embarkation to refresh support points.

virtual void DtEmbarkationController::setLocation ( const DtVector & )

protectedvirtual

Sends setLocation request to this entity for the specified world location.

Reimplemented in DtFixedWingEmbarkationController.

virtual void DtEmbarkationController::calculateAndSetHeading	(	const DtVector &	start,
		const DtVector &	end
	)

protectedvirtual

Calculates the heading needed to disbark given the current state. If disembarking along a route, calculates the heading from first to second point, else calculates heading from center of entity to egress point or Calculates the heading needed to move from current embarkation position to embarked space, and sets it. If moving along an ingress route (or, about to) calculates and sets the heading to the next point.

virtual void DtEmbarkationController::sendSetRequest ( DtSetDataRequest & request )

protectedvirtual

Sends set request.

virtual void DtEmbarkationController::processDisembarkationState ( const DtVector & bodyExitPosition )

protectedvirtual

virtual void DtEmbarkationController::movingToFinalDestination ( )

protectedvirtual

virtual void DtEmbarkationController::moveToFinalDestination ( )

protectedvirtual

virtual void DtEmbarkationController::preprocessEmbarkTask ( )

protectedvirtual

Currently noops, but, give an opportunity to do any preprocessing before embark or disembark task starts.

Reimplemented in DtDisaggregatedEmbarkationController.

virtual void DtEmbarkationController::preprocessDisembarkTask ( )

protectedvirtual

Reimplemented in DtDisaggregatedEmbarkationController.

virtual bool DtEmbarkationController::checkEmbarkOk ( const DtUUID & parent ) const

protectedvirtual

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)

virtual void DtEmbarkationController::updateDisembarkedAppearanceAndAnimation ( int appearance )

protectedvirtual

Updates the appearance and animation of a disembarked object (from its current appearance). Currently will only set DI posture to standing and cancel the embarked animation, if one was set. For a human an appearance of 0xFFFFFFFF will mean stand.

virtual void DtEmbarkationController::updateEmbarkedAppearanceAndAnimation	(	int	,
		const DtString &
	)

protectedvirtual

Updates the appearance and animation of an embarked entity. If appearance is not 0xFFFFFFFF will set that appearance directly, unless the entity is a lifeform. It will then call updateLifeformEmbarkedAppearanceAndAnimation, which will only set the posture component of the appearance, as well as the animation if specified.

virtual void DtEmbarkationController::updateLifeformEmbarkedAppearanceAndAnimation	(	int	,
		const DtString &
	)

protectedvirtual

virtual void DtEmbarkationController::attachToEmbarkedParent ( const DtUUID & newParent )

protectedvirtual

Only called when disembarkation causes the entity to be embarked on a new parent (i.e. if disembarking from a helicopter that is embarked on a carrier, the disembarking entity is now considered embarked on the carrier)

virtual DtVector DtEmbarkationController::fallbackOffloadPoint ( )

protectedvirtual

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. This is in body position. Currently, that is 0, 0, 0 if the embarkation parent information cannot be found, or it will try and place it outside of the bounding volume of the parent.

virtual void DtEmbarkationController::enable ( )

protectedvirtual

Override to add set data request and message callbacks.

Reimplemented from DtTaskControllerComponent.

virtual void DtEmbarkationController::disable ( )

protectedvirtual

Override to remove set data request and message callbacks.

Reimplemented from DtSingleTaskControllerComponent.

virtual DtIfEmbarkationInformation DtEmbarkationController::createEmbarkationInformationFromProcessState ( ) const

protectedvirtual

Recreates the embarkation information content message from the process state information.

virtual bool DtEmbarkationController::parentOnGround ( )

protectedvirtual

Returns true unless the parent is a FW or RW and is in the air.

static void DtEmbarkationController::setHeadingCallback	(	DtSimMessage *	,
		void *	usr
	)

staticprotected

Used to set amClampedToGround back to original setting after disembarking from an aircraft in the air.

virtual void DtEmbarkationController::processSetHeading ( )

protectedvirtual

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

private

assignment operator; not implemented

Member Data Documentation

std::list<DtString> DtEmbarkationController::myEmbarkedObjects

protected

DtVrfEmbarkationPSR* DtEmbarkationController::myProcessState

protected

Container for state data associated with this component. This state is saved and restored as part of a scenario (or checkpoint).

bool DtEmbarkationController::myWaiting

protected

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. This can be the case where an object is waiting for the control point it is moving to be created or an object that it is waiting to disembark to be created on the network.

DtEmbarkationDescriptor* DtEmbarkationController::myEmbarkationDescriptor

protected

double DtEmbarkationController::myRequestTime

protected

int DtEmbarkationController::myRequestRetries

protected

bool DtEmbarkationController::myAreCallbacksRegistered

protected

bool DtEmbarkationController::myUseLoadOverrideIfNoSlotAvailable

protected

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

DtVector DtEmbarkationController::myLoadOverridePosition

protected

DtUUID DtEmbarkationController::myParentToLoadOn

protected

bool DtEmbarkationController::myResetGroundClampOnDisembark

protected

bool DtEmbarkationController::myResetGroundClampOnDisembarkValue

protected

bool DtEmbarkationController::myRemoveSetHeadingNotifyCallback

protected

bool DtEmbarkationController::myClampOnReceiveEmbarkationInformation

protected

DtStringOutputPort* DtEmbarkationController::myOrderedAnimationPort

protected

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.
Output Port Default Value:
.

bool DtEmbarkationController::myResetAnimationIfNoLongerEmbarked

protected

DtMovementLocalObjectFacade DtEmbarkationController::myMovementLocalObjectFacade

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation