DtConvoyAlongTask Class Reference

File: ConvoyAlongTask.h. More...

Inheritance diagram for DtConvoyAlongTask:

List of all members.

Public Member Functions
	DtConvoyAlongTask ()
	default constructor
	DtConvoyAlongTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtConvoyAlongTask (const DtString &writeName, const DtConvoyAlongTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtConvoyAlongTask &	operator= (const DtConvoyAlongTask &orig)
	assignment operator
virtual	~DtConvoyAlongTask ()
virtual int	type () const
	Returns "convoy-along-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 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

---

Detailed Description

File: ConvoyAlongTask.h.

Class: DtConvoyTask DtConvoyAlongTask 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: DtConvoyAlongTaskType

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

DtConvoyAlongTask::DtConvoyAlongTask

(

)

default constructor

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

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

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

copy constructor

virtual DtConvoyAlongTask::~DtConvoyAlongTask

(

)

[virtual]

---

Member Function Documentation

const DtConvoyAlongTask& DtConvoyAlongTask::operator=

(

const DtConvoyAlongTask &

orig

)

assignment operator

virtual int DtConvoyAlongTask::type

(

)

const [virtual]

Returns "convoy-along-task".

Implements DtSimTask.

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

Creates a copy of this convoy task.

Implements DtSimTask.

virtual DtString DtConvoyAlongTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual const DtString& DtConvoyAlongTask::controlObjectName

(

)

const [virtual]

virtual void DtConvoyAlongTask::setControlObjectName

(

const DtString &

cpName

)

[virtual]

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtConvoyAlongTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtConvoyAlongTask::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtConvoyAlongTask::myControlObjectName [protected]

---

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

• include/vrftasks/convoyAlongTask.h