DtSendSetMessageTask Class Reference

A task to send a set message to another entity though the radio. More...

Inheritance diagram for DtSendSetMessageTask:

List of all members.

Public Member Functions
	DtSendSetMessageTask ()
	Default constructor.
	DtSendSetMessageTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtSendSetMessageTask (const DtString &writeName, const DtSendSetMessageTask &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtSendSetMessageTask ()
	destructor
DtSendSetMessageTask &	operator= (const DtSendSetMessageTask &orig)
	assignment operator
int	type () const
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual const DtSetDataRequest *	setRequest () const
	The set contained by the task.
virtual void	setSetRequest (const DtSetDataRequest *task)
	Sets the set for this task. The set will be cloned.
virtual DtString	stringRep () const
	Text representation of this task.
virtual int	netRepSize () const
	Returns the size in bytes of the network representation of the class.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).
virtual bool	setToNet ()
	Calls netRep() to create the network buffer.
virtual DtString	objectName () const
	Name of the object to send the set request to.
virtual void	setObjectName (const DtString &name)
	Name of the object to send the set request to.
Static Public Member Functions
static DtSimTask *	creator ()
	Returns a new instance of this class.
Protected Member Functions
virtual void	putData (FILE *fp, int indentLevel=0)
	Overridden to manage the contained task in the file.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Overridden to manage the contained task in the file.
Protected Attributes
DtRwString	myObjectName
DtSetDataRequest *	mySetRequest

---

Detailed Description

A task to send a set message to another entity though the radio.

An entity receiving this task will send a set message containing the set indicated in this task.

---

Constructor & Destructor Documentation

DtSendSetMessageTask::DtSendSetMessageTask

(

)

Default constructor.

DtSendSetMessageTask::DtSendSetMessageTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Usual constructor.

DtSendSetMessageTask::DtSendSetMessageTask	(	const DtString &	writeName,
		const DtSendSetMessageTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtSendSetMessageTask::~DtSendSetMessageTask

(

)

[virtual]

destructor

---

Member Function Documentation

DtSendSetMessageTask& DtSendSetMessageTask::operator=

(

const DtSendSetMessageTask &

orig

)

assignment operator

int DtSendSetMessageTask::type

(

)

const [virtual]

Returns:

DtSendSetMessageTaskType.

Implements DtSimTask.

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

Returns:

A new instance of this class, copied from the original.

Implements DtSimTask.

virtual DtString DtSendSetMessageTask::objectName

(

)

const [virtual]

Name of the object to send the set request to.

This name may be DtBroadcast, in which case this set request will be sent to every entity that is addressable though the radio.

virtual void DtSendSetMessageTask::setObjectName

(

const DtString &

name

)

[virtual]

Name of the object to send the set request to.

This name may be DtBroadcast, in which case this set request will be sent to every entity that is addressable though the radio.

virtual const DtSetDataRequest* DtSendSetMessageTask::setRequest

(

)

const [virtual]

The set contained by the task.

virtual void DtSendSetMessageTask::setSetRequest

(

const DtSetDataRequest *

task

)

[virtual]

Sets the set for this task. The set will be cloned.

virtual DtString DtSendSetMessageTask::stringRep

(

)

const [virtual]

Text representation of this task.

Implements DtSimTask.

virtual int DtSendSetMessageTask::netRepSize

(

)

const [virtual]

Returns the size in bytes of the network representation of the class.

This is the size in bytes of the DtNetSimTask structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimTask.

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

Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).

Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimTask::netRepSize().

Reimplemented from DtSimTask.

virtual bool DtSendSetMessageTask::setToNet

(

)

[virtual]

Calls netRep() to create the network buffer.

Casts the resulting myNetRep to type DtNetSimTask*, and then sets the mySubtask member in the DtNetSimTask from mySubtask. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimTask::netRepSize().

Reimplemented from DtSimTask.

static DtSimTask* DtSendSetMessageTask::creator

(

)

[static]

Returns a new instance of this class.

virtual void DtSendSetMessageTask::putData	(	FILE *	fp,
		int	indentLevel = 0
	)		[protected, virtual]

Overridden to manage the contained task in the file.

Reimplemented from DtSimTask.

virtual DtlObjPtr DtSendSetMessageTask::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[protected, virtual]

Overridden to manage the contained task in the file.

Reimplemented from DtSimTask.

---

Member Data Documentation

DtRwString DtSendSetMessageTask::myObjectName [protected]

DtSetDataRequest* DtSendSetMessageTask::mySetRequest [protected]

---

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

• include/vrftasks/sendSetMessageTask.h