DtEmbeddedEntitiesController. Handles all tasking and name resolution of Embedded Entities. Handles state transitions, name resolution, task/set forwarding to Embedded Entities, recovery, deployment, etc.

Inheritance diagram for DtEmbeddedEntitiesController:

[legend]

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

virtual	~DtEmbeddedEntitiesController ()

virtual const char *	type () const

virtual bool	init ()

virtual void	preFirstTickInit ()

virtual void	registerTaskMsgCallbacks ()

virtual DtEmbeddedEntitiesPSR *	createPSR ()

virtual void	clearTask (int tskId)

virtual void	tick ()

virtual DtUUID	getObjectNameOfEmbeddedEntity (std::string eeName, bool &found)

virtual DtRwEmbeddedEntityStatus::DtEmbeddedEntityDeploymentState	getStatusOfEmbeddedEntity (std::string eeName, bool &found)

virtual void	processForwardTask (DtSimMessage *msg)

virtual void	processTask (DtSimMessage *msg)

virtual std::list < DtEmbeddedEntity >	availableEmbeddedEntities ()


virtual void	processEmbeddedEntityCurrentlyInContext (double deltaTime)

virtual bool	checkWithinRecoveryRange ()

virtual bool	performDeployment ()

virtual bool	performRecovery ()

virtual bool	performSetForward ()

virtual bool	performTaskForward ()

virtual DtVector	calculateSpawnPosOfTarget ()

virtual bool	commandEeToReturn (const DtString &entityName)


virtual void	processDeletion (const DtSimObject *spawnedObject)

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

virtual	~DtMultiTaskControllerComponent ()

virtual void	postTick ()

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

virtual void	taskComplete (int taskId, bool success)

virtual void	suspendTask (int taskId)

virtual DtTaskMessage *	currentTaskMessage (int taskId)

virtual DtSimTaskStatePtr	currentTaskState (int taskId) const

virtual int	sendSubtask (DtSimTask &task, int taskId)

virtual int	sendTask (DtSimTask &task, const DtUUID &receiver, int parentTaskId, bool actAsSubtask=true, bool useRadio=false)

virtual void	clearSubtask (int subtaskId, int parentTaskId)

virtual void	addPendingSubtaskId (int subtaskId, int taskId)

virtual bool	findPendingSubtaskId (int subtaskId, int taskId)

virtual bool	isSubtasked () const

virtual void	removePendingSubtaskId (int subtaskId, int taskId)

virtual DtSubtaskStatusEntry *	subtaskStatus (int subtaskId, int taskId)

virtual void	removeAllPendingSubtaskIds (int taskId)

virtual std::vector< int >	currentPendingSubstaskIds (int taskId) const

virtual bool	decideToGiveUpTask () const

virtual void	giveUpTask ()

virtual bool	taskActive (int taskId) const

virtual bool	clearTopLevelTasks ()

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)

virtual void	clearTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId)

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

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const

virtual void	setScriptTickPeriod (const DtString &scriptId, double period)

virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (int taskId, const DtString &name)

virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (int taskId, const DtString &name)

virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (int taskId, const DtString &name)

virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (int taskId, const DtString &name)

virtual void	destroyTaskVisualization (int taskId, const DtString &name)

virtual void	destroyTaskVisualizations (int taskId)

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 void	taskNotify (const DtSimTask &task) override

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

virtual void	disable () override

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

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 void	setForwardTaskCallback (DtSimMessage msg, void usrData)

static void	taskForwardTaskCallback (DtSimMessage msg, void usrData)

static void	deployTaskCallback (DtSimMessage msg, void usrData)

static void	recoverTaskCallback (DtSimMessage msg, void usrData)

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 Types
typedef std::map< DtUUID, boost::signals2::connection >	RemovalSignalsMap

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

Protected Member Functions
virtual void	restoreEmbedded (DtRwEmbeddedEntityStatus *const eeStatus)

Protected Member Functions inherited from DtMultiTaskControllerComponent
virtual void	addCurrentTaskMessage (const DtTaskMessage *taskMessage)

virtual void	clearCurrentTaskMessage (int taskId)

virtual void	clearPendingSubtasks (int taskId)

virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType, int taskId)

virtual int	taskIdWhichStartedSubtask (int subtaskId)

virtual void	cleanupInactiveSubtaskStatus (int taskId)

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

virtual bool	createPorts ()

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
DtEmbeddedEntitiesPSR *	myProcessState

const DtEmbeddedEntitiesDescriptor *	myComponentDescriptor

DtRwEmbeddedEntityTaskState *	myEeCurrentlyProcessing

std::map< std::string, DtRwEmbeddedEntity * >	myNamedEntityMap

std::list< int >	myFaultedTasks

RemovalSignalsMap	myRemovalSignalsMap

tbb::mutex	myRemovalMutex

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

virtual void	processHostRestore (DtSimMessage *message)

static void	hostRestoreCallback (DtSimMessage message, void usrData)

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

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

Member Typedef Documentation

typedef std::map<DtUUID, boost::signals2::connection> DtEmbeddedEntitiesController::RemovalSignalsMap

protected

Constructor & Destructor Documentation

DtEmbeddedEntitiesController::DtEmbeddedEntitiesController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

virtual DtEmbeddedEntitiesController::~DtEmbeddedEntitiesController ( )

virtual

Member Function Documentation

static DtSimComponent* DtEmbeddedEntitiesController::creator	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

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

Implements DtTaskControllerComponent.

virtual bool DtEmbeddedEntitiesController::init ( )

virtual

Checks for a valid descriptor and sets up the PSR for the controller.

Reimplemented from DtMultiTaskControllerComponent.

virtual void DtEmbeddedEntitiesController::preFirstTickInit ( )

virtual

Populates myNamedEntityMap with the name-keyed contents of the descriptor. Also populates the PSR with default states for each Embedded entity configured if the PSR does not contain state information yet for that Embedded Entity. (As with newly created objects and systems that have added more Embedded Entities.)

Reimplemented from DtSimComponent.

virtual void DtEmbeddedEntitiesController::registerTaskMsgCallbacks ( )

virtual

Reimplemented from DtTaskControllerComponent.

virtual DtEmbeddedEntitiesPSR* DtEmbeddedEntitiesController::createPSR ( )

virtual

virtual void DtEmbeddedEntitiesController::clearTask ( int tskId )

virtual

Overrides DtMultiTaskControllerComponent::clearTask() ensuring that - in addition to clearing the task - DtRwEmbeddedEntityTaskState::resetToIdle() is called for whichever Embedded Entity tskId corresponds to.

Reimplemented from DtMultiTaskControllerComponent.

virtual void DtEmbeddedEntitiesController::tick ( )

virtual

Iterates through myProcessState->entityTaskStateList() calling processEmbeddedEntityCurrentlyInContext() and calling taskComplete() when applicable.

Reimplemented from DtSimComponent.

virtual void DtEmbeddedEntitiesController::processEmbeddedEntityCurrentlyInContext ( double deltaTime )

virtual

Primary processing methods for Embedded EntitiesProcesses a single Embedded Entity based on the current value of myEeCurrentlyProcessing This method should not be called from outside tick() as it relies on contextual information.

virtual bool DtEmbeddedEntitiesController::checkWithinRecoveryRange ( )

virtual

Called from within processEmbeddedEntityCurrentlyInContext() to determine if an Embedded Entity is within configured recovery range when the Embedded Entity's task state is DtWaitingToRecover. Will set the task state to DtUnable if the corresponding sim object becomes destroyed or deleted.

virtual bool DtEmbeddedEntitiesController::performDeployment ( )

virtual

Called from within processEmbeddedEntityCurrentlyInContext() when ready for deployment. Performs the actual creation of a sim object.

virtual bool DtEmbeddedEntitiesController::performRecovery ( )

virtual

Called from within processEmbeddedEntityCurrentlyInContext() when ready for recovery.

virtual bool DtEmbeddedEntitiesController::performSetForward ( )

virtual

Called from within processEmbeddedEntityCurrentlyInContext() when ready to forward a set message.

virtual bool DtEmbeddedEntitiesController::performTaskForward ( )

virtual

Called from within processEmbeddedEntityCurrentlyInContext() when ready for forward a task message.

virtual DtVector DtEmbeddedEntitiesController::calculateSpawnPosOfTarget ( )

virtual

Calculates the world position to create the Embedded Entity in context.

virtual bool DtEmbeddedEntitiesController::commandEeToReturn ( const DtString & entityName )

virtual

Sends a task to the sim object corresponding the given Embedded Entity causing it to follow this object (it's parent) at the configured relative position, thus simulating a return to base order.

virtual DtUUID DtEmbeddedEntitiesController::getObjectNameOfEmbeddedEntity	(	std::string	eeName,
		bool &	found
	)

virtual

Returns the object name of the sim object corresponding to the given Embedded Entity name, or DtString::nullString() with found==false if there is no corresponding extant object.

virtual DtRwEmbeddedEntityStatus::DtEmbeddedEntityDeploymentState DtEmbeddedEntitiesController::getStatusOfEmbeddedEntity	(	std::string	eeName,
		bool &	found
	)

virtual

Returns the deployment status corresponding to the given Embedded Entity name, or DtRwEmbeddedEntityStatus::DtUnknown with found==false if the name is not recognized.

static void DtEmbeddedEntitiesController::setForwardTaskCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

static

Static function handling set-forwarding task callbacks.

static void DtEmbeddedEntitiesController::taskForwardTaskCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

static

Static function handling task-forwarding task callbacks.

virtual void DtEmbeddedEntitiesController::processForwardTask ( DtSimMessage * msg )

virtual

Core member function handling both Set- and Task- Forwarding tasks.

static void DtEmbeddedEntitiesController::deployTaskCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

static

Static function handling deploy task callbacks.

static void DtEmbeddedEntitiesController::recoverTaskCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

static

Static function handling recover task callbacks.

virtual void DtEmbeddedEntitiesController::processTask ( DtSimMessage * msg )

virtual

Core member function handling both Deploy and Recover tasks.

virtual std::list<DtEmbeddedEntity> DtEmbeddedEntitiesController::availableEmbeddedEntities ( )

virtual

Builds a representative list of the available Embedded Entities present in the descriptor.

virtual void DtEmbeddedEntitiesController::processDeletion ( const DtSimObject * spawnedObject )

virtual

Handles keeping the PSR in sync with deletions not performed by the controller.

static void DtEmbeddedEntitiesController::hostRestoreCallback	(	DtSimMessage *	message,
		void *	usrData
	)

static

Recovers deleted and destroyed embedded entities when the host object is restored.

virtual void DtEmbeddedEntitiesController::processHostRestore ( DtSimMessage * message )

virtual

Sets the deployment state of both destroyed and deleted Embedded Entities to DtRecovered, while passing over deployed Embedded Entities that are alive. Safely callable with a null message if necessary.

virtual void DtEmbeddedEntitiesController::restoreEmbedded ( DtRwEmbeddedEntityStatus *const eeStatus )

protectedvirtual

Used by processHostRestore, handles restoration actions for a single Embedded Entity.

Member Data Documentation

DtEmbeddedEntitiesPSR* DtEmbeddedEntitiesController::myProcessState

protected

const DtEmbeddedEntitiesDescriptor* DtEmbeddedEntitiesController::myComponentDescriptor

protected

DtRwEmbeddedEntityTaskState* DtEmbeddedEntitiesController::myEeCurrentlyProcessing

protected

The task state of the Embedded Entity currently being processed All perform* methods, etc. are based off this value.

std::map<std::string, DtRwEmbeddedEntity*> DtEmbeddedEntitiesController::myNamedEntityMap

protected

A representation of myComponentDescriptor->embeddedEntities() where DtRwEmbeddedEntity::entityName() is used as a key. Created in preFirstTickInit() and used internally for code clarity.

std::list<int> DtEmbeddedEntitiesController::myFaultedTasks

protected

Holds a list of any task ids that are uncompletable and can't be bound to any given task state such that they can be discarded immediately on the following tick.

RemovalSignalsMap DtEmbeddedEntitiesController::myRemovalSignalsMap

protected

tbb::mutex DtEmbeddedEntitiesController::myRemovalMutex

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation