DtVrfObjectMessage Class Reference

The base class for all messages to/from a specific DtVrfObject. More...

Inheritance diagram for DtVrfObjectMessage:

Public Member Functions
	DtVrfObjectMessage ()
	default constructor More...
	DtVrfObjectMessage (const DtVrfObjectMessage &orig)
	copy constructor: shallow; copies values only. More...
const DtVrfObjectMessage &	operator= (const DtVrfObjectMessage &orig)
	assignment operator: shallow; assigns values only. More...
virtual	~DtVrfObjectMessage ()
	destructor More...
virtual int	messageType () const
virtual int	contentCategoryType () const =0
virtual int	radioMessageType () const
virtual char *	netRep ()
	Returns a pointer to the simulation network representation of this message. More...
virtual int	netRepSize () const
	Returns the size of the simulation network representation of this message. More...
virtual bool	setFromNet (const char *networkBuffer, unsigned contentSize)
	Fills in the message from the network buffer. More...
virtual bool	setToNet ()
	Fill in our network representation. More...
virtual void	printDataToString (DtString &str)
	Print message. More...
virtual int	scenarioRunId () const
	If used, the scenario run id of the scenario that sent this message. More...
virtual void	setScenarioRunId (int)
virtual void	setReceiver (const DtUUID &receiver)
	Note that sending/receiving by echelon id is no longer supported. More...
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. More...
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 More...
	DtSimMessage (const DtSimMessage &orig)
	copy constructor More...
const DtSimMessage &	operator= (const DtSimMessage &orig)
	assignment operator More...
virtual	~DtSimMessage ()
	destructor More...
virtual DtSimMessage *	clone () const =0
virtual std::string	debugText () const
	Leak detector output. More...

Static Public Member Functions
static DtVrfObjectMessage *	createVrfObjectMessage (int type)
	Creates a new DtVrfObjectMessage subclass using the static factory. More...
static DtVrfObjectMessage *	createRadioMessage (int type)
static void	addVrfObjectMessageCreatorFcn (int type, DtVrfObjectMessageCreatorFcn fcn)
	Adds a new creator function to the DtVrfObjectMessageFactory. More...
static void	addRadioMessageCreatorFcn (int type, DtVrfObjectMessageCreatorFcn fcn)
static void	setFactory (DtVrfObjectMessageFactory *factory)
static DtVrfObjectMessageFactory *	factory ()
Static Public Member Functions inherited from DtObjectDebugger< DtSimMessage >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtObjectDebugger< DtSimMessage >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtUUID	myTransmitter
DtUUID	myReceiver
char *	myNetRep
int	myScenarioRunId

Static Protected Attributes
static DtVrfObjectMessageFactory *	myFactory

Detailed Description

The base class for all messages to/from a specific DtVrfObject.

Various subclasses of this class will have different types of contents, such as tasks or set data requests.

Constructor & Destructor Documentation

DtVrfObjectMessage::DtVrfObjectMessage

(

)

default constructor

DtVrfObjectMessage::DtVrfObjectMessage

(

const DtVrfObjectMessage &

orig

)

copy constructor: shallow; copies values only.

virtual DtVrfObjectMessage::~DtVrfObjectMessage ( )

virtual

destructor

Member Function Documentation

const DtVrfObjectMessage& DtVrfObjectMessage::operator=

(

const DtVrfObjectMessage &

orig

)

assignment operator: shallow; assigns values only.

virtual int DtVrfObjectMessage::messageType ( ) const

virtual

Returns

DtVrfObjectMessageType.

Implements DtSimMessage.

virtual int DtVrfObjectMessage::contentCategoryType ( ) const

pure virtual

Returns

The category of this message. (DtTaskMessageType, DtReportMessageType, etc.)

Implemented in DtTaskMessage, DtReportMessage, DtSetDataRequestMessage, and DtAdminMessage.

virtual int DtVrfObjectMessage::radioMessageType ( ) const

virtual

Deprecated:

Same as contentCategoryType().

virtual void DtVrfObjectMessage::setReceiver ( const DtUUID &  receiver )

virtual

Note that sending/receiving by echelon id is no longer supported.

Returns

The content type of this message. This is the type of the task, report, set data etc. that is contained in this message. This is currently getting the string inside the type itself Only supported sending by name or UUID of object Setting this to DtVrfObjectMessageSendToAll will cause it to be sent to all entities. Setting this to DtVrfObjectMessageFrontEndAddress will cause it to be sent to add VRF Remote Control applications in the exercise.

virtual const DtUUID& DtVrfObjectMessage::receiver ( ) const

virtual

virtual void DtVrfObjectMessage::setRecipient ( const DtUUID &  receiver )

inlinevirtual

virtual const DtUUID& DtVrfObjectMessage::recipient ( ) const

inlinevirtual

virtual void DtVrfObjectMessage::setTransmitter ( const DtUUID &  transmitter )

virtual

Note that sending/receiving by echelon id is no longer supported.

Only supported sending by name or UUID of object This may be set to DtVrfObjectMessageFrontEndAddress if the message was sent by a VRF remote control application, like VR-Forces GUI.

virtual const DtUUID& DtVrfObjectMessage::transmitter ( ) const

virtual

virtual void DtVrfObjectMessage::setSender ( const DtUUID &  transmitter )

inlinevirtual

virtual const DtUUID& DtVrfObjectMessage::sender ( ) const

inlinevirtual

virtual char* DtVrfObjectMessage::netRep ( )

virtual

Returns a pointer to the simulation network representation of this message.

virtual int DtVrfObjectMessage::netRepSize ( ) const

virtual

Returns the size of the simulation network representation of this message.

This size includes any task, set data, or report contents.

Reimplemented in DtTaskMessage, DtReportMessage, DtSetDataRequestMessage, and DtAdminMessage.

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

virtual

Fills in the message from the network buffer.

Reimplemented in DtTaskMessage, DtReportMessage, DtSetDataRequestMessage, and DtAdminMessage.

virtual bool DtVrfObjectMessage::setToNet ( )

virtual

Fill in our network representation.

Reimplemented in DtTaskMessage, DtReportMessage, DtSetDataRequestMessage, and DtAdminMessage.

virtual void DtVrfObjectMessage::printDataToString ( DtString &  str )

virtual

Print message.

Reimplemented from DtSimMessage.

Reimplemented in DtTaskMessage, DtReportMessage, DtSetDataRequestMessage, and DtAdminMessage.

static DtVrfObjectMessage* DtVrfObjectMessage::createVrfObjectMessage ( int  type )

static

Creates a new DtVrfObjectMessage subclass using the static factory.

static DtVrfObjectMessage* DtVrfObjectMessage::createRadioMessage ( int  type )

static

Deprecated:

Use createVrfObjectMessage() instead.

static void DtVrfObjectMessage::addVrfObjectMessageCreatorFcn ( int  type, DtVrfObjectMessageCreatorFcn  fcn  )

static

Adds a new creator function to the DtVrfObjectMessageFactory.

static void DtVrfObjectMessage::addRadioMessageCreatorFcn ( int  type, DtVrfObjectMessageCreatorFcn  fcn  )

static

Deprecated:

Use addVrfObjectMessageCreatorFcn() instead.

static void DtVrfObjectMessage::setFactory ( DtVrfObjectMessageFactory *  factory )

static

static DtVrfObjectMessageFactory* DtVrfObjectMessage::factory ( )

static

virtual int DtVrfObjectMessage::scenarioRunId ( ) const

virtual

If used, the scenario run id of the scenario that sent this message.

virtual void DtVrfObjectMessage::setScenarioRunId ( int  )

virtual

virtual char* DtVrfObjectMessage::createNetworkBuffer ( )

protectedvirtual

Member Data Documentation

DtUUID DtVrfObjectMessage::myTransmitter

protected

DtUUID DtVrfObjectMessage::myReceiver

protected

char* DtVrfObjectMessage::myNetRep

protected

int DtVrfObjectMessage::myScenarioRunId

protected

DtVrfObjectMessageFactory* DtVrfObjectMessage::myFactory

staticprotected

---

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

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