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.

Inheritance diagram for DtVrfObjectMessage:

[legend]

Public Member Functions
	DtVrfObjectMessage ()

	DtVrfObjectMessage (const DtVrfObjectMessage &orig)

const DtVrfObjectMessage &	operator= (const DtVrfObjectMessage &orig)

virtual	~DtVrfObjectMessage () override

virtual int	messageType () const override

virtual int	contentCategoryType () const =0

virtual int	radioMessageType () const

virtual char *	netRep ()

virtual int	netRepSize () const

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

virtual bool	setToNet ()

virtual void	printDataToString (DtString &str) override

virtual int	scenarioRunId () const

virtual void	setScenarioRunId (int)


virtual void	setReceiver (const DtUUID &receiver)

virtual const DtUUID &	receiver () const

virtual void	setRecipient (const DtUUID &receiver)

virtual const DtUUID &	recipient () const


virtual void	setTransmitter (const DtUUID &transmitter)

virtual const DtUUID &	transmitter () const

virtual void	setSender (const DtUUID &transmitter)

virtual const DtUUID &	sender () const

Public Member Functions inherited from DtSimMessage
	DtSimMessage ()

	DtSimMessage (const DtSimMessage &orig)

const DtSimMessage &	operator= (const DtSimMessage &orig)

virtual	~DtSimMessage ()

virtual DtSimMessage *	clone () const =0

virtual std::string	debugText () const

Static Public Member Functions
static DtVrfObjectMessage *	createVrfObjectMessage (int type)

static DtVrfObjectMessage *	createRadioMessage (int type)

static void	addVrfObjectMessageCreatorFcn (int type, DtVrfObjectMessageCreatorFcn fcn)

static void	addRadioMessageCreatorFcn (int type, DtVrfObjectMessageCreatorFcn fcn)

static void	setFactory (DtVrfObjectMessageFactory *factory)

static DtVrfObjectMessageFactory *	factory ()

Protected Member Functions
virtual char *	createNetworkBuffer ()

Protected Attributes
DtUUID	myTransmitter

DtUUID	myReceiver

char *	myNetRep

int	myScenarioRunId

Static Protected Attributes
static DtVrfObjectMessageFactory *	myFactory

Constructor & Destructor Documentation

DtVrfObjectMessage::DtVrfObjectMessage ( )

default constructor

DtVrfObjectMessage::DtVrfObjectMessage ( const DtVrfObjectMessage & orig )

copy constructor: shallow; copies values only.

virtual DtVrfObjectMessage::~DtVrfObjectMessage ( )

overridevirtual

destructor

Member Function Documentation

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

assignment operator: shallow; assigns values only.

virtual int DtVrfObjectMessage::messageType ( ) const

overridevirtual

Returns: DtVrfObjectMessageType.

Implements DtSimMessage.

virtual int DtVrfObjectMessage::contentCategoryType ( ) const

pure virtual

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

Implemented in DtTaskMessage, DtSetDataRequestMessage, DtReportMessage, 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. 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.

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

virtual const DtUUID& DtVrfObjectMessage::receiver ( ) const

virtual

Note that sending/receiving by echelon id is no longer supported. 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.

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

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

inlinevirtual

Note that sending/receiving by echelon id is no longer supported. 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.

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

virtual const DtUUID& DtVrfObjectMessage::recipient ( ) const

inlinevirtual

Note that sending/receiving by echelon id is no longer supported. 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.

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

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

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 void DtVrfObjectMessage::setSender ( const DtUUID & transmitter )

inlinevirtual

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::sender ( ) const

inlinevirtual

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 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, DtSetDataRequestMessage, DtReportMessage, and DtAdminMessage.

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

virtual

Fills in the message from the network buffer.

Reimplemented in DtTaskMessage, DtSetDataRequestMessage, DtReportMessage, and DtAdminMessage.

virtual bool DtVrfObjectMessage::setToNet ( )

virtual

Fill in our network representation.

Reimplemented in DtTaskMessage, DtSetDataRequestMessage, DtReportMessage, and DtAdminMessage.

virtual void DtVrfObjectMessage::printDataToString ( DtString & str )

overridevirtual

Print message.

Reimplemented from DtSimMessage.

Reimplemented in DtTaskMessage, DtSetDataRequestMessage, DtReportMessage, 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.vrf5-2-branch/include/vrfmsgs/vrfObjectMessage.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation