DtMoveToTask Class Reference

DtMoveToTask represents a moveTo task for an entity to perform. More...

Inheritance diagram for DtMoveToTask:

List of all members.

Public Member Functions
	DtMoveToTask ()
	default constructor
	DtMoveToTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtMoveToTask (const DtString &writeName, const DtMoveToTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtMoveToTask &	operator= (const DtMoveToTask &orig)
	assignment operator
virtual	~DtMoveToTask ()
virtual int	type () const
	Returns "move-to".
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this move-to task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual const DtString &	controlPtName () const
virtual void	setControlPtName (const DtString &cpName)
virtual void	setContinueFlag (bool flag)
	Give the user the option to not slow down on approach of the control point.
virtual bool	continueFlag () const
virtual int	netRepSize () const
	Returns the size of the full network representation (control object name included) padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwString	myControlPtName
DtRwBoolean	myContinueFlag

---

Detailed Description

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 DtVrfObject corresponding to this name in the Object Manager.

---

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

(

)

[virtual]

---

Member Function Documentation

const DtMoveToTask& DtMoveToTask::operator=

(

const DtMoveToTask &

orig

)

assignment operator

virtual int DtMoveToTask::type

(

)

const [virtual]

Returns "move-to".

Implements DtSimTask.

Reimplemented in DtPlanAndMoveToTask.

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

Creates a copy of this move-to task.

Implements DtSimTask.

Reimplemented in DtPlanAndMoveToTask.

virtual DtString DtMoveToTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

Reimplemented in DtPlanAndMoveToTask.

virtual const DtString& DtMoveToTask::controlPtName

(

)

const [virtual]

virtual void DtMoveToTask::setControlPtName

(

const DtString &

cpName

)

[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 usefule when the move task is just a subtask of a more complex movement task. Default is false.

virtual bool DtMoveToTask::continueFlag

(

)

const [virtual]

virtual int DtMoveToTask::netRepSize

(

)

const [virtual]

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
	)		[virtual]

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtMoveToTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtMoveToTask::creator

(

)

[static]

Reimplemented in DtPlanAndMoveToTask.

---

Member Data Documentation

DtRwString DtMoveToTask::myControlPtName [protected]

DtRwBoolean DtMoveToTask::myContinueFlag [protected]

---

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

• include/vrftasks/moveToTask.h