DtConvoyToTask Class Reference

File: ConvoyToTask.h. More...

Inheritance diagram for DtConvoyToTask:

List of all members.

Public Member Functions
	DtConvoyToTask ()
	default constructor
	DtConvoyToTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtConvoyToTask (const DtString &writeName, const DtConvoyToTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtConvoyToTask &	operator= (const DtConvoyToTask &orig)
	assignment operator
virtual	~DtConvoyToTask ()
virtual int	type () const
	Returns "convoy-to-task".
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this convoy task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual const DtString &	controlObjectName () const
virtual void	setControlObjectName (const DtString &cpName)
virtual const bool	pathPlanFlag () const
virtual void	setPathPlanFlag (const bool flag)
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	myControlObjectName
DtRwBoolean	myPathPlanFlag

---

Detailed Description

File: ConvoyToTask.h.

Class: DtConvoyTask DtConvoyToTask represents a convoy task for an aggregate to perform. It inherits read/writableness from SimTask, and includes the control point to move to.

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: DtConvoyToTaskType

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

DtConvoyToTask::DtConvoyToTask

(

)

default constructor

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

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

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

copy constructor

virtual DtConvoyToTask::~DtConvoyToTask

(

)

[virtual]

---

Member Function Documentation

const DtConvoyToTask& DtConvoyToTask::operator=

(

const DtConvoyToTask &

orig

)

assignment operator

virtual int DtConvoyToTask::type

(

)

const [virtual]

Returns "convoy-to-task".

Implements DtSimTask.

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

Creates a copy of this convoy task.

Implements DtSimTask.

virtual DtString DtConvoyToTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual const DtString& DtConvoyToTask::controlObjectName

(

)

const [virtual]

virtual void DtConvoyToTask::setControlObjectName

(

const DtString &

cpName

)

[virtual]

virtual const bool DtConvoyToTask::pathPlanFlag

(

)

const [virtual]

virtual void DtConvoyToTask::setPathPlanFlag

(

const bool

flag

)

[virtual]

virtual int DtConvoyToTask::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 DtConvoyToTask::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtConvoyToTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtConvoyToTask::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtConvoyToTask::myControlObjectName [protected]

DtRwBoolean DtConvoyToTask::myPathPlanFlag [protected]

---

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

• include/vrftasks/convoyToTask.h