DtOccupancyDirectorController Class Reference

DtOccupancyDirectorController allocates reserved embarkation slots and determines which (if any) objects can be embarked on an object. More...

Inheritance diagram for DtOccupancyDirectorController:

Public Member Functions
	DtOccupancyDirectorController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtOccupancyDirectorController ()
	destructor
virtual bool	init ()
	Initializes any state that is needed.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processRequestEmbarkationInformation (DtSimMessage *msg)
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 void	clearTask ()
	If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.
virtual void	suspendTask ()
	This method is called when the currently running task is being suspended.
virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself.
virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks.
virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks.
virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component.
virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks.
virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller.
virtual void	clearCurrentTaskMessage ()
	Returns the current subtask with the specified id.
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 (DtSimBaseRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback.
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback().
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback.
virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks().
virtual void	disable ()
	Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
	The current tasked state of this controller.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimBaseRadio *	radio ()
	The radio this component is listening to.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual 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 (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
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 bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual 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)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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

Protected Member Functions
virtual void	registerTaskMsgCallbacks ()
	Override for interest in both disembark all tasks.
virtual void	preFirstTickInit ()
	Calls setObstructionIDsInCollisionDetector, initializeSlotManager and setupSlots.
virtual void	tick ()
	Ticks and performs current state.
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual void	giveUpSlot (int iSlot, const DtString &name)
	Gives up the slot (if reserved) for the specified entity.
virtual DtEmbarkationSlotInformation	embarkationSlotEntryFor (const DtString &) const
	Returns a slot information structure for given entity.
virtual DtEmbarkationSlotInformation	disembarkationInformationFor (const DtString &, int &iResult) const
	Returns slot that the entity that is currently in has, and whether or not it can disembark.
virtual int	disembarkationResult (const DtEmbarkationSlotInformation &) const
	Returns the status of a potential disembark (can or cannot). Default can always disembark.
virtual bool	reserveSlot (const DtEmbarkationSlotInformation &entry, const DtString &name)
	Reserves the slot so it cannot be used by any other entity.
virtual void	sendSlotInformationTo (const DtString &name, const DtEmbarkationSlotInformation &entry, int, int reqId=0xFFFFFFFF)
	Sends a response back to the requestor with the entry information.
virtual void	processDeleteVrfObjectCallback (DtVrfObject *obj)
virtual void	processDisembarkAllTask (DtSimMessage *msg)
	The disembarkAll task will issue a disembark task to all items that are embarked on this object.
virtual bool	objectDisembarked (const DtString &objectName)
virtual void	disembarkNextObject ()
	Sends a task to the first object on the embarked objects list (from the state repository), and sets that object's name to the PSR.
virtual void	sendTask (const DtSimTask &task, const DtString &objectName)
	Sends the specified task to the named object.
virtual void	processDisembarkObjectCallback (DtSimMessage *msg)
	Processes DtIfDisembarkObject if address to this object and it is a disembarkAll type message.
virtual DtVector	disembarkedPositionFor (const DtString &entityName, const DtEmbarkationSlotInformation &) const
	When disembarking, this will return the final disembark spot for the specified entity.
virtual bool	nextEntityCanDisembark (const DtVrfObject *curEntity) const
	Returns true if the entity that is currently disembarking, it's bounding volume is not occluding the next entitiest to disembark disembarkation point.
virtual bool	isValidForDisembarkLayout (const DtVrfObject *) const
	Return true if this entity kind (or type) can be part of disembarkation layour.
virtual bool	createCollisionDetector ()
	Override to provide a new collision detector implementation.
virtual void	setObstructionIDsInCollisionDetector ()
	Currently sets up to avoid entity kinds 1 - 3.
virtual void	setupSlots ()
	Sets up slot information for slots that are currently available by looking at the state repository to see what is currently reserved and removing any slots that are not available.
virtual void	initializeSlotManager ()
	Initializes mySlotManager with slots found in the descriptor.
virtual void	calculateDisembarkPositions (const std::list< DtString > &)
	Calls down to the slot manager to set up grid and spacing for disembarking objects.
virtual void	generateListForDisembarkation (std::list< DtString > &list)
	Parse the embarked objects list to send disembark tasks only to top entities in hierarchies and avoid multimessaging for subordinates.
virtual void	removeAllSubordinates (DtVrfObject *obj)
	Remove All subordinates of the given object and the object from the list in the state repository.
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.
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
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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 DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Static Protected Member Functions
static void	deleteVrfObjectCallback (DtVrfObject *msg, void *usr)
	If an object is deleted and it is the object that has a slot reserved, give up the slot.
static void	disembarkAllTaskCallback (DtSimMessage *msg, void *usr)
static void	disembarkObjectCallback (DtSimMessage *msg, void *usr)
	Callback for responding to DtIfDisembarkObject messages.

Protected Attributes
DtVrfOccupancyDirectorPSR *	myProcessState
	Container for state data associated with this component.
const DtOccupancyDirectorDescriptor *	myOccupancyDirectorDescriptor
DtEmbarkationSlotManager *	mySlotManager
DtCollisionDetector *	myCollisionDetector
std::set< DtString >	myObjectsToDisembark
	Variable to control which units were disembarked by a superior to avoid multi messages.

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

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
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 Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtOccupancyDirectorController allocates reserved embarkation slots and determines which (if any) objects can be embarked on an object.

Developer Description: This controller responds to messages of type DtIfRequestEmbarkationInformation. When a request is received, the controller looks to see if there are any slots available, and, if so, reserves it (if requested) and then returns a DtIfEmbarkationInformation structure with the reservation information. This controller is also responsible for disembarkation information and responds to those requests. If an entity cannot embark because the object does not support the requesting object type or because the slots are full, an information return structure is sent, but with the DtEmbarkCannotEmbark result status. It will accomplish this task through a series of message requests that are made of the controller (interface) and sends those interface messages back to the requestor.

Uses Descriptor Type: DtOccupancyDirectorDescriptor

Constructor & Destructor Documentation

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

virtual

destructor

DtOccupancyDirectorController::DtOccupancyDirectorController ( )

private

default constructor; not implemented

DtOccupancyDirectorController::DtOccupancyDirectorController ( const DtOccupancyDirectorController &  orig )

private

copy constructor; not implemented

Member Function Documentation

virtual bool DtOccupancyDirectorController::init ( )

virtual

Initializes any state that is needed.

Reimplemented from DtControllerComponent.

virtual DtString DtOccupancyDirectorController::type ( ) const

virtual

Returns a string identifies the class type of component.

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

Returns

DtOccupancyDirectorControllerType

Implements DtTaskControllerComponent.

static DtSimComponent* DtOccupancyDirectorController::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.

static void DtOccupancyDirectorController::requestEmbarkationInformationCallback ( DtSimMessage *  msg, void *  usr  )

static

virtual void DtOccupancyDirectorController::processRequestEmbarkationInformation ( DtSimMessage *  msg )

virtual

virtual void DtOccupancyDirectorController::registerTaskMsgCallbacks ( )

protectedvirtual

Override for interest in both disembark all tasks.

Reimplemented from DtTaskControllerComponent.

virtual void DtOccupancyDirectorController::preFirstTickInit ( )

protectedvirtual

Calls setObstructionIDsInCollisionDetector, initializeSlotManager and setupSlots.

Reimplemented from DtSimComponent.

virtual void DtOccupancyDirectorController::tick ( )

protectedvirtual

Ticks and performs current state.

Reimplemented from DtSimComponent.

virtual bool DtOccupancyDirectorController::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 DtOccupancyDirectorController::giveUpSlot ( int  iSlot, const DtString &  name  )

protectedvirtual

Gives up the slot (if reserved) for the specified entity.

virtual DtEmbarkationSlotInformation DtOccupancyDirectorController::embarkationSlotEntryFor ( const DtString &  ) const

protectedvirtual

Returns a slot information structure for given entity.

virtual DtEmbarkationSlotInformation DtOccupancyDirectorController::disembarkationInformationFor ( const DtString &  , int &  iResult  ) const

protectedvirtual

Returns slot that the entity that is currently in has, and whether or not it can disembark.

virtual int DtOccupancyDirectorController::disembarkationResult ( const DtEmbarkationSlotInformation &  ) const

protectedvirtual

Returns the status of a potential disembark (can or cannot). Default can always disembark.

virtual bool DtOccupancyDirectorController::reserveSlot ( const DtEmbarkationSlotInformation &  entry, const DtString &  name  )

protectedvirtual

Reserves the slot so it cannot be used by any other entity.

If cannot reserve, returns false

virtual void DtOccupancyDirectorController::sendSlotInformationTo ( const DtString &  name, const DtEmbarkationSlotInformation &  entry, int  , int  reqId = 0xFFFFFFFF  )

protectedvirtual

Sends a response back to the requestor with the entry information.

If entry is NULL, then no entry exists for the,

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

staticprotected

If an object is deleted and it is the object that has a slot reserved, give up the slot.

virtual void DtOccupancyDirectorController::processDeleteVrfObjectCallback ( DtVrfObject *  obj )

protectedvirtual

virtual void DtOccupancyDirectorController::processDisembarkAllTask ( DtSimMessage *  msg )

protectedvirtual

The disembarkAll task will issue a disembark task to all items that are embarked on this object.

It will issue disembark tasks one at a time until all items are disembarked. When all items are disembarked, then it will consider the task complete

static void DtOccupancyDirectorController::disembarkAllTaskCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

virtual bool DtOccupancyDirectorController::objectDisembarked ( const DtString &  objectName )

protectedvirtual

Returns

True if the named objects is no longer embarked on the host entity.

virtual void DtOccupancyDirectorController::disembarkNextObject ( )

protectedvirtual

Sends a task to the first object on the embarked objects list (from the state repository), and sets that object's name to the PSR.

If there are no embarked objects, calls taskComplete().

virtual void DtOccupancyDirectorController::sendTask ( const DtSimTask &  task, const DtString &  objectName  )

protectedvirtual

Sends the specified task to the named object.

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

staticprotected

Callback for responding to DtIfDisembarkObject messages.

virtual void DtOccupancyDirectorController::processDisembarkObjectCallback ( DtSimMessage *  msg )

protectedvirtual

Processes DtIfDisembarkObject if address to this object and it is a disembarkAll type message.

virtual DtVector DtOccupancyDirectorController::disembarkedPositionFor ( const DtString &  entityName, const DtEmbarkationSlotInformation &    ) const

protectedvirtual

When disembarking, this will return the final disembark spot for the specified entity.

This will be determined as follows:

• If parent entity is moving above speed threshold, then each entities final resting spot will be at then end of the disembarkation route.

• If parent entity is moving below speed threshold, then entities final resting spot will be laid out in a grid pattern, starting in the upper left of the grid and moving to the lower right.

In either case. each entity will wait to being disembarking until the entity before it is no longer occluding the disembark point

virtual bool DtOccupancyDirectorController::nextEntityCanDisembark ( const DtVrfObject *  curEntity ) const

protectedvirtual

Returns true if the entity that is currently disembarking, it's bounding volume is not occluding the next entitiest to disembark disembarkation point.

virtual bool DtOccupancyDirectorController::isValidForDisembarkLayout ( const DtVrfObject *  ) const

protectedvirtual

Return true if this entity kind (or type) can be part of disembarkation layour.

virtual bool DtOccupancyDirectorController::createCollisionDetector ( )

protectedvirtual

Override to provide a new collision detector implementation.

virtual void DtOccupancyDirectorController::setObstructionIDsInCollisionDetector ( )

protectedvirtual

Currently sets up to avoid entity kinds 1 - 3.

virtual void DtOccupancyDirectorController::setupSlots ( )

protectedvirtual

Sets up slot information for slots that are currently available by looking at the state repository to see what is currently reserved and removing any slots that are not available.

Called every time a slot reservation changes and also upon initialization

virtual void DtOccupancyDirectorController::initializeSlotManager ( )

protectedvirtual

Initializes mySlotManager with slots found in the descriptor.

Should only be called once and must be called before setupSlots()

virtual void DtOccupancyDirectorController::calculateDisembarkPositions ( const std::list< DtString > &  )

protectedvirtual

Calls down to the slot manager to set up grid and spacing for disembarking objects.

Only valid for disembarkAll call

virtual void DtOccupancyDirectorController::generateListForDisembarkation ( std::list< DtString > &  list )

protectedvirtual

Parse the embarked objects list to send disembark tasks only to top entities in hierarchies and avoid multimessaging for subordinates.

virtual void DtOccupancyDirectorController::removeAllSubordinates ( DtVrfObject *  obj )

protectedvirtual

Remove All subordinates of the given object and the object from the list in the state repository.

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

private

assignment operator; not implemented

Member Data Documentation

DtVrfOccupancyDirectorPSR* DtOccupancyDirectorController::myProcessState

protected

Container for state data associated with this component.

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

const DtOccupancyDirectorDescriptor* DtOccupancyDirectorController::myOccupancyDirectorDescriptor

protected

DtEmbarkationSlotManager* DtOccupancyDirectorController::mySlotManager

protected

DtCollisionDetector* DtOccupancyDirectorController::myCollisionDetector

protected

std::set<DtString> DtOccupancyDirectorController::myObjectsToDisembark

protected

Variable to control which units were disembarked by a superior to avoid multi messages.

---

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

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