DtSimInterfaceMessage Class Reference

DtSimInterfaceMessage is used to send a message to the front end or the back end. More...

Inheritance diagram for DtSimInterfaceMessage:

Public Member Functions
	DtSimInterfaceMessage ()
	default constructor More...
	DtSimInterfaceMessage (const DtSimInterfaceMessage &orig)
	copy constructor: shallow; copies values only More...
const DtSimInterfaceMessage &	operator= (DtSimInterfaceMessage &orig)
	assignment operator: shallow; assigns values only More...
virtual	~DtSimInterfaceMessage ()
	destructor More...
virtual int	messageType () const
	Overrides base class to return DtInterfaceMessageName. More...
virtual DtSimInterfaceContent *	interfaceContent () const
virtual void	setInterfaceContent (const DtSimInterfaceContent *interfaceContent)
	N.B. More...
virtual DtSimMessage *	clone () const
virtual void	setRecipient (const DtSimulationAddress &recipient)
virtual const DtSimulationAddress &	recipient () const
virtual void	setSender (const DtSimulationAddress &sender)
virtual const DtSimulationAddress &	sender () const
virtual void	printDataToString (DtString &str)
	Print message. More...
Public Member Functions inherited from DtSimMessage
	DtSimMessage ()
	default constructor More...
	DtSimMessage (const DtSimMessage &orig)
	copy constructor More...
const DtSimMessage &	operator= (const DtSimMessage &orig)
	assignment operator More...
virtual	~DtSimMessage ()
	destructor More...
virtual std::string	debugText () const
	Leak detector output. More...

Static Public Member Functions
static DtSimInterfaceMessage *	createMessage (const DtSimulationAddress &sender, const DtSimulationAddress &recipient, const DtSimInterfaceContent &content)

Protected Attributes
DtSimInterfaceContent *	myInterfaceContent
DtSimulationAddress	myRecipient
DtSimulationAddress	mySender
bool	myOwnContent

Detailed Description

DtSimInterfaceMessage is used to send a message to the front end or the back end.

It derives from a standard DtSimMessage, and returns messageType() "interface." It contains a pointer to a DtSimInterfaceContent (analogous to the DtTask in a DtTaskMsg.

Constructor & Destructor Documentation

DtSimInterfaceMessage::DtSimInterfaceMessage

(

)

default constructor

DtSimInterfaceMessage::DtSimInterfaceMessage

(

const DtSimInterfaceMessage &

orig

)

copy constructor: shallow; copies values only

virtual DtSimInterfaceMessage::~DtSimInterfaceMessage ( )

virtual

destructor

Member Function Documentation

const DtSimInterfaceMessage& DtSimInterfaceMessage::operator=

(

DtSimInterfaceMessage &

orig

)

assignment operator: shallow; assigns values only

virtual int DtSimInterfaceMessage::messageType ( ) const

virtual

Overrides base class to return DtInterfaceMessageName.

Implements DtSimMessage.

virtual DtSimInterfaceContent* DtSimInterfaceMessage::interfaceContent ( ) const

virtual

virtual void DtSimInterfaceMessage::setInterfaceContent ( const DtSimInterfaceContent *  interfaceContent )

virtual

N.B.

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

DtRadioMessage* radioMessage = new DtRadioMessage; DtIfDeliverRadioMessage* ifContent = new DtIfDeliverRadioMessage; DtSimInterfaceMessage* ifMessage = new DtSimInterfaceMessage;

... fill in radio message

ifContent->setRadioMessage(radioMessage); ifMessage->setInterfaceContent(ifContent); delete ifContent; msgIf->deliverMessage(*ifMessage); ...

virtual DtSimMessage* DtSimInterfaceMessage::clone ( ) const

virtual

Implements DtSimMessage.

virtual void DtSimInterfaceMessage::setRecipient ( const DtSimulationAddress &  recipient )

virtual

virtual const DtSimulationAddress& DtSimInterfaceMessage::recipient ( ) const

virtual

virtual void DtSimInterfaceMessage::setSender ( const DtSimulationAddress &  sender )

virtual

virtual const DtSimulationAddress& DtSimInterfaceMessage::sender ( ) const

virtual

virtual void DtSimInterfaceMessage::printDataToString ( DtString &  str )

virtual

Print message.

Reimplemented from DtSimMessage.

static DtSimInterfaceMessage* DtSimInterfaceMessage::createMessage ( const DtSimulationAddress &  sender, const DtSimulationAddress &  recipient, const DtSimInterfaceContent &  content  )

static

Member Data Documentation

DtSimInterfaceContent* DtSimInterfaceMessage::myInterfaceContent

protected

DtSimulationAddress DtSimInterfaceMessage::myRecipient

protected

DtSimulationAddress DtSimInterfaceMessage::mySender

protected

bool DtSimInterfaceMessage::myOwnContent

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfmsgs/simInterfaceMessage.h