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

Inheritance diagram for DtDisaggregatedEmbarkationController:

[legend]

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

virtual	~DtDisaggregatedEmbarkationController ()

virtual const char *	type () const

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

virtual	~DtEmbarkationController ()

virtual bool	init ()

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

virtual	~DtSingleTaskControllerComponent ()

virtual void	postTick () override

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

virtual void	taskNotify (const DtSimTask &task) override

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 DtSubtaskStatusEntry *	subtaskStatus (int subtaskId)

virtual DtTaskMessage *	currentTaskMessage () const

virtual DtSimTaskStatePtr	currentTaskState () const

virtual bool	decideToGiveUpTask () const

virtual void	giveUpTask ()

virtual bool	taskActive (int taskId) const override

virtual bool	clearTopLevelTasks () override

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType) override

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType) override

virtual void	clearTaskById (int taskId) override

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId) override

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId) override

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

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const override

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

virtual	~DtTaskControllerComponent ()

virtual AcceptLevel	acceptTask (const DtTaskMessage &task)

virtual bool	showCurrentTaskInGui () const

virtual void	setRadio (DtSimRadio *radio) override

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 override

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

virtual DtSimRadio *	radio ()

virtual void	enableTaskTypes ()

virtual void	enableScritedTask (const DtString &scriptId)

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, double minTickPeriodVariance)

virtual void	setupFirstTickTime ()

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

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	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 DtEmbarkationController
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 void	moveToIngress (const DtUUID &parent)

virtual void	preprocessEmbarkTask ()

virtual void	moveToEgress ()

virtual void	preprocessDisembarkTask ()

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

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

virtual void	atEmbarkationPoint ()

virtual void	tick ()

virtual void	checkEmbarkationState ()

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	processTaskComplete (DtSimMessage *msg)

virtual void	processEmbarkObjectCallback (DtSimMessage *msg)

virtual void	processDisembarkObjectCallback (DtSimMessage *msg)

virtual void	clearTask ()

virtual void	registerTaskMsgCallbacks ()

virtual void	processEmbarkTask (DtSimMessage *pMsg)

Protected Member Functions inherited from DtEmbarkationController
virtual bool	createPorts ()

virtual void	unregisterTaskMsgCallbacks ()

virtual void	preFirstTickInit ()

virtual void	clearCurrentTaskMessage ()

virtual void	suspendTask ()

virtual void	processDisembarkTask (DtSimMessage *msg)

virtual void	checkAndSetEgressPosture ()

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 bool	clampOnPlacement () const

virtual bool	performTechnique ()

virtual bool	sendTechniqueTask (const DtSimTaskMessageType &task)

virtual void	performingEmbarkTechnique ()

virtual void	performingDisembarkTechnique ()

virtual void	movingToEgress ()

virtual void	disembark ()

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

virtual void	removeControlPoint ()

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

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

virtual void	moveToEmbarkationPoint ()

virtual void	waitingToStop ()

virtual void	movingToIngress ()

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

virtual void	processEmbarkationLocked (DtSimMessage *msg)

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 void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)

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

DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)

template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)

const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const

template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) 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)

Protected Attributes
DtAggregateLocalObjectFacade	myAggregateLocalObjectFacade

DtCompatibilityRadio *	myCommandRadio

DtAggregateEmbarkationDescriptor *	myAggregateEmbarkationDescriptor

DtOrganizedManagedObjectList	myTaskableSubordinates

Protected Attributes inherited from DtEmbarkationController
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

bool	myInvisibleSetByUserDuringEmbark = false

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	myLastTickSimTime

std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager *	myPredicateCallbackManager

boost::signals2::scoped_connection	myIsClutterChangedConnection

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

	DtDisaggregatedEmbarkationController (const DtDisaggregatedEmbarkationController &orig)

const DtDisaggregatedEmbarkationController &	operator= (const DtDisaggregatedEmbarkationController &orig)

Additional Inherited Members
Public Types inherited from DtTaskControllerComponent
enum	AcceptLevel { AcceptLevel_Accept = 0, AcceptLevel_Partial = 1, AcceptLevel_Error = 2, AcceptLevel_NoAccept = 99 }

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

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)

static void	setEmbarkationLockedCallback (DtSimMessage msg, void usrData)

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

DtDisaggregatedEmbarkationController::DtDisaggregatedEmbarkationController	(	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 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,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

Parameters

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

Returns: New instance of this class.

virtual void 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,
		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

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

Reimplemented from DtEmbarkationController.

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

protectedvirtual

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

Reimplemented from DtEmbarkationController.

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.

virtual void DtDisaggregatedEmbarkationController::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 from DtEmbarkationController.

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

private

assignment operator; not implemented

Member Data Documentation

DtAggregateLocalObjectFacade DtDisaggregatedEmbarkationController::myAggregateLocalObjectFacade

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.

DtOrganizedManagedObjectList 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:

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation