DtSendSetMessageTask Class Reference

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

Inheritance diagram for DtSendSetMessageTask:

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
virtual const DtSimTaskMessageType &	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.
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
	If true, this task is a subtask.
virtual bool	subtask () const
virtual char *	netRep ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtSimTask *	creator ()
	Returns a new instance of this class.
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
	Static functions.
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
	Adds a task creator member function to the task factory.
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	factory ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

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 Member Functions inherited from DtSimTask
	DtSimTask ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the write name will preface the task.
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimTask &	operator= (const DtSimTask &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.

Protected Attributes
DtRwObjectName	myObjectName
DtSetDataRequest *	mySetRequest
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
char *	myNetRep
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory

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

virtual const DtSimTaskMessageType& 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  )

protectedvirtual

Overridden to manage the contained task in the file.

Reimplemented from DtSimTask.

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

protectedvirtual

Overridden to manage the contained task in the file.

Reimplemented from DtSimTask.

Member Data Documentation

DtRwObjectName DtSendSetMessageTask::myObjectName

protected

DtSetDataRequest* DtSendSetMessageTask::mySetRequest

protected

---

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

• include/vrftasks/sendSetMessageTask.h