DtAdminMessage Class Reference

Inheritance diagram for DtAdminMessage:

Public Member Functions
	DtAdminMessage ()
	DtAdminMessage (const DtAdminMessage &orig)
virtual	~DtAdminMessage ()
virtual DtAdminContent *	adminContent () const
virtual void	setAdminContent (DtAdminContent *content)
virtual int	contentCategoryType () const
virtual const DtAdminContentMessageType &	contentType () const
virtual DtSimMessage *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *networkBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
Public Member Functions inherited from DtVrfObjectMessage
	DtVrfObjectMessage ()
	DtVrfObjectMessage (const DtVrfObjectMessage &orig)
const DtVrfObjectMessage &	operator= (const DtVrfObjectMessage &orig)
virtual	~DtVrfObjectMessage ()
virtual int	messageType () const
virtual int	radioMessageType () const
virtual char *	netRep ()
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 std::string	debugText () const

Static Public Member Functions
static DtVrfObjectMessage *	creator ()
Static Public Member Functions inherited from DtVrfObjectMessage
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
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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmsgs/adminMessage.h