DtSendTextTask Class Reference

DtSendTextTask. More...

Inheritance diagram for DtSendTextTask:

List of all members.

Public Member Functions
	DtSendTextTask ()
	default constructor
	DtSendTextTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtSendTextTask (const DtString &writeName, const DtSendTextTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSendTextTask &	operator= (const DtSendTextTask &orig)
	assignment operator
virtual	~DtSendTextTask ()
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 int	netRepSize () const
	Returns the size of the full network representation.
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	setDestinationName (const DtString &objectName)
	The name of the object to which the text message will be sent.
virtual DtString	destinationName () const
	The name of the object to which the text message will be sent.
virtual void	setText (const DtString &)
	The text of the message.
virtual DtString	text () const
	The text of the message.
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwString	myDestinationName
DtRwString	myText

---

Detailed Description

DtSendTextTask.

A task instructing an entity to send a text report to another entity.

---

Constructor & Destructor Documentation

DtSendTextTask::DtSendTextTask

(

)

default constructor

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

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

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

copy constructor

virtual DtSendTextTask::~DtSendTextTask

(

)

[virtual]

---

Member Function Documentation

const DtSendTextTask& DtSendTextTask::operator=

(

const DtSendTextTask &

orig

)

assignment operator

virtual int DtSendTextTask::type

(

)

const [virtual]

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

Implements DtSimTask.

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

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtSendTextTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtSendTextTask::setDestinationName

(

const DtString &

objectName

)

[virtual]

The name of the object to which the text message will be sent.

virtual DtString DtSendTextTask::destinationName

(

)

const [virtual]

The name of the object to which the text message will be sent.

virtual void DtSendTextTask::setText

(

const DtString &

)

[virtual]

The text of the message.

virtual DtString DtSendTextTask::text

(

)

const [virtual]

The text of the message.

virtual int DtSendTextTask::netRepSize

(

)

const [virtual]

Returns the size of the full network representation.

Reimplemented from DtSimTask.

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

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtSendTextTask::setToNet

(

)

[virtual]

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

Reimplemented from DtSimTask.

static DtSimTask* DtSendTextTask::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtSendTextTask::myDestinationName [protected]

DtRwString DtSendTextTask::myText [protected]

---

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

• include/vrftasks/sendTextTask.h