DtWaitTask Class Reference

File: waitTask.h. More...

Inheritance diagram for DtWaitTask:

List of all members.

Public Member Functions
	DtWaitTask ()
	default constructor
	DtWaitTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtWaitTask (const DtString &writeName, const DtWaitTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtWaitTask &	operator= (const DtWaitTask &orig)
	assignment operator
virtual	~DtWaitTask ()
virtual int	type () const
	Returns "wait".
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this wait task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual int	netRepSize () const
	Returns the size of the full network representation 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 ()

---

Detailed Description

File: waitTask.h.

Class: DtWaitTask DtWaitTask represents a wait task for an entity to perform. It inherits read/writableness from SimTask.

DtWaitTask commands an entity to wait for an indefinite amount of time. There is no action expected on the part of the entity in executing this task. The task contains no parameters.

An entity executing a DtWaitTask will not advance to another task unless one of the following things happens:

• A trigger for the entity fires
  • The entity is retasked or set Tasked by Superior.

task-type: DtWaitType

parameters: None.

---

Constructor & Destructor Documentation

DtWaitTask::DtWaitTask

(

)

default constructor

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

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

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

copy constructor

virtual DtWaitTask::~DtWaitTask

(

)

[virtual]

---

Member Function Documentation

const DtWaitTask& DtWaitTask::operator=

(

const DtWaitTask &

orig

)

assignment operator

virtual int DtWaitTask::type

(

)

const [virtual]

Returns "wait".

Implements DtSimTask.

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

Creates a copy of this wait task.

Implements DtSimTask.

virtual DtString DtWaitTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual int DtWaitTask::netRepSize

(

)

const [virtual]

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSimTask.

virtual bool DtWaitTask::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtWaitTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtWaitTask::creator

(

)

[static]

---

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

• include/vrftasks/waitTask.h