DtEmbarkTask Class Reference

DtEmbarkTask represents a task to a entity to embark onto a parent entity. More...

Inheritance diagram for DtEmbarkTask:

List of all members.

Public Member Functions
	DtEmbarkTask ()
	default constructor
	DtEmbarkTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtEmbarkTask (const DtString &writeName, const DtEmbarkTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtEmbarkTask &	operator= (const DtEmbarkTask &orig)
	assignment operator
virtual	~DtEmbarkTask ()
virtual int	type () const
	Override to define the type of DtEmbarkTask; types found in taskNames.h.
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual void	setParentName (const DtString &parentName)
	set parent
virtual const DtString &	parentName () const
	Get parent name.
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.
virtual void	setLoadOverride (bool b)
virtual bool	loadOverride () const
virtual void	setLoadOverridePosition (const DtVector &)
virtual const DtVector &	loadOverridePosition () const
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwString	myParentName
DtRwBoolean	myLoadOverride
DtRwVector	myLoadOverridePosition

---

Detailed Description

DtEmbarkTask represents a task to a entity to embark onto a parent entity.

---

Constructor & Destructor Documentation

DtEmbarkTask::DtEmbarkTask

(

)

default constructor

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

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

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

copy constructor

virtual DtEmbarkTask::~DtEmbarkTask

(

)

[virtual]

---

Member Function Documentation

const DtEmbarkTask& DtEmbarkTask::operator=

(

const DtEmbarkTask &

orig

)

assignment operator

virtual int DtEmbarkTask::type

(

)

const [virtual]

Override to define the type of DtEmbarkTask; types found in taskNames.h.

Implements DtSimTask.

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

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtEmbarkTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtEmbarkTask::setParentName

(

const DtString &

parentName

)

[virtual]

set parent

virtual const DtString& DtEmbarkTask::parentName

(

)

const [virtual]

Get parent name.

virtual int DtEmbarkTask::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSimTask.

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtEmbarkTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtEmbarkTask::creator

(

)

[static]

virtual void DtEmbarkTask::setLoadOverride

(

bool

b

)

[virtual]

virtual bool DtEmbarkTask::loadOverride

(

)

const [virtual]

virtual void DtEmbarkTask::setLoadOverridePosition

(

const DtVector &

)

[virtual]

virtual const DtVector& DtEmbarkTask::loadOverridePosition

(

)

const [virtual]

---

Member Data Documentation

DtRwString DtEmbarkTask::myParentName [protected]

DtRwBoolean DtEmbarkTask::myLoadOverride [protected]

DtRwVector DtEmbarkTask::myLoadOverridePosition [protected]

---

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

• include/vrftasks/embarkTask.h