DtVrfObjectMessage Class Reference

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

Inheritance diagram for DtVrfObjectMessage:

List of all members.

Public Member Functions
	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	contentCategoryType () const =0
virtual int	radioMessageType () const
virtual int	contentType () const =0
virtual void	setRecipient (const DtString &recipient)
virtual const DtString &	recipient () const
virtual void	setSender (const DtString &sender)
virtual const DtString &	sender () const
virtual char *	netRep ()
	Returns a pointer to the simulation network representation of this message.
virtual int	netRepSize () const
	Returns the size of the simulation network representation of this message.
virtual bool	setFromNet (const char *networkBuffer, unsigned contentSize)
	Fills in the message from the network buffer.
virtual bool	setToNet ()
	Fill in our network representation.
virtual void	printDataToString (DtString &str)
	Print message.
virtual void	setReceiver (const DtString &receiver)
	The name or echelon ID of the intended receiver of the message.
virtual const DtString &	receiver () const
	The name or echelon ID of the intended receiver of the message.
virtual void	setReceiverIsEchelonId (bool yesNo)
	The receiver address is either an echelon Id String or a name string.
virtual bool	receiverIsEchelonId () const
	The receiver address is either an echelon Id String or a name string.
virtual void	setTransmitter (const DtString &transmitter)
	The name or echelon ID of the sender of the message.
virtual const DtString &	transmitter () const
	The name or echelon ID of the sender of the message.
virtual void	setTransmitterIsEchelonId (bool yesNo)
	The transmitter address is either an echelon Id String or a name string.
virtual bool	transmitterIsEchelonId () const
	The transmitter address is either an echelon Id String or a name string.
Static Public Member Functions
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
virtual char *	createNetworkBuffer ()
Protected Attributes
DtString	myTransmitter
DtString	myReceiver
bool	myTransmitterIsEchelonId
bool	myReceiverIsEchelonId
char *	myNetRep
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 int DtVrfObjectMessage::contentType

(

)

const [pure virtual]

Returns:

The content type of this message. This is the type of the task, report, set data etc. that is contained in this message.

Implemented in DtTaskMessage, DtReportMessage, DtSetDataRequestMessage, and DtAdminMessage.

virtual void DtVrfObjectMessage::setReceiver

(

const DtString &

receiver

)

[virtual]

The name or echelon ID of the intended receiver of the message.

setReceiverIsEchelonId() and receiverIsEchelonId() indicates if it is a name or echelon ID. Name is preferred. 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 DtString& DtVrfObjectMessage::receiver

(

)

const [virtual]

The name or echelon ID of the intended receiver of the message.

setReceiverIsEchelonId() and receiverIsEchelonId() indicates if it is a name or echelon ID. Name is preferred. 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 void DtVrfObjectMessage::setReceiverIsEchelonId

(

bool

yesNo

)

[virtual]

The receiver address is either an echelon Id String or a name string.

This boolean determines which it is.

virtual bool DtVrfObjectMessage::receiverIsEchelonId

(

)

const [virtual]

The receiver address is either an echelon Id String or a name string.

This boolean determines which it is.

virtual void DtVrfObjectMessage::setTransmitter

(

const DtString &

transmitter

)

[virtual]

The name or echelon ID of the sender of the message.

setTransmitterIsEchelonId() and transmitterIsEchelonId() indicates if it is a name or echelon ID. This may be set to DtVrfObjectMessageFrontEndAddress if the message was sent by a VRF remote control application, like VR-Forces GUI.

virtual const DtString& DtVrfObjectMessage::transmitter

(

)

const [virtual]

The name or echelon ID of the sender of the message.

setTransmitterIsEchelonId() and transmitterIsEchelonId() indicates if it is a name or echelon ID. This may be set to DtVrfObjectMessageFrontEndAddress if the message was sent by a VRF remote control application, like VR-Forces GUI.

virtual void DtVrfObjectMessage::setTransmitterIsEchelonId

(

bool

yesNo

)

[virtual]

The transmitter address is either an echelon Id String or a name string.

This boolean determines which it is. By default, this value is true.

virtual bool DtVrfObjectMessage::transmitterIsEchelonId

(

)

const [virtual]

The transmitter address is either an echelon Id String or a name string.

This boolean determines which it is. By default, this value is true.

virtual void DtVrfObjectMessage::setRecipient

(

const DtString &

recipient

)

[virtual]

Deprecated:

Use setReceiver().

virtual const DtString& DtVrfObjectMessage::recipient

(

)

const [virtual]

Deprecated:

Use receiver().

virtual void DtVrfObjectMessage::setSender

(

const DtString &

sender

)

[virtual]

Deprecated:

Use setTransmitter().

virtual const DtString& DtVrfObjectMessage::sender

(

)

const [virtual]

Deprecated:

Use transmitter().

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 char* DtVrfObjectMessage::createNetworkBuffer

(

)

[protected, virtual]

---

Member Data Documentation

DtString DtVrfObjectMessage::myTransmitter [protected]

DtString DtVrfObjectMessage::myReceiver [protected]

bool DtVrfObjectMessage::myTransmitterIsEchelonId [protected]

bool DtVrfObjectMessage::myReceiverIsEchelonId [protected]

char* DtVrfObjectMessage::myNetRep [protected]

DtVrfObjectMessageFactory* DtVrfObjectMessage::myFactory [static, protected]

---

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

• include/vrfmsgs/vrfObjectMessage.h