DtMoveToTask represents a moveTo task for an entity to perform. It inherits read/writableness from SimTask, and includes the control point to move to.

Both individual and pseudo-aggregate entities can receive this task. Individual vehicles stop when they reach the waypoint. For a pseudo-aggregate, the task is considered to be complete when the lead subordinate reaches the waypoint.

task-type: DtMoveToType

parameters: control point name - The string name of the control point to move toward. You can look up the DtSimObject corresponding to this name in the Object Manager.

Related Examples

Inheritance diagram for DtMoveToTask:

[legend]

Public Member Functions
	DtMoveToTask ()

	DtMoveToTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)

	DtMoveToTask (const DtString &writeName, const DtMoveToTask &orig, DtReaderWriterRegistry *parentRegistry=0)

const DtMoveToTask &	operator= (const DtMoveToTask &orig)

virtual	~DtMoveToTask () override

virtual const DtSimTaskMessageType &	type () const override

virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const override

virtual DtString	stringRep () const override

virtual bool	controlPointIsObject () const

virtual const DtRwLocationReference &	controlPoint () const

virtual void	setControlPoint (const DtRwLocationReference &)

virtual void	setControlPoint (const DtUUID &)

virtual void	setControlPoint (const DtVector &)

virtual DtVector	aimingPoint () const

virtual void	setAimingPoint (const DtVector &point)

virtual void	setContinueFlag (bool flag)

virtual bool	continueFlag () const

virtual void	setFinalSpeed (const double s)

virtual double	finalSpeed () const

virtual bool	isFinalSpeedSpecified () const

virtual int	netRepSize () const override

virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override

virtual bool	setToNet () override

virtual bool	isOneClick () const override


virtual void	setAtDistance (double v)

virtual double	atDistance () const

virtual bool	isAtDistanceSpecified () const


virtual void	setSpeed (double v)

virtual double	speed () const

virtual bool	isSpeedSpecified () const

Public Member Functions inherited from DtSimTask
virtual	~DtSimTask () override

virtual bool	init ()

virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)

virtual void	setSubtask (bool flag)

virtual bool	subtask () const

virtual void	setAllowTaskVisualizations (bool flag)

virtual bool	allowTaskVisualizations () const

virtual void	putData (std::string &fp, int indentLevel=0) override

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

virtual char *	netRep ()

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 DtSimTask *	creator ()

Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)

static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)

static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)

static void	setFactory (DtSimTaskFactory *factory)

static DtSimTaskFactory *	factory ()

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 Attributes
DtRwLocationReference	myControlPoint

DtRwBoolean	myContinueFlag

DtRwReal	myFinalSpeed

DtRwReal	mySpeed

DtRwReal	myAtDistance

Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask

DtRwBoolean	myAllowTaskVisualizations

char *	myNetRep

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

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 Member Functions inherited from DtSimTask
	DtSimTask ()

	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)

	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)

const DtSimTask &	operator= (const DtSimTask &orig)

virtual char *	createNetworkBuffer ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	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

DtMoveToTask::DtMoveToTask ( )

default constructor

DtMoveToTask::DtMoveToTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor If you have a task 'put' itself, the writeName will preface the task.

DtMoveToTask::DtMoveToTask	(	const DtString &	writeName,
		const DtMoveToTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

virtual DtMoveToTask::~DtMoveToTask ( )

overridevirtual

Member Function Documentation

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

assignment operator

virtual const DtSimTaskMessageType& DtMoveToTask::type ( ) const

overridevirtual

Returns "move-to".

Implements DtSimTask.

Reimplemented in DtMoveToDirectTask, DtMoveToRetrogradeTask, and DtPlanAndMoveToTask.

virtual DtSimTask* DtMoveToTask::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

overridevirtual

Creates a copy of this move-to task.

Implements DtSimTask.

Reimplemented in DtMoveToDirectTask, DtMoveToRetrogradeTask, and DtPlanAndMoveToTask.

virtual DtString DtMoveToTask::stringRep ( ) const

overridevirtual

Get a readable string representation of this task.

Implements DtSimTask.

Reimplemented in DtMoveToDirectTask, DtMoveToRetrogradeTask, and DtPlanAndMoveToTask.

virtual bool DtMoveToTask::controlPointIsObject ( ) const

virtual

Returns true if the location reference references an object instead of an absolute location.

virtual const DtRwLocationReference& DtMoveToTask::controlPoint ( ) const

virtual

Was: controlPtName.

virtual void DtMoveToTask::setControlPoint ( const DtRwLocationReference & )

virtual

Was: setControlPtName.

virtual void DtMoveToTask::setControlPoint ( const DtUUID & )

virtual

virtual void DtMoveToTask::setControlPoint ( const DtVector & )

virtual

virtual DtVector DtMoveToTask::aimingPoint ( ) const

virtual

virtual void DtMoveToTask::setAimingPoint ( const DtVector & point )

virtual

virtual void DtMoveToTask::setContinueFlag ( bool flag )

virtual

Give the user the option to not slow down on approach of the control point. This is useful when the user wants the entity to keep moving once it reaches the point, especially useful when the move task is just a subtask of a more complex movement task.

Note: this functionality is not implemented for all entity types.

virtual bool DtMoveToTask::continueFlag ( ) const

virtual

virtual void DtMoveToTask::setFinalSpeed ( const double s )

virtual

If the entity is to continue, ie the continueFlag is set, then this is the speed to use at the end of the move. If the continue flag is specified, but this value is not specified, then the move task will use the task or ordered speed.

Note: this functionality is not implemented for all entity types.

virtual double DtMoveToTask::finalSpeed ( ) const

virtual

virtual bool DtMoveToTask::isFinalSpeedSpecified ( ) const

virtual

virtual void DtMoveToTask::setAtDistance ( double v )

virtual

Indicates the maximum distance from the destination that is considered to be "at the destination." If specified, this will override the default configured for the entity during this task only.

Note: this functionality is not implemented for all entity types.

virtual double DtMoveToTask::atDistance ( ) const

virtual

Indicates the maximum distance from the destination that is considered to be "at the destination." If specified, this will override the default configured for the entity during this task only.

Note: this functionality is not implemented for all entity types.

virtual bool DtMoveToTask::isAtDistanceSpecified ( ) const

virtual

Indicates the maximum distance from the destination that is considered to be "at the destination." If specified, this will override the default configured for the entity during this task only.

Note: this functionality is not implemented for all entity types.

virtual void DtMoveToTask::setSpeed ( double v )

virtual

Indicates the speed at which the entity should attempt to move. If specified, this will override the ordered speed of the entity during this task only.

Note: this functionality is not implemented for all entity types.

virtual double DtMoveToTask::speed ( ) const

virtual

Indicates the speed at which the entity should attempt to move. If specified, this will override the ordered speed of the entity during this task only.

Note: this functionality is not implemented for all entity types.

virtual bool DtMoveToTask::isSpeedSpecified ( ) const

virtual

Indicates the speed at which the entity should attempt to move. If specified, this will override the ordered speed of the entity during this task only.

Note: this functionality is not implemented for all entity types.

virtual int DtMoveToTask::netRepSize ( ) const

overridevirtual

Returns the size of the full network representation (control object name included) padded to an 8-byte boundary.

Reimplemented from DtSimTask.

virtual bool DtMoveToTask::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)

overridevirtual

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtMoveToTask::setToNet ( )

overridevirtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSimTask.

static DtSimTask* DtMoveToTask::creator ( )

static

virtual bool DtMoveToTask::isOneClick ( ) const

inlineoverridevirtual

If this is true this task supports one click execution. By default this is false.

Reimplemented from DtSimTask.

Member Data Documentation

DtRwLocationReference DtMoveToTask::myControlPoint

protected

DtRwBoolean DtMoveToTask::myContinueFlag

protected

DtRwReal DtMoveToTask::myFinalSpeed

protected

DtRwReal DtMoveToTask::mySpeed

protected

DtRwReal DtMoveToTask::myAtDistance

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrftasks/moveToTask.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation