DtWaitDurationTask Class Reference

DtWaitDurationTask commands an entity to wait a given duration of time. More...

Inheritance diagram for DtWaitDurationTask:

List of all members.

Public Member Functions
	DtWaitDurationTask ()
	default constructor
	DtWaitDurationTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtWaitDurationTask (const DtString &writeName, const DtWaitDurationTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtWaitDurationTask &	operator= (const DtWaitDurationTask &orig)
	assignment operator
virtual	~DtWaitDurationTask ()
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 void	setSecondsToWait (DtReal seconds)
virtual DtReal	secondsToWait () const
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 ()
Protected Attributes
DtRwReal	mySecondsToWait

---

Detailed Description

DtWaitDurationTask commands an entity to wait a given duration of time.

The length of time to wait is specified relative to the time at which the task is given. It inherits read/writableness from SimTask.

task-type: DtWaitDurationType

parameters: duration - Time to wait in seconds (a real number).

---

Constructor & Destructor Documentation

DtWaitDurationTask::DtWaitDurationTask

(

)

default constructor

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

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

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

copy constructor

virtual DtWaitDurationTask::~DtWaitDurationTask

(

)

[virtual]

---

Member Function Documentation

const DtWaitDurationTask& DtWaitDurationTask::operator=

(

const DtWaitDurationTask &

orig

)

assignment operator

virtual int DtWaitDurationTask::type

(

)

const [virtual]

Returns "wait".

Implements DtSimTask.

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

Creates a copy of this wait task.

Implements DtSimTask.

virtual DtString DtWaitDurationTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtWaitDurationTask::setSecondsToWait

(

DtReal

seconds

)

[virtual]

virtual DtReal DtWaitDurationTask::secondsToWait

(

)

const [virtual]

virtual int DtWaitDurationTask::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSimTask.

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtWaitDurationTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtWaitDurationTask::creator

(

)

[static]

---

Member Data Documentation

DtRwReal DtWaitDurationTask::mySecondsToWait [protected]

---

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

• include/vrftasks/waitDurTask.h