DtSetDataRequestMessage Class Reference

A DtSetDataRequestMessage is a DtRadioMsg with a pointer to a setDataRequest. More...

Inheritance diagram for DtSetDataRequestMessage:

Public Member Functions
	DtSetDataRequestMessage ()
	default constructor
	DtSetDataRequestMessage (const DtSetDataRequestMessage &orig)
virtual	~DtSetDataRequestMessage ()
	destructor
virtual DtSetDataRequest *	setDataRequest () const
	Returns a pointer to the DtSetDataRequest object in the message.
virtual void	setSetDataRequest (DtSetDataRequest *request)
	N.B.
virtual int	contentCategoryType () const
	The radioMessageType() for this kind of message is “set-data-request” (DtSetDataRequestMessageType).
virtual const DtSetMessageType &	contentType () const
virtual DtSimMessage *	clone () const
	Required override. Clones itself and the setDataRequest it points to.
virtual int	netRepSize () const
	Overrides the base class DtVrfObjectMessage netRepSize().
virtual bool	setFromNet (const char *networkBuffer, unsigned contentSize)
	Extracts the task type, creates the task (using the task factory), and then tells the task to fill itself in from the network buffer.
virtual bool	setToNet ()
	Fill in our task type, tell the task to fill itself out, and then copy its buffer into ours.
virtual void	printDataToString (DtString &str)
	Print message.
Public Member Functions inherited from DtVrfObjectMessage
	DtVrfObjectMessage ()
	default constructor
	DtVrfObjectMessage (const DtVrfObjectMessage &orig)
	copy constructor: shallow; copies values only.
const DtVrfObjectMessage &	operator= (const DtVrfObjectMessage &orig)
	assignment operator: shallow; assigns values only.
virtual	~DtVrfObjectMessage ()
	destructor
virtual int	messageType () const
virtual int	radioMessageType () const
virtual char *	netRep ()
	Returns a pointer to the simulation network representation of this message.
virtual int	scenarioRunId () const
	If used, the scenario run id of the scenario that sent this message.
virtual void	setScenarioRunId (int)
virtual void	setReceiver (const DtUUID &receiver)
	Note that sending/receiving by echelon id is no longer supported.
virtual const DtUUID &	receiver () const
virtual void	setRecipient (const DtUUID &receiver)
virtual const DtUUID &	recipient () const
virtual void	setTransmitter (const DtUUID &transmitter)
	Note that sending/receiving by echelon id is no longer supported.
virtual const DtUUID &	transmitter () const
virtual void	setSender (const DtUUID &transmitter)
virtual const DtUUID &	sender () const
Public Member Functions inherited from DtSimMessage
	DtSimMessage ()
	default constructor
	DtSimMessage (const DtSimMessage &orig)
	copy constructor
const DtSimMessage &	operator= (const DtSimMessage &orig)
	assignment operator
virtual	~DtSimMessage ()
	destructor
virtual std::string	debugText () const
	Leak detector output.

Static Public Member Functions
static DtVrfObjectMessage *	creator ()
Static Public Member Functions inherited from DtVrfObjectMessage
static DtVrfObjectMessage *	createVrfObjectMessage (int type)
	Creates a new DtVrfObjectMessage subclass using the static factory.
static DtVrfObjectMessage *	createRadioMessage (int type)
static void	addVrfObjectMessageCreatorFcn (int type, DtVrfObjectMessageCreatorFcn fcn)
	Adds a new creator function to the DtVrfObjectMessageFactory.
static void	addRadioMessageCreatorFcn (int type, DtVrfObjectMessageCreatorFcn fcn)
static void	setFactory (DtVrfObjectMessageFactory *factory)
static DtVrfObjectMessageFactory *	factory ()

Protected Member Functions
const DtSetDataRequestMessage &	operator= (DtSetDataRequestMessage &orig)
Protected Member Functions inherited from DtVrfObjectMessage
virtual char *	createNetworkBuffer ()

Protected Attributes
DtSetDataRequest *	mySetDataRequest
bool	myOwnSetDataRequest
Protected Attributes inherited from DtVrfObjectMessage
DtUUID	myTransmitter
DtUUID	myReceiver
char *	myNetRep
int	myScenarioRunId

Additional Inherited Members
Static Protected Attributes inherited from DtVrfObjectMessage
static DtVrfObjectMessageFactory *	myFactory

Detailed Description

A DtSetDataRequestMessage is a DtRadioMsg with a pointer to a setDataRequest.

The type of the DtSetDataRequestMessage is just the type of the setDataRequest. Classes derived from DtSetDataRequest are used to implement the messages for setting parameters, such as location. DtSetDataRequestMessages are sent to entities by their superiors, by Set statements in a DtPlan, and by the user from the GUI.

Constructor & Destructor Documentation

DtSetDataRequestMessage::DtSetDataRequestMessage

(

)

default constructor

DtSetDataRequestMessage::DtSetDataRequestMessage

(

const DtSetDataRequestMessage &

orig

)

virtual DtSetDataRequestMessage::~DtSetDataRequestMessage ( )

virtual

destructor

Member Function Documentation

const DtSetDataRequestMessage& DtSetDataRequestMessage::operator= ( DtSetDataRequestMessage &  orig )

protected

virtual DtSetDataRequest* DtSetDataRequestMessage::setDataRequest ( ) const

virtual

Returns a pointer to the DtSetDataRequest object in the message.

virtual void DtSetDataRequestMessage::setSetDataRequest ( DtSetDataRequest *  request )

virtual

N.B.

: This function USED TO clone the request passed as an argument. However, for performance reasons, it has been modified to just keep a pointer to the request. This means that it is the caller's responsibility to ensure that the lifetime of the request goes beyond the lifetime of the message. For example, this previously acceptable code will now FAIL:

DtSetDataRequest* request = new DtSetHeadingRequest; DtSetDataRequestMessage* message = new DtSetDataRequestMessage; request->setHeading(0.); message->setSetDataRequest(request); delete request; vrfObject()->radio()->sendToNet(message); ...

virtual int DtSetDataRequestMessage::contentCategoryType ( ) const

virtual

The radioMessageType() for this kind of message is “set-data-request” (DtSetDataRequestMessageType).

Implements DtVrfObjectMessage.

virtual const DtSetMessageType& DtSetDataRequestMessage::contentType ( ) const

virtual

virtual DtSimMessage* DtSetDataRequestMessage::clone ( ) const

virtual

Required override. Clones itself and the setDataRequest it points to.

Implements DtSimMessage.

virtual int DtSetDataRequestMessage::netRepSize ( ) const

virtual

Overrides the base class DtVrfObjectMessage netRepSize().

This calls down to the base class to get the size of the header created by the base, and then adds any task, set data, or report contents.

Reimplemented from DtVrfObjectMessage.

virtual bool DtSetDataRequestMessage::setFromNet ( const char *  networkBuffer, unsigned  contentSize  )

virtual

Extracts the task type, creates the task (using the task factory), and then tells the task to fill itself in from the network buffer.

Reimplemented from DtVrfObjectMessage.

virtual bool DtSetDataRequestMessage::setToNet ( )

virtual

Fill in our task type, tell the task to fill itself out, and then copy its buffer into ours.

Reimplemented from DtVrfObjectMessage.

virtual void DtSetDataRequestMessage::printDataToString ( DtString &  str )

virtual

Print message.

Reimplemented from DtVrfObjectMessage.

static DtVrfObjectMessage* DtSetDataRequestMessage::creator ( )

static

Member Data Documentation

DtSetDataRequest* DtSetDataRequestMessage::mySetDataRequest

protected

bool DtSetDataRequestMessage::myOwnSetDataRequest

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/setDataRequestMessage.h