VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtAggregatedMoveToController Class Reference

DtAggregatedMoveToController is a controller that models movement to a <location> or <waypoint> for aggregated entities. It also handles move into formation (at a location) and turn to heading (at the current location) tasks.

Developer Description: DtAggregatedMoveToController models move-to behavior for aggregated entities. It generates speed and heading controls that direct the entity to to its destination at the entity's current ordered speed. It responds to DtMoveToType, DtMoveToLocationTaskType, DtMoveIntoFormationTaskType and DtTurnToHeadingTask tasks. Component OPD Name: "aggregated-move-to-controller"

Uses Descriptor Type: DtAggregatedMoveToControllerDescriptor

Inheritance diagram for DtAggregatedMoveToController:
Inheritance graph
[legend]

Public Member Functions

 DtAggregatedMoveToController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtAggregatedMoveToController ()
 
virtual bool init ()
 
virtual const char * type () const
 
virtual void tick ()
 
virtual void updateTaskVisualizations ()
 
- 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 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
 
virtual DtTaskWithTaskStateListPtr topLevelTasks () const override
 
virtual void disable () 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 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 ()
 
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 ()
 
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) 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 moveToCallback (DtSimMessage *msg, void *usr)
 
static void moveToRetrogradeCallback (DtSimMessage *msg, void *usr)
 
static void setLocationCallback (DtSimMessage *msg, void *usr)
 
static void moveToLocationCallback (DtSimMessage *msg, void *usr)
 
static void moveToLocationRetrogradeCallback (DtSimMessage *msg, void *usr)
 
static void moveIntoFormationCallback (DtSimMessage *msg, void *usr)
 
static void turnToHeadingCallback (DtSimMessage *msg, void *usrData)
 
static DtSimComponent * creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
static void modifyVrfObjectCallback (DtSimMessage *msg, void *usr)
 
- 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 processMoveToTask (DtSimMessage *msg)
 
virtual void processMoveToLocationTask (DtSimMessage *msg)
 
virtual void processMoveToRetrogradeTask (DtSimMessage *msg)
 
virtual void processMoveToLocationRetrogradeTask (DtSimMessage *msg)
 
virtual void preFirstTickInit ()
 
virtual void processDestinationChanged ()
 
virtual bool setupDestination ()
 
virtual void setupDestinationVector () const
 
virtual void invalidateDestinationVector () const
 
virtual bool atDestination ()
 
virtual void doMoving ()
 
virtual double findDesiredHeading ()
 
virtual void moveToDestination ()
 
virtual void stop ()
 
virtual void registerTaskMsgCallbacks ()
 
virtual void processModifyVrfObject (DtSimMessage *msg)
 
virtual void processSetLocation (DtSimMessage *msg)
 
virtual bool createPortGroups ()
 
virtual bool createPorts ()
 
virtual bool createPSR ()
 
virtual double distanceToDestination () const
 
virtual void clearTask ()
 
virtual double atDistance () const
 
virtual void processMoveIntoFormationTask (DtSimMessage *msg)
 
virtual void processTurnToHeadingTask (DtSimMessage *msg)
 
virtual void sendRequestToSelf (const DtSetDataRequest &request) const
 
virtual void processEstimatedTotCalculation ()
 
- 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
 
DtVrfProcessStateRepository * createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 
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 myControlPoint
 
DtVector myLocalDestination
 
DtVector myWorldDestination
 
DtVector myDestinationVector
 
bool myDestinationVectorIsValid
 
bool myAtDestination
 
double myDistanceSquared
 
double myEstimatedTotValue
 
double myEstimatedTotLastCalcTime
 
const double DtEstimatedTotCalcInterval = 5.0
 
DtVector myEstimatedTotTextPos
 
DtVrfAggregateStateRepository * myAggregateStateRepository
 
DtAggregatedMoveToPSR * myProcessState
 
DtAggregatedMoveToDescriptor * myAggregatedMoveToDescriptor
 
DtSetDataManager * mySetDataManager
 
DtBooleanOutputPort * myRetrogradeOutputPort
 
Ports and Port Groups
DtAnalogOutputPort * myMovementDirectionOutputPort
 
DtAnalogOutputPort * mySpeedOutputPort
 
DtOutputPortGroup * myOutputPortGroup
 
DtVectorOutputPort * myDestinationOutputPort
 
- 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

 DtAggregatedMoveToController ()
 
 DtAggregatedMoveToController (const DtAggregatedMoveToController &orig)
 
DtAggregatedMoveToController & operator= (const DtAggregatedMoveToController &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 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

DtAggregatedMoveToController::DtAggregatedMoveToController ( )
private

Not Implemented.

DtAggregatedMoveToController::DtAggregatedMoveToController ( const DtAggregatedMoveToController &  orig)
private

Not Implemented.

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

Constructor.

virtual DtAggregatedMoveToController::~DtAggregatedMoveToController ( )
virtual

Destructor.

Member Function Documentation

DtAggregatedMoveToController& DtAggregatedMoveToController::operator= ( const DtAggregatedMoveToController &  orig)
private

Not Implemented.

virtual bool DtAggregatedMoveToController::init ( )
virtual

Init. Call immediately after construction.

Reimplemented from DtControllerComponent.

virtual const char* DtAggregatedMoveToController::type ( ) const
virtual
Returns
DtAggregatedMoveToControllerType

Implements DtTaskControllerComponent.

virtual void DtAggregatedMoveToController::tick ( )
virtual

This components simulation tick.

Reimplemented from DtSimComponent.

static void DtAggregatedMoveToController::moveToCallback ( DtSimMessage *  msg,
void *  usr 
)
static

Callback function that handles DtMoveToType tasks. Calls processMoveToTask().

Parameters
msgMessage containing DtMoveToTask.
usrPointer to an instance of this class.
static void DtAggregatedMoveToController::moveToRetrogradeCallback ( DtSimMessage *  msg,
void *  usr 
)
static
static void DtAggregatedMoveToController::setLocationCallback ( DtSimMessage *  msg,
void *  usr 
)
static

Callback function that handles DtSetLocationRequest set data requests. Calls processSetLocation().

Parameters
msgMessage containing DtSetLocationRequest.
usrPointer to an instance of this class.
static void DtAggregatedMoveToController::moveToLocationCallback ( DtSimMessage *  msg,
void *  usr 
)
static

Callback function that handles DtMoveToLocation tasks. Calls processMoveToLocationTask().

Parameters
msgMessage containing DtMoveToLocationTask.
usrPointer to an instance of this class.
static void DtAggregatedMoveToController::moveToLocationRetrogradeCallback ( DtSimMessage *  msg,
void *  usr 
)
static
static void DtAggregatedMoveToController::moveIntoFormationCallback ( DtSimMessage *  msg,
void *  usr 
)
static

Callback function that handles DtMoveIntoFormation tasks. Calls processMoveIntoFormationTask().

Parameters
msgMessage containing DtMoveIntoFormationTask.
usrPointer to an instance of this class.
static void DtAggregatedMoveToController::turnToHeadingCallback ( DtSimMessage *  msg,
void *  usrData 
)
static

Callback function that handles DtTurnToHeading tasks. Calls processTurnToHeadingTask().

Parameters
msgMessage containing DtTurnToHeadingTask.
usrPointer to an instance of this class.
static DtSimComponent* DtAggregatedMoveToController::creator ( const DtString &  name,
DtLocalObject *  owner,
DtSimulationServices *  simManager,
DtComponentDescriptor *  desc = 0,
DtReaderWriterRegistry *  parentRegistry = 0 
)
static

Static creator function for factory registration.

static void DtAggregatedMoveToController::modifyVrfObjectCallback ( DtSimMessage *  msg,
void *  usr 
)
static

Calls processModifyVrfObject.

virtual void DtAggregatedMoveToController::updateTaskVisualizations ( )
virtual

Called to update task visualizations after every tick. Implemented by subclasses.

Reimplemented from DtSimComponent.

virtual void DtAggregatedMoveToController::processMoveToTask ( DtSimMessage *  msg)
protectedvirtual

Sets world destination from the task.

Parameters
msgMessage containing a DtMoveToTask.
virtual void DtAggregatedMoveToController::processMoveToLocationTask ( DtSimMessage *  msg)
protectedvirtual
virtual void DtAggregatedMoveToController::processMoveToRetrogradeTask ( DtSimMessage *  msg)
protectedvirtual
virtual void DtAggregatedMoveToController::processMoveToLocationRetrogradeTask ( DtSimMessage *  msg)
protectedvirtual
virtual void DtAggregatedMoveToController::preFirstTickInit ( )
protectedvirtual

This function can be overridden to initialize a component before it is ticked for the first time. The implementation for this function is empty. It is called by timedTick if myFirstTick is true.

Reimplemented from DtSimComponent.

virtual void DtAggregatedMoveToController::processDestinationChanged ( )
protectedvirtual

Ensures that the destination stored in the ProcessStateRepository is consistent with the location of the destination control point. Intended to be called only when the position of the control point has changed.

Note
Also invalidates the destination vector as the world position has changed.
virtual bool DtAggregatedMoveToController::setupDestination ( )
protectedvirtual

Look up the control point by name and set the myControlPoint member to point to it. Detects changes in the target point using myControlPointLastLocation and calls processWaypointChanged().

virtual void DtAggregatedMoveToController::setupDestinationVector ( ) const
protectedvirtual

Sets up a vector from the current destination location to the entity's location to use in determining when/if the entity has passed its destination location. This is done by subtracting the DtVector representing the destination's position from the one representing the entity’s position.

Note
Users should not use this function directly,and should instead use the invalidateDestinationVector and destinationVector functions. Should be a protected or even private function, but was left public to maintain the interface.
virtual void DtAggregatedMoveToController::invalidateDestinationVector ( ) const
protectedvirtual

Tells the component that any cached destination vector should be recalculated.

virtual bool DtAggregatedMoveToController::atDestination ( )
protectedvirtual

Are we within the at-distance parameter to the destination? If the myDistanceSquared member calculated in tick() is less than or equal to the square of the value provided in the at-distance parameter of the DtGroundMoveToDescriptor, atDestination() sets myAtDestination to true. If the myDistanceSquared !<= at-distance, atDestination() sets myAtDestination to false. myAtDestination is returned to the calling function.

virtual void DtAggregatedMoveToController::doMoving ( )
protectedvirtual

Calls findDesiredHeading() and then sets port values based on those results.

virtual double DtAggregatedMoveToController::findDesiredHeading ( )
protectedvirtual

Determines the desired heading.

virtual void DtAggregatedMoveToController::moveToDestination ( )
protectedvirtual

Attempts to move to the destination location. Override to provide movement functionality.

virtual void DtAggregatedMoveToController::stop ( )
protectedvirtual

Set port values for stopping, and mark the task complete.

virtual void DtAggregatedMoveToController::registerTaskMsgCallbacks ( )
protectedvirtual

Overridden to register interest in move to messages.

Reimplemented from DtTaskControllerComponent.

virtual void DtAggregatedMoveToController::processModifyVrfObject ( DtSimMessage *  msg)
protectedvirtual

Resets the destination vector when the location of the entity to which this controller is attached is changed through a DtIfModifyVrfObject message (i.e. a drag & drop in the front-end).

virtual void DtAggregatedMoveToController::processSetLocation ( DtSimMessage *  msg)
protectedvirtual

Resets the destination vector when the location of the entity to which this controller is attached is changed through a set location request.

virtual bool DtAggregatedMoveToController::createPortGroups ( )
protectedvirtual

Creates and initializes port groups.

Reimplemented from DtSimComponent.

virtual bool DtAggregatedMoveToController::createPorts ( )
protectedvirtual

Creates myDestinationOutputPort.

Reimplemented from DtSimComponent.

virtual bool DtAggregatedMoveToController::createPSR ( )
protectedvirtual

Creates myProcessState data member, and adds it to our process state repository manager. Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual double DtAggregatedMoveToController::distanceToDestination ( ) const
protectedvirtual
virtual void DtAggregatedMoveToController::clearTask ( )
protectedvirtual

Override to deactivate myOutputPortGroup and myDestinationOutputPort.

Reimplemented from DtSingleTaskControllerComponent.

virtual double DtAggregatedMoveToController::atDistance ( ) const
protectedvirtual

Maximum distance at which entity is considered to be 'at' goal. Returns value stored in descriptor (if it exists), otherwise returns 10..

Returns
Returns maximum distance in meters from goal location that entity is considered to be 'at' the goal.
virtual void DtAggregatedMoveToController::processMoveIntoFormationTask ( DtSimMessage *  msg)
protectedvirtual

Implements turn to heading task by sending a set location and set heading request to ourself.

Parameters
msgMessage containing a DtMoveIntoFormationTask.
virtual void DtAggregatedMoveToController::processTurnToHeadingTask ( DtSimMessage *  msg)
protectedvirtual

Implements turn to heading task by sending a set heading request to ourself.

Parameters
msgMessage containing a DtTurnToHeadingTask.
virtual void DtAggregatedMoveToController::sendRequestToSelf ( const DtSetDataRequest &  request) const
protectedvirtual

Helper function that sends given set data request to ourself.

virtual void DtAggregatedMoveToController::processEstimatedTotCalculation ( )
protectedvirtual

calculate estimated tot

Member Data Documentation

DtAnalogOutputPort* DtAggregatedMoveToController::myMovementDirectionOutputPort
protected

Output Port Name: desired-movement-direction
Output Port Description: Specifies the current movement direction in radians Output Port Range:
Output Group Parent:
.

DtAnalogOutputPort* DtAggregatedMoveToController::mySpeedOutputPort
protected

Output Port Name: desired-speed
Output Port Description: Specifies the current speed of the entity in meters/second Output Port Range:
Output Group Parent:
.

DtOutputPortGroup* DtAggregatedMoveToController::myOutputPortGroup
protected

Output Group Name: movement-control
.

DtVectorOutputPort* DtAggregatedMoveToController::myDestinationOutputPort
protected

Output Port Name: destination
Output Port Description: Specifies the current destination of the entity in geocentric coordinates. Output Port Range:
Output Group Parent:
.

DtSimObjectReference DtAggregatedMoveToController::myControlPoint
protected

This is looked up once per tick - assumed unchanging while we have control.

DtVector DtAggregatedMoveToController::myLocalDestination
protected
DtVector DtAggregatedMoveToController::myWorldDestination
protected
DtVector DtAggregatedMoveToController::myDestinationVector
mutableprotected
bool DtAggregatedMoveToController::myDestinationVectorIsValid
mutableprotected
bool DtAggregatedMoveToController::myAtDestination
protected
double DtAggregatedMoveToController::myDistanceSquared
protected
double DtAggregatedMoveToController::myEstimatedTotValue
protected
double DtAggregatedMoveToController::myEstimatedTotLastCalcTime
protected
const double DtAggregatedMoveToController::DtEstimatedTotCalcInterval = 5.0
protected

Interval for estimated tot calculations.

DtVector DtAggregatedMoveToController::myEstimatedTotTextPos
protected

tot text position

DtVrfAggregateStateRepository* DtAggregatedMoveToController::myAggregateStateRepository
protected
DtAggregatedMoveToPSR* DtAggregatedMoveToController::myProcessState
protected

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

DtAggregatedMoveToDescriptor* DtAggregatedMoveToController::myAggregatedMoveToDescriptor
protected
DtSetDataManager* DtAggregatedMoveToController::mySetDataManager
protected

Pointer to aggregate's DtSetDataManager, cached in this class for convenience.

DtBooleanOutputPort* DtAggregatedMoveToController::myRetrogradeOutputPort
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)