DtDisaggregatedMoveToController Class Reference

Class DtDisaggregatedMoveToController is a task controller responsible for executing DtMoveToLocationTasks.

End User Description: DtDisaggregatedMoveToController models an aggregate's move-to <waypoint> behavior. The behavior is implemented by issuing a DtMoveToLocation subtask to itself. The DtAggregateMoveToLocation then executes the subtask. The task is considered complete when the move-to-location subtask completes.

Note

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

Uses Descriptor Type: DtComponentDescriptor

Inheritance diagram for DtDisaggregatedMoveToController:

Public Types
enum	DtSubtaskImplementation { DtImplementAsMoveIntoFormation = 0, DtImplementAsMoveAlongRoute, DtCloseEnough }
typedef enum DtDisaggregatedMoveToController::DtSubtaskImplementation	DtSubtaskImplementation
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 )()

Public Member Functions
	DtDisaggregatedMoveToController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtDisaggregatedMoveToController () override
virtual void	tick () override
virtual const char *	type () const override
virtual void	registerTaskMsgCallbacks () override
virtual void	clearTask () override
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtSingleTaskControllerComponent () override
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 void	suspendTask ()
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 void	clearCurrentTaskMessage ()
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 override
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const override
virtual void	disable () override
virtual void	updateImgui () override
virtual void	initializeTaskInformationStateProperty (const DtSimTaskMessageType &taskType)
virtual void	updateCurrentTaskInformationStatusProperty (const DtString &status)
virtual DtString	taskInformationStatusPropertyValue (const DtSimTaskMessageType &taskType) const
virtual DtString	currentTaskInformationStatusPropertyValue () const
virtual DtRwPropertiesStructure *	taskInformationProperty (const DtSimTaskMessageType &taskType)
virtual DtRwPropertiesStructure *	currentTaskInformationProperty ()
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtTaskControllerComponent () override
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	enable () 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 () override
virtual bool	postAddComponentsInit () override
virtual DtSimRadio *	radio ()
virtual void	enableTaskTypes ()
virtual void	enableScriptedTask (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 () override
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
virtual void	registerAttributeFunctions ()
virtual void	preFirstTickInit ()
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) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
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	debugActive () const
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) const
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 void	moveToTaskCallback (DtSimMessage *msg, void *usr)
static void	taskCompleteReportCallback (DtSimMessage *msg, void *usr)
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
DtSubtaskImplementation	chooseSubtaskImplementation (const DtVector &geocDestination) const
virtual void	moveIntoFormation (const DtVector &geocDestination)
virtual void	moveAlongRoute (const DtVector &geocDestination)
virtual bool	calcRouteStartingPoint (const DtVector &geocEndPoint, DtVector &geocStartPoint) const
virtual DtString	generateWorkingRouteName () const
virtual DtRwLocationReference	originalDestination () const
virtual double	originalTaskSpeed () const
virtual const DtSimTaskMessageType &	originalTaskType () const
virtual bool	publishFormationRoutes () const
virtual void	onWaypointMoved ()
virtual void	onMoveToTask (DtSimMessage *msg)
virtual void	onTaskComplete (DtSimMessage *msg)
virtual void	sendMoveAlongSubtask ()
virtual void	startMoveToBehavior (const DtMoveToTask &moveToTask)
virtual bool	createPSR ()
virtual bool	init () override
virtual void	clearMovementRoute ()
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 () override
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
DtSimObjectReference	myGoalObject
bool	myFirstTick
DtAggregateLocalObjectFacade	myAggregateLocalObjectFacade
DtAggregateMoveToPSR *	myProcessState
bool	myToggleGeneratedName = 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
bool	myLocalDebug
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
	DtDisaggregatedMoveToController (const DtDisaggregatedMoveToController &orig)
DtDisaggregatedMoveToController &	operator= (const DtDisaggregatedMoveToController &orig)

Additional Inherited Members
Public Attributes inherited from DtSingleTaskControllerComponent
const DtString	TaskStatusRunning = "TaskRunning"
const DtString	TaskStatusNotActive = "TaskNotActive"
Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap
typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap
typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap
typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Member Typedef Documentation

typedef enum DtDisaggregatedMoveToController::DtSubtaskImplementation DtDisaggregatedMoveToController::DtSubtaskImplementation

Member Enumeration Documentation

enum DtDisaggregatedMoveToController::DtSubtaskImplementation

Enumerator
DtImplementAsMoveIntoFormation
DtImplementAsMoveAlongRoute
DtCloseEnough

Constructor & Destructor Documentation

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

overridevirtual

DtDisaggregatedMoveToController::DtDisaggregatedMoveToController ( const DtDisaggregatedMoveToController &  orig )

private

not implemented

Member Function Documentation

virtual void DtDisaggregatedMoveToController::tick ( )

overridevirtual

This gives the thread of control to the component. The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

virtual const char* DtDisaggregatedMoveToController::type ( ) const

overridevirtual

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

DtAggregateMoveToControllerType

Implements DtTaskControllerComponent.

Reimplemented in DtDisaggregatedManeuverToController.

virtual void DtDisaggregatedMoveToController::registerTaskMsgCallbacks ( )

overridevirtual

Registers task and set data request callbacks for following type: DtMoveToType.

Reimplemented from DtTaskControllerComponent.

Reimplemented in DtDisaggregatedManeuverToController.

virtual void DtDisaggregatedMoveToController::clearTask ( )

overridevirtual

Override to call myMoveToControlPorts->cancel().

Reimplemented from DtSingleTaskControllerComponent.

static void DtDisaggregatedMoveToController::moveToTaskCallback ( DtSimMessage *  msg, void *  usr  )

static

Callback function for handling incoming turn to move to task message. Calls onTaskComplete to actually handle the message.

Parameters

msg	Message containing a DtTaskCompleteReport.

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

static

Calls onMoveToTask to process the message.

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

DtSubtaskImplementation DtDisaggregatedMoveToController::chooseSubtaskImplementation ( const DtVector &  geocDestination ) const

protected

Choose subtasking implementation. If destination is too close to current aggregate position, returns DtImplementAsMoveIntoFormation (there isn't enough space for aggregate to move to destination in formation). ' Otherwise returns DtImplementAsMoveAlongRoute (there is enough space for aggregate to be able to move to destination in formation).

Parameters

geocDestination

Destination in geocentric coordinates.

Returns

Enumeration indicating how behavior should be implemented.

virtual void DtDisaggregatedMoveToController::moveIntoFormation ( const DtVector &  geocDestination )

protectedvirtual

Move into formation at the given geocentric location, with our aggregate's current formation, and at the heading going from our current location to desired final location. Issues a DtMoveIntoFormationTask to ourself as a subtask.

Parameters

geocDestination

Location aggregate should move to, in geocentric coordinates.

virtual void DtDisaggregatedMoveToController::moveAlongRoute ( const DtVector &  geocDestination )

protectedvirtual

Move along route to the given geocentric destination. Creates a working route going to the desired location. Issues a DtMoveAlongTask to ourself as a subtask.

Parameters

geocDestination

Location aggregate should move to, in geocentric coordinates.

virtual bool DtDisaggregatedMoveToController::calcRouteStartingPoint ( const DtVector &  geocEndPoint, DtVector &  geocStartPoint  ) const

protectedvirtual

Calculate the starting point of a 2-point route that goes from current aggregate position to the given destination. Starting point is such that no member of the aggregate should have to move away from the destination to get into formation at the starting position.

Parameters

geocEndPoint	Location of route endpoint.
geocStartPoint	Starting point for route calculated in this function, in geocentric coordinates.

virtual DtString DtDisaggregatedMoveToController::generateWorkingRouteName ( ) const

protectedvirtual

Generates a working route name to be used when implementing movement as a move-along subtask.

virtual DtRwLocationReference DtDisaggregatedMoveToController::originalDestination ( ) const

protectedvirtual

Returns a location reference, either an object such as waypoint or a geocentric location.

Reimplemented in DtDisaggregatedManeuverToController.

virtual double DtDisaggregatedMoveToController::originalTaskSpeed ( ) const

protectedvirtual

Returns original task speed. 0.0 means not specified.

Reimplemented in DtDisaggregatedManeuverToController.

virtual const DtSimTaskMessageType& DtDisaggregatedMoveToController::originalTaskType ( ) const

protectedvirtual

Returns type of currentTaskMessage()->task() Could be DtSimTask::type() or DtScriptedTaskTask::type().

Reimplemented in DtDisaggregatedManeuverToController.

virtual bool DtDisaggregatedMoveToController::publishFormationRoutes ( ) const

protectedvirtual

Returns

Look up whether or not we should publish formation following routes in DtVrfSettingsManager. Returns true if setting cannot be found.

virtual void DtDisaggregatedMoveToController::onWaypointMoved ( )

protectedvirtual

Re-issues move-to-location subtask when waypoint moves.

virtual void DtDisaggregatedMoveToController::onMoveToTask ( DtSimMessage *  msg )

protectedvirtual

Unpacks incoming DtMoveToTask, calls startTask(), and then calls startMoveToBehavior.

Parameters

msg	Interface message containing a DtMoveToTask.

Reimplemented in DtDisaggregatedManeuverToController.

virtual void DtDisaggregatedMoveToController::onTaskComplete ( DtSimMessage *  msg )

protectedvirtual

If tasked() is true and report is for a DtMoveIntoFormationTask type, calls taskComplete().

Parameters

msg	Message containing a DtTaskCompleteReport.

virtual void DtDisaggregatedMoveToController::sendMoveAlongSubtask ( )

protectedvirtual

Sends either "move-along" or "maneuver-in-formation using route ID in process state repository.

Reimplemented in DtDisaggregatedManeuverToController.

virtual void DtDisaggregatedMoveToController::startMoveToBehavior ( const DtMoveToTask &  moveToTask )

protectedvirtual

Issue a DtMoveToLocation subtask to the location given by the waypoint.

virtual bool DtDisaggregatedMoveToController::createPSR ( )

protectedvirtual

Look up existing move to PSR.

virtual bool DtDisaggregatedMoveToController::init ( )

overrideprotectedvirtual

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual void DtDisaggregatedMoveToController::clearMovementRoute ( )

protectedvirtual

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

private

not implemented

Member Data Documentation

DtSimObjectReference DtDisaggregatedMoveToController::myGoalObject

protected

bool DtDisaggregatedMoveToController::myFirstTick

protected

DtAggregateLocalObjectFacade DtDisaggregatedMoveToController::myAggregateLocalObjectFacade

protected

DtAggregateMoveToPSR* DtDisaggregatedMoveToController::myProcessState

protected

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

bool DtDisaggregatedMoveToController::myToggleGeneratedName = false

mutableprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmodel/disaggregatedMoveToController.h