DtAdminMessage Class Reference

Inheritance diagram for DtAdminMessage:

Public Member Functions
	DtAdminMessage ()
	default constructor
	DtAdminMessage (const DtAdminMessage &orig)
virtual	~DtAdminMessage ()
	destructor
virtual DtAdminContent *	adminContent () const
	Returns a pointer to the DtAdminContent object in the message.
virtual void	setAdminContent (DtAdminContent *content)
	Sets the content of the message.
virtual int	contentCategoryType () const
virtual const DtAdminContentMessageType &	contentType () const
virtual DtSimMessage *	clone () const
	Required override. Clones itself and the DtAdminContnet it points to.
virtual int	netRepSize () const
virtual bool	setFromNet (const char *networkBuffer, unsigned contentSize)
	Extracts the content type, creates the content (using the admin content factory), and then tells the content to fill itself in from the network buffer.
virtual bool	setToNet ()
	Fill in our content type, tell the content 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 DtAdminMessage &	operator= (DtAdminMessage &orig)
Protected Member Functions inherited from DtVrfObjectMessage
virtual char *	createNetworkBuffer ()

Protected Attributes
DtAdminContent *	myAdminContent
bool	myOwnContent
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

Constructor & Destructor Documentation

DtAdminMessage::DtAdminMessage

(

)

default constructor

DtAdminMessage::DtAdminMessage

(

const DtAdminMessage &

orig

)

virtual DtAdminMessage::~DtAdminMessage ( )

virtual

destructor

Member Function Documentation

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

protected

virtual DtAdminContent* DtAdminMessage::adminContent ( ) const

virtual

Returns a pointer to the DtAdminContent object in the message.

virtual void DtAdminMessage::setAdminContent ( DtAdminContent *  content )

virtual

Sets the content of the message.

Note

This method only keeps a pointer to the content, and does not clone it. The caller must ensure that the content exists for the lifetime of this message.

virtual int DtAdminMessage::contentCategoryType ( ) const

virtual

Returns

DtAdminMessageType.

Implements DtVrfObjectMessage.

virtual const DtAdminContentMessageType& DtAdminMessage::contentType ( ) const

virtual

Returns

the type of the content.

virtual DtSimMessage* DtAdminMessage::clone ( ) const

virtual

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

Implements DtSimMessage.

virtual int DtAdminMessage::netRepSize ( ) const

virtual

Returns

the serialization size of this message.

Reimplemented from DtVrfObjectMessage.

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

virtual

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

Reimplemented from DtVrfObjectMessage.

virtual bool DtAdminMessage::setToNet ( )

virtual

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

Reimplemented from DtVrfObjectMessage.

virtual void DtAdminMessage::printDataToString ( DtString &  str )

virtual

Print message.

Reimplemented from DtVrfObjectMessage.

static DtVrfObjectMessage* DtAdminMessage::creator ( )

static

Member Data Documentation

DtAdminContent* DtAdminMessage::myAdminContent

protected

bool DtAdminMessage::myOwnContent

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfmsgs/adminMessage.h