DtAggregatedMoveAlongController Class Reference

End User Description: Controller for executing DtMoveAlongTask for aggregated aggregates. This moves the aggregate along a route. Uses Descriptor Type: DtComponentDescriptor.

Inheritance diagram for DtAggregatedMoveAlongController:

Public Member Functions
	DtAggregatedMoveAlongController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtAggregatedMoveAlongController ()
virtual bool	init ()
virtual const char *	type () const
virtual void	preFirstTickInit ()
virtual void	tick ()
virtual void	processRouteChanged (DtSimObjectReference obj)
virtual void	registerTaskMsgCallbacks ()
virtual bool	setupRoute ()
virtual bool	setupDestination ()
virtual double	findDesiredSpeed ()
virtual void	stop ()
virtual bool	createPorts ()
virtual bool	createPortGroups ()
virtual bool	createPSR ()
virtual void	doMoving ()
virtual double	findDesiredHeading (DtVector &dest)
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSingleTaskControllerComponent ()
virtual void	postTick ()
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
virtual void	taskNotify (const DtSimTask &task)
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 void	clearCurrentTaskMessage ()
virtual DtTaskMessage *	currentTaskMessage () 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	disable ()
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtTaskControllerComponent ()
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio)
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 ()
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
virtual bool	taskVisualizationsActive () const
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 ()
virtual DtSimRadio *	radio ()
virtual void	enableTaskTypes ()
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)
virtual double	minTickPeriod () const
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
virtual double	minTickPeriodVariance () const
virtual void	setNextTickTime (double nextTickTime)
virtual double	nextTickTime () const
virtual double	calculateNextTickTime () const
virtual double	calculateFirstTickTime () const
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 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	wasUpdatedSince (DtTime t) 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	moveAlongCallback (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskStatePtr)
static void	moveAlongRetrogradeCallback (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskStatePtr)
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskState)
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual void	processMoveAlong (const DtTaskMessage &msg, DtSimTaskStatePtr taskStatePtr)
virtual void	processMoveAlongRetrograde (const DtTaskMessage &msg, DtSimTaskStatePtr taskStatePtr)
virtual void	emptyVertexList ()
virtual void	clearTask ()
virtual void	moveToDestination ()
virtual double	distanceToDestinationSquared () const
virtual bool	atDestination ()
virtual bool	passedDestination ()
virtual bool	getDestination (DtVector &destination)
virtual DtVector	destinationVector () const
virtual double	atDistance () const
virtual bool	stayOnRoute () const
virtual double	minCorrectionDistance () const
virtual double	maxCorrectionDistance () const
virtual double	correctionAngle (const double distanceFromLine) const
virtual void	computePointToSegmentGeometry (const DtVector &localPoint, const DtVector &localLinePt1, const DtVector &localLinePt2, const Coordinate_System &coordinateSystemRef, double &r, bool &leftSide, double &distanceToSegment)
virtual bool	getCurrentRouteSegment (DtVector &routeSegmentStart, DtVector &routeSegmentEnd) const
DtSimTaskStatePtr	currentTaskState () const
virtual void	calculateRadius ()
const Coordinate_System *	localCS () const
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 double	computeCurrentTime ()
bool	testInvariant () const
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
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
Ports and Port Groups
DtOutputPortGroup *	myMovementControlPortGroup
DtAnalogOutputPort *	mySpeedPort
DtAnalogOutputPort *	myMovementDirectionPort
DtVectorOutputPort *	myDestinationOutputPort
DtVrfAggregateStateRepository *	myTrueAggregateRepository
DtAggregatedMoveAlongPSR *	myProcessState
bool	myRouteHasChanged
bool	myResetVertex
DtVector	myLocalDestination
DtVector	myWorldDestination
double	myUnitRadius
DtAggregatedMoveToDescriptor *	myAggregatedMoveToDescriptor
DtBooleanOutputPort *	myRetrogradeOutputPort
bool	myNeedsObjectDiscovery
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	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
bool	myTickEveryFrame
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager	myPredicateCallbackManager
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
	DtAggregatedMoveAlongController ()
	DtAggregatedMoveAlongController (const DtAggregatedMoveAlongController &orig)
DtAggregatedMoveAlongController &	operator= (const DtAggregatedMoveAlongController &orig)

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::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

DtAggregatedMoveAlongController::DtAggregatedMoveAlongController ( )

private

Not Implemented.

DtAggregatedMoveAlongController::DtAggregatedMoveAlongController ( const DtAggregatedMoveAlongController &  orig )

private

Not Implemented.

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

Constructor.

virtual DtAggregatedMoveAlongController::~DtAggregatedMoveAlongController ( )

virtual

Destructor.

Member Function Documentation

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

private

Not Implemented.

virtual bool DtAggregatedMoveAlongController::init ( )

virtual

Init. Call immediately after construction.

Reimplemented from DtControllerComponent.

virtual const char* DtAggregatedMoveAlongController::type ( ) const

virtual

Returns DtAggregatedMoveAlongControllerType.

Implements DtTaskControllerComponent.

virtual void DtAggregatedMoveAlongController::preFirstTickInit ( )

virtual

If the entity is tasked and the route exists, a vertices changed callback is added to it. Otherwise, an object added callback is added for objectAddedCb.

Reimplemented from DtSimComponent.

virtual void DtAggregatedMoveAlongController::tick ( )

virtual

This components simulation tick.

Reimplemented from DtSimComponent.

virtual void DtAggregatedMoveAlongController::processRouteChanged ( DtSimObjectReference  obj )

virtual

Intended to be called only when the route has changed.

Note

Also invalidates the destination vector as the world position has changed.

virtual void DtAggregatedMoveAlongController::registerTaskMsgCallbacks ( )

virtual

Overrides this so it can register it's interest in MoveAlong commands.

Reimplemented from DtTaskControllerComponent.

static void DtAggregatedMoveAlongController::moveAlongCallback ( DtSimMessage *  msg, void *  usr, DtSimTaskStatePtr  taskStatePtr  )

static

static void DtAggregatedMoveAlongController::moveAlongRetrogradeCallback ( DtSimMessage *  msg, void *  usr, DtSimTaskStatePtr  taskStatePtr  )

static

virtual bool DtAggregatedMoveAlongController::setupRoute ( )

virtual

Look up the route by name, and set myRoute if found. Looks up the route in the Control Manager. If it does not find the route, it returns false. Otherwise, it sets the myRoute member to point to the object found. setupRoute() then checks the myRouteChanged flag. If myRouteChanged is true, it calls the route object’s resyncRouteState() member function to update the current DtRouteState. setupRoute() then returns true.

virtual bool DtAggregatedMoveAlongController::setupDestination ( )

virtual

Sets myControlPoint to the position of the route's current vertex. If setupRoute() returns false, setupControlPoint() calls taskComplete() and returns false. Otherwise, it sets the position of the myControlPoint member variable to the position of myRoute’s current vertex. If myRouteHasChanged is true, setupGoalVector() is called, and myRouteHasChanged is set to false. true is then returned.

virtual double DtAggregatedMoveAlongController::findDesiredSpeed ( )

virtual

Returns ordered speed of the entity.

virtual void DtAggregatedMoveAlongController::stop ( )

virtual

Overrides to advance to the next vertex rather then actually stop when a vertex is reached. Checks to see if the entity is currently moving to the last vertex in the route. If so, DtGroundMoveToControllerComponent::stop() is called. Otherwise, myProcessState->routeState()->next() is called, followed by setupControlPoint() and setupGoalVector().

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

static

Static creator function for factory registration.

virtual bool DtAggregatedMoveAlongController::createPorts ( )

virtual

Creates myDestinationOutputPort.

Reimplemented from DtSimComponent.

virtual bool DtAggregatedMoveAlongController::createPortGroups ( )

virtual

Creates and initializes port groups.

Reimplemented from DtSimComponent.

virtual bool DtAggregatedMoveAlongController::createPSR ( )

virtual

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

virtual void DtAggregatedMoveAlongController::doMoving ( )

virtual

Sets myUnitRadius. Calls determineGearSetting(), findDesiredSpeed() and findDesiredHeading() and then sets port values based on those results.

virtual double DtAggregatedMoveAlongController::findDesiredHeading ( DtVector &  dest )

virtual

Calls headingAngleTo() to find the heading from the entity to the destination.

Parameters

dest	Set to the point on the route toward which the entity is heading, assuming it is off route and heading toward the route line. This is intended to keep the entity from overshooting the line in one tick.

virtual void DtAggregatedMoveAlongController::processMoveAlong ( const DtTaskMessage &  msg, DtSimTaskStatePtr  taskStatePtr  )

protectedvirtual

const DtVector& localDestination) const;

virtual void DtAggregatedMoveAlongController::processMoveAlongRetrograde ( const DtTaskMessage &  msg, DtSimTaskStatePtr  taskStatePtr  )

protectedvirtual

virtual void DtAggregatedMoveAlongController::emptyVertexList ( )

protectedvirtual

removes and deletes vertices from the vertex list in process state repository (calls process state repository's emptyRouteVertices()).

virtual void DtAggregatedMoveAlongController::clearTask ( )

protectedvirtual

Override to clear route name and route state data stored in myProcessState.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtAggregatedMoveAlongController::moveToDestination ( )

protectedvirtual

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

virtual double DtAggregatedMoveAlongController::distanceToDestinationSquared ( ) const

protectedvirtual

Returns the SQUARE of the distance from the entity to the next route point (the point it is currently heading towards). Horizontal distance, not 3D.

virtual bool DtAggregatedMoveAlongController::atDestination ( )

protectedvirtual

Are we within the at-distance parameter to the destination? If the distanceToDestinationSquared 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 distanceToDestinationSquared !<= at-distance, atDestination() sets myAtDestination to false. myAtDestination is returned to the calling function.

virtual bool DtAggregatedMoveAlongController::passedDestination ( )

protectedvirtual

Determines if the entity is passed its destination point. It calculates the vector that points from the entity to the destination It finds the dot product between this vector and destination vector, If that dot product is greater than 0.0, the entity will pass the destination this tick if it does not stop. myPassedDestination is set, and the value is returned to the calling function.

virtual bool DtAggregatedMoveAlongController::getDestination ( DtVector &  destination )

protectedvirtual

getDestination()

Parameters

destination

the position this object is trying to drive to in local coordinates.

Returns

true if it has a valid destination () or false if it is unable to determine it's destination.

Note

Used by other areas of the simulation to determine where this object is going. (Information)

virtual DtVector DtAggregatedMoveAlongController::destinationVector ( ) const

protectedvirtual

Returns the current destination vector for the entity.

virtual double DtAggregatedMoveAlongController::atDistance ( ) const

protectedvirtual

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

Returns

Returns maximum distance in meters from route vertex that entity is considered to be 'at' the vertex.

virtual bool DtAggregatedMoveAlongController::stayOnRoute ( ) const

protectedvirtual

If true, will attempt to closely follow route segments as it moves along a route. If false, will only move directly toward the next route point. In this implementation, it always returns true.

Returns

Flag indicating whether or entity will attempt to closely follow route segments.

virtual double DtAggregatedMoveAlongController::minCorrectionDistance ( ) const

protectedvirtual

Returns

Minimum distance from route that entity will attempt to correct heading to stay on route segment. If entity is within this distance from route segment, it will move directly toward the next waypoint. In meters.

virtual double DtAggregatedMoveAlongController::maxCorrectionDistance ( ) const

protectedvirtual

Returns

Maximum distance from route that entity will attempt to correct heading to stay on route segment. If entity is within the min-correction-distance and max-correction-distance from the route segment, it will correct its heading toward the next waypoint in such a way that it 'pulls' the entity closer to the route as it travels. If distance from route segment is greater than this threshold, it will move directly toward the next waypoint. In meters.

virtual double DtAggregatedMoveAlongController::correctionAngle ( const double  distanceFromLine ) const

protectedvirtual

Returns

Absolute angular correction entity will make to attempt to move the entity closer to the route segment. In radians. Default is ~45 degrees.

virtual void DtAggregatedMoveAlongController::computePointToSegmentGeometry ( const DtVector &  localPoint, const DtVector &  localLinePt1, const DtVector &  localLinePt2, const Coordinate_System &  coordinateSystemRef, double &  r, bool &  leftSide, double &  distanceToSegment  )

protectedvirtual

Computes information about where the localPoint is relative to the route segment defined by localLinePt1 and localLinePt2.

Returns

r, a parameter indicating the position of the projection of localPoint onto the line segment. r = 0 at localLinePt1 and increases to 1.0 at localLinePt2.

leftSide, which is true if localPoint is to the left of the segment.

distanceToSegment, which is the shortest distance from localPoint to the segment.

virtual bool DtAggregatedMoveAlongController::getCurrentRouteSegment ( DtVector &  routeSegmentStart, DtVector &  routeSegmentEnd  ) const

protectedvirtual

Returns

True if we are currently moving along a route segment, false otherwise.

Parameters

routeSegmentStart	Starting point of route segment in local coordinates.
routeSegmentEnd	End point of route segment in local coordinates.

DtSimTaskStatePtr DtAggregatedMoveAlongController::currentTaskState ( ) const

protectedvirtual

Returns

Current execution state of the task. At the base class level, returns 0. Derived classes that have tasks with DtTaskState (data associated with execution of the task) may return a new DtTaskState instance, filled out with the appropriate information about the current task execution state. Task controllers that do not need to return task state do not need to override this function.

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtAggregatedMoveAlongController::calculateRadius ( )

protectedvirtual

Calculates the units radius (footprint) used for at distance.

const Coordinate_System* DtAggregatedMoveAlongController::localCS ( ) const

protected

Member Data Documentation

DtOutputPortGroup* DtAggregatedMoveAlongController::myMovementControlPortGroup

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

DtAnalogOutputPort* DtAggregatedMoveAlongController::mySpeedPort

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

DtAnalogOutputPort* DtAggregatedMoveAlongController::myMovementDirectionPort

protected

Output Port Name: desired-movement-direction
Output Port Description:
Output Port Range:
Output Group Parent: movement-control
.

DtVectorOutputPort* DtAggregatedMoveAlongController::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:
.

DtVrfAggregateStateRepository* DtAggregatedMoveAlongController::myTrueAggregateRepository

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

DtAggregatedMoveAlongPSR* DtAggregatedMoveAlongController::myProcessState

protected

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

bool DtAggregatedMoveAlongController::myRouteHasChanged

protected

This gets set to true when a modifyRoute message for the route we're following is received.

bool DtAggregatedMoveAlongController::myResetVertex

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

DtVector DtAggregatedMoveAlongController::myLocalDestination

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

DtVector DtAggregatedMoveAlongController::myWorldDestination

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

double DtAggregatedMoveAlongController::myUnitRadius

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

DtAggregatedMoveToDescriptor* DtAggregatedMoveAlongController::myAggregatedMoveToDescriptor

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

DtBooleanOutputPort* DtAggregatedMoveAlongController::myRetrogradeOutputPort

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

bool DtAggregatedMoveAlongController::myNeedsObjectDiscovery

protected

Output Port Name: desired-speed
Output Port Description: Output Port Range:
Output Group Parent: movement-control
.

---

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

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