DtDisaggregatedEmbarkationController Class Reference

DtAggregateEmbarkationController is a controller that models embarkation/disembarkation behavior for an aggregate entity. More...

Inheritance diagram for DtDisaggregatedEmbarkationController:

Public Member Functions
	DtDisaggregatedEmbarkationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtDisaggregatedEmbarkationController ()
	destructor
virtual const char *	type () const
	Returns a string identifies the class type of component.
virtual bool	init ()
	Override to get handle to formation state.
Public Member Functions inherited from DtEmbarkationController
	DtEmbarkationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtEmbarkationController ()
	destructor
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtSingleTaskControllerComponent ()
	destructor
virtual void	postTick ()
	Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task.
virtual void	taskNotify (const DtSimTask &task)
	This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void	taskComplete (bool success=true)
	If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself.
virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks.
virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks.
virtual bool	isSubtasked () const
	Returns true if this controller is currently subtasked.
virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component.
virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks.
virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller.
virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr	currentTaskState () const
virtual bool	decideToGiveUpTask () const
	This function is used to determine if the controller should give up trying to execute the current task.
virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true.
virtual bool	taskActive (int taskId) const
virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared.
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller.
virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)
virtual std::list < DtTaskMessage * >	currentTaskMessages () const
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtTaskControllerComponent ()
	destructor
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback.
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback().
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback.
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message.
virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimRadio *	radio ()
	The radio this component is listening to.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const 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.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component.
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
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
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.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual 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.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
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.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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.
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.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

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

Protected Member Functions
virtual void	moveToIngress (const DtUUID &parent)
	Instead of ourselves moving to the ingress position, noop.
virtual void	preprocessEmbarkTask ()
	Sends a DtEmbark task to all taskable subordinates.
virtual void	moveToEgress ()
	Override these classes for the same reason as embarking.
virtual void	preprocessDisembarkTask ()
	Sends a DtDisembark task to all taskable subordinates.
virtual void	sendTaskToSubordinate (const DtSimTask &task, const DtUUID &subordinate) const
	Utilty function that sends a given task to a given subordinate via its radio.
virtual void	sendSetDataToSubordinate (const DtSetDataRequest &setData, const DtUUID &subordinate) const
	Utilty function that sends a given task to a given subordinate via its radio.
virtual void	atEmbarkationPoint ()
	Sets the aggregate's embarkation state in its process state repository to DtVrfEmbarkationPSR::DtStoppedAtEmbarkedPoint.
virtual void	tick ()
	Calls checkEmbarkationState().
virtual void	checkEmbarkationState ()
	Override to check embarkation state of subordinates, and, if all available subordinates are embarked, embark on the same location as the leader.
virtual void	embarkObject (bool overridePosition, const DtVector &loadPosition, const DtUUID &parentName, int appearance=0xFFFFFFFF, const DtTaitBryan &orientation=DtTaitBryan(), const DtVector &acceleration=DtVector(), const DtVector &velocty=DtVector())
	Iterates over set of taskable subordinates and issues DtSetLoadEntityRequest to each one.
virtual void	unloadObject (const DtVector &unloadPoint)
	Iterates over set of taskable subordinates and issues DtSetUnloadEntityRequest to each one.
virtual void	setupTaskableSubordiantes ()
virtual void	processTaskComplete (DtSimMessage *msg)
	If the entity processing the report is part of our subordinate list, then reevaluate the taskable entities.
virtual void	processEmbarkObjectCallback (DtSimMessage *msg)
	Override to send embarkation message to subordinates.
virtual void	processDisembarkObjectCallback (DtSimMessage *msg)
virtual void	clearTask ()
	When clearing task, make sure to clear tasks of all subordinates.
virtual void	registerTaskMsgCallbacks ()
	Override for interest in task complete reports.
Protected Member Functions inherited from DtEmbarkationController
virtual void	unregisterTaskMsgCallbacks ()
	Override for uninterest in both embarkation tasks and sets.
virtual void	preFirstTickInit ()
	Calls setupExistingConditions()
virtual void	clearCurrentTaskMessage ()
	Resets state flag to DtIdle.
virtual void	suspendTask ()
	Overridden from parent to sent a giveUpSlot message to the object it was embarking on.
virtual void	processDisembarkTask (DtSimMessage *msg)
	Tasks.
virtual void	checkAndSetEgressPosture ()
	If this is a human, set the posture to standing if in sitting posture when moving to egress.
virtual void	processEmbarkTask (DtSimMessage *msg)
	Sets state to be DtMoveToIngress.
virtual void	processEmbarkationInformationCallback (DtSimMessage *msg)
virtual void	processLoadEntity (DtSimMessage *msg)
	Sets.
virtual void	processUnloadEntity (DtSimMessage *msg)
virtual void	unload (const DtVector &point)
	Unloads entity at specified egress point.
virtual void	processDeleteVrfObjectCallback (DtVrfObject *obj)
virtual void	movingToEgress ()
	Called while entity is moving to egress point. Currently no-ops.
virtual void	disembark ()
	Disembarks item by calling unload() and then resets state to idle.
virtual void	sendTask (const DtSimTask &task, const DtUUID &to)
	Sends task to specified receiver.
virtual void	removeControlPoint ()
	Removes the control point from object manager (if exists)
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.
virtual void	waitingToStop ()
	Called while the entity is waiting to come to a complete stop.
virtual void	movingToIngress ()
	Called while the entity is moving to ingress point.
virtual void	embarkObject (bool overridePosition, const DtVector &loadPosition, const DtUUID &parent, int appearance=0xFFFFFFFF, const DtTaitBryan &orientation=DtTaitBryan(), const DtVector &acceleration=DtVector(), const DtVector &velocty=DtVector(), bool invisibleWhenEmbarked=false)
	Called as part of processLoad() message.
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)
	Called to complete embarkation via task.
virtual void	movingToEmbarkationPoint ()
	Called when moving to embarkation point.
virtual void	stoppedAtEmbarkedPoint ()
	Last step – embark on object.
virtual void	setState (DtVrfEmbarkationPSR::DtEmbarkationControllerState)
	Sets state in PSR and returns state from PSR.
virtual DtVrfEmbarkationPSR::DtEmbarkationControllerState	state () const
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual void	setupExistingConditions ()
	Called only during first tick, sets up any internal variables that are needed.
virtual void	completeEmbarkationInformationRequest (const DtIfEmbarkationInformation *)
	Called when embarkation information has been received and we have been cleared to embark.
virtual void	embarkationRefused (const DtIfEmbarkationInformation *)
	Called when embarkation information has been received and we have been declined an embarkation slot.
virtual void	completeDisembarkationInformationRequest (const DtIfEmbarkationInformation *)
	Called when disembarkation information has been received and we have been cleared to disembark.
virtual void	disembarkationRefused (const DtIfEmbarkationInformation *)
	Called when disembarkation information has been received and we have been declined the request to disembark.
virtual DtTaitBryan	embarkedOrientation (const DtTaitBryan &, const DtUUID &parent) const
	Takes the orientation from embarkation information and transforms it to an embarkable orientation.
virtual void	moveToIngressPoint (const DtIfEmbarkationInformation *info)
	Creates a control point and give a DtMoveTo subtask to move to the ingress point.
virtual void	moveAlongToIngressPoint (const DtIfEmbarkationInformation *info)
	Creates a route and give a DtMoveAlong subtask to move along the route.
virtual void	moveToEgressPoint (const DtIfEmbarkationInformation *info)
	Creates a control point and give a DtMoveTo subtask to move to the egress point.
virtual void	moveAlongToEgressPoint (const DtIfEmbarkationInformation *info)
	Creates a route and give a DtMoveAlong subtask to move along the route to the egress point.
virtual void	issueMoveToEgressTask ()
	Override to issue a task that is different than the DtMoveTo for a single control point.
virtual void	issueMoveToIngressTask ()
virtual void	issueMoveAlongToEgressTask ()
	Override to issue a task that is different than the default DtMoveAlong task.
virtual void	issueMoveAlongToIngressTask ()
virtual void	issueMoveToEmbarkationPointTask ()
	Override to issue a task that is different than the default DtMoveTo task.
virtual DtVector	currentBodyPosition (const DtUUID &parent) const
	Current body position and orientation on embarked parent.
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, bool anyIfTaken=true)
	Sends a request to find out ingress and embarkation location of the host entity.
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.
virtual void	waitingForEmbarkationInformation ()
virtual void	waitingForDisembarkationInformation ()
virtual void	placeObject (bool clamp=false)
	Places object on terrain after embarkation to refresh support points.
virtual void	setLocation (const DtVector &)
	Sends setLocation request to this entity for the specified world location.
virtual void	calculateAndSetHeading (const DtVector &start, const DtVector &end)
	Calculates the heading needed to disbark given the current state.
virtual void	sendSetRequest (DtSetDataRequest &request)
	Sends set request.
virtual void	processDisembarkationState (const DtVector &bodyExitPosition)
virtual void	movingToFinalDestination ()
virtual void	moveToFinalDestination ()
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)
virtual void	updateDisembarkedAppearance ()
	Updates the appearance of a disembarked object (from its current appearance).
virtual void	updateEmbarkedAppearance (int)
	Updates the appearance of an embarked entity.
virtual void	updateLifeformEmbarkedAppearance (int)
virtual void	attachToEmbarkedParent (const DtUUID &newParent)
	Only called when disembarkation causes the entity to be embarked on a new parent (i.e.
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.
virtual void	enable ()
	Override to add set data request and message callbacks.
virtual void	disable ()
	Override to remove set data request and message callbacks.
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type.
virtual void	cleanupInactiveSubtaskStatus ()
	Clears out subtask status entries that are either completed or canceled which were started by this controller.
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.
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT.
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager.
virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick.
virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component.
virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name.
double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtVrfAggregateStateRepository *	myAggregateStateRepository
	Our aggregate's derived type of state repository, cached here for convenience.
DtCompatibilityRadio *	myCommandRadio
	Aggregate's command radio (derived type of radio), cached here for convenience.
DtAggregateEmbarkationDescriptor *	myAggregateEmbarkationDescriptor
	Descriptor used to configure this component.
DtOrgViewManagedObjectListConstPtr	myTaskableSubordinates
	List of subordinates eligible to participate in embarkation behavior (subordinates that are not destroyed or independently tasked).
Protected Attributes inherited from DtEmbarkationController
std::list< DtString >	myEmbarkedObjects
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.
DtVrfEmbarkationPSR *	myProcessState
	Container for state data associated with this component.
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.
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.
DtVector	myLoadOverridePosition
DtUUID	myParentToLoadOn
bool	myClampOnReceiveEmbarkationInformation

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

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::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.
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
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.
static void	disembarkObjectCallback (DtSimMessage *msg, void *usr)
static void	embarkationInformationCallback (DtSimMessage *msg, void *usr)
	Called when embarkation information is received over the network.
static void	setLoadEntityCallback (DtSimMessage *msg, void *usrData)
static void	setUnloadEntityCallback (DtSimMessage *msg, void *usrData)
static void	deleteVrfObjectCallback (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.
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.
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtAggregateEmbarkationController is a controller that models embarkation/disembarkation behavior for an aggregate entity.

End User Description: The DtAggregateEmbarkationController responds to embarkation-related tasks and set data requests. It executes embarkation behavior for the aggregate as a whole by issuing radio messages to aggregate members to carry out the embarkation-related task or set data request.

This controller may only be configured as a part of an entity that has a vrf-aggregate-state-repository.

Developer Description: The DtAggregateEmbarkationController class sends embark/disembark messages as appropriate to its subordinates. The aggregate considers itself embarked/disembarked once it has received task complete reports from all of the subordinates participating in the task.

Uses Descriptor Type: DtAggregateEmbarkationDescriptor

Constructor & Destructor Documentation

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

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

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

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

virtual DtDisaggregatedEmbarkationController::~DtDisaggregatedEmbarkationController ( )

virtual

destructor

DtDisaggregatedEmbarkationController::DtDisaggregatedEmbarkationController ( )

private

default constructor; not implemented

DtDisaggregatedEmbarkationController::DtDisaggregatedEmbarkationController ( const DtDisaggregatedEmbarkationController &  orig )

private

copy constructor; not implemented

Member Function Documentation

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

DtAggregateEmbarkationControllerType

Reimplemented from DtEmbarkationController.

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

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

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

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

Returns

New instance of this class.

Reimplemented from DtEmbarkationController.

virtual bool DtDisaggregatedEmbarkationController::init ( )

virtual

Override to get handle to formation state.

Reimplemented from DtEmbarkationController.

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

protectedvirtual

Instead of ourselves moving to the ingress position, noop.

Continually check the formation state to see if all our subordinates are embarked (that are part of our formation). If they are, then set this item to be embarked. Note that the checking of the embarkation state is checked in the "movingToIngress" state.

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::preprocessEmbarkTask ( )

protectedvirtual

Sends a DtEmbark task to all taskable subordinates.

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::moveToEgress ( )

protectedvirtual

Override these classes for the same reason as embarking.

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::preprocessDisembarkTask ( )

protectedvirtual

Sends a DtDisembark task to all taskable subordinates.

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::sendTaskToSubordinate ( const DtSimTask &  task, const DtUUID &  subordinate  ) const

protectedvirtual

Utilty function that sends a given task to a given subordinate via its radio.

virtual void DtDisaggregatedEmbarkationController::sendSetDataToSubordinate ( const DtSetDataRequest &  setData, const DtUUID &  subordinate  ) const

protectedvirtual

Utilty function that sends a given task to a given subordinate via its radio.

virtual void DtDisaggregatedEmbarkationController::atEmbarkationPoint ( )

protectedvirtual

Sets the aggregate's embarkation state in its process state repository to DtVrfEmbarkationPSR::DtStoppedAtEmbarkedPoint.

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::tick ( )

protectedvirtual

Calls checkEmbarkationState().

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::checkEmbarkationState ( )

protectedvirtual

Override to check embarkation state of subordinates, and, if all available subordinates are embarked, embark on the same location as the leader.

If any of the available subordinates are disembarked, disembark as well

virtual void DtDisaggregatedEmbarkationController::embarkObject ( bool  overridePosition, const DtVector &  loadPosition, const DtUUID &  parentName, int  appearance = 0xFFFFFFFF, const DtTaitBryan &  orientation = DtTaitBryan(), const DtVector &  acceleration = DtVector(), const DtVector &  velocty = DtVector()  )

protectedvirtual

Iterates over set of taskable subordinates and issues DtSetLoadEntityRequest to each one.

virtual void DtDisaggregatedEmbarkationController::unloadObject ( const DtVector &  unloadPoint )

protectedvirtual

Iterates over set of taskable subordinates and issues DtSetUnloadEntityRequest to each one.

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::setupTaskableSubordiantes ( )

protectedvirtual

virtual void DtDisaggregatedEmbarkationController::processTaskComplete ( DtSimMessage *  msg )

protectedvirtual

If the entity processing the report is part of our subordinate list, then reevaluate the taskable entities.

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::processEmbarkObjectCallback ( DtSimMessage *  msg )

protectedvirtual

Override to send embarkation message to subordinates.

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::processDisembarkObjectCallback ( DtSimMessage *  msg )

protectedvirtual

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::clearTask ( )

protectedvirtual

When clearing task, make sure to clear tasks of all subordinates.

Reimplemented from DtEmbarkationController.

virtual void DtDisaggregatedEmbarkationController::registerTaskMsgCallbacks ( )

protectedvirtual

Override for interest in task complete reports.

Reimplemented from DtEmbarkationController.

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

private

assignment operator; not implemented

Member Data Documentation

DtVrfAggregateStateRepository* DtDisaggregatedEmbarkationController::myAggregateStateRepository

protected

Our aggregate's derived type of state repository, cached here for convenience.

DtCompatibilityRadio* DtDisaggregatedEmbarkationController::myCommandRadio

protected

Aggregate's command radio (derived type of radio), cached here for convenience.

Aggregate entities should be configured with this derived type of radio in order to send commands to subordinates.

DtAggregateEmbarkationDescriptor* DtDisaggregatedEmbarkationController::myAggregateEmbarkationDescriptor

protected

Descriptor used to configure this component.

DtOrgViewManagedObjectListConstPtr DtDisaggregatedEmbarkationController::myTaskableSubordinates

protected

List of subordinates eligible to participate in embarkation behavior (subordinates that are not destroyed or independently tasked).

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/disaggregatedEmbarkationController.h