VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtAdminMessage Class Reference
Inheritance diagram for DtAdminMessage:
Inheritance graph
[legend]

List of all members.

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 int 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.

Static Public Member Functions

static DtSimRadioMessage * creator ()

Protected Member Functions

const DtAdminMessage & operator= (DtAdminMessage &orig)

Protected Attributes

DtAdminContent * myAdminContent
bool myOwnContent

Constructor & Destructor Documentation

default constructor

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 int DtAdminMessage::contentType ( ) const [virtual]
Returns:
the type of the content.

Implements DtVrfObjectMessage.

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.


Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)