MAK RTIspy API Documentation for HLA Evolved
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantNtfyLvlUpdateMsg Class Reference

The DtAssistantNtfyLvlUpdateMsg defines a wrapper for the RTI Assistant notify level update message used by the Assistant to command an RTI component to update its notify level. More...

+ Inheritance diagram for DtAssistantNtfyLvlUpdateMsg:
+ Collaboration diagram for DtAssistantNtfyLvlUpdateMsg:

Public Member Functions

 DtAssistantNtfyLvlUpdateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantNtfyLvlUpdateMsg (const DtNetAssistantNtfyLvlUpdateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtAssistantNtfyLvlUpdateMsg (DtNotifyLevelType notifyLevel, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantNtfyLvlUpdateMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void setNotifyLevel (DtNotifyLevelType level)
 Set notify level.
virtual DtNotifyLevelType notifyLevel () const
 Get notify level.
virtual void printData () const
 Print the data section.
- Public Member Functions inherited from DtAssistantMsg
virtual ~DtAssistantMsg ()
 Destructor.
virtual DtNetAssistantMsgHeadernetHeader () const
 Get header of network representation.
virtual int version () const
 Return the message version.
virtual bool isValidVersion () const
 Returns bool: message version is valid?
virtual DtAssistantMsgKind msgKind () const
 Get the message kind.
virtual void print () const
 Printing functions.
virtual void printHeader () const
virtual bool isOk () const
 Message is good?
bool isAssistantToAssistantMessage () const
 Returns whether or not this message contains source/destination information included in messages sent between assistants.
virtual MAKRti::DtInetAddr sourceAddr () const
 Get/Set the IP address of the source of this message.
virtual void setSourceAddr (const MAKRti::DtInetAddr &addr)
virtual int sourceId () const
 Get/Set the ID of the source of this message.
virtual void setSourceId (int id)
virtual MAKRti::DtString sourceHost () const
 Get/Set the host name of the source of this message.
virtual void setSourceHost (const MAKRti::DtString &addr)
virtual MAKRti::DtInetAddr destAddr () const
 Get/Set the IP address of the destination of this message.
virtual void setDestAddr (const MAKRti::DtInetAddr &addr)
virtual int destId () const
 Get/Set the ID of the destination of this message.
virtual void setDestId (int id)
virtual int compId () const
 Get/Set the related component's connection ID.
virtual void setCompId (int compId)

Static Public Member Functions

static DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators.
static DtAssistantMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void addCallback (DtRtiAssistantClient *conn, DtAssistantNtfyLvlUpdateCb cb, void *usr)
 Adds or removes a callback with the given Assistant client for this message type.
static void removeCallback (DtRtiAssistantClient *conn, DtAssistantNtfyLvlUpdateCb cb, void *usr)
- Static Public Member Functions inherited from DtAssistantMsg
static const char * kindToString (DtAssistantMsgKind kind)
 Returns the name of the message, by kind enumeration.

Protected Member Functions

virtual
DtNetAssistantNtfyLvlUpdateMsg
netAssistantNtfyLvlUpdateMsg ()
 The network representation for the message.
virtual const
DtNetAssistantNtfyLvlUpdateMsg
netAssistantNtfyLvlUpdateMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantNtfyLvlUpdateMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
- Protected Member Functions inherited from DtAssistantMsg
 DtAssistantMsg ()
 Constructor.
virtual void sizeChanged (int size)
 Called whenever size is changed using changeSize, or insert/deleteBytes.
void initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer)
 Called by ctor, so not virtual.
void initAssistantMsg (const void *initial, int size, DtBufferPtr buffer)
void initAssistantMsg (const DtNetAssistantMsgHeader *header, DtBufferPtr buffer)
virtual void adjustBytes (int offset, int numBytes)
 Adjust numBytes bytes at the indicated offset in the net rep.
virtual void adjustBytes (void *address, int numBytes)
 Adjust the numBytes starting at the indicated address.
virtual void resizeForSrcDestInfo ()
 Allocates memory at the end of the message for source/destination information needed when sending messages between assistants.
virtual const
DtNetAssistantSrcDestInfo
srcDestInfoPtr () const
 Return pointer to source/destination information in the message.
virtual DtNetAssistantSrcDestInfosrcDestInfoPtr ()
virtual void setSourceHostSize (unsigned long size)
 Set/Get source host name text size.
virtual unsigned long sourceHostSize () const
virtual const char * sourceHostPtr () const
 Return pointer to source host name in message.
virtual char * sourceHostPtr ()

Detailed Description

The DtAssistantNtfyLvlUpdateMsg defines a wrapper for the RTI Assistant notify level update message used by the Assistant to command an RTI component to update its notify level.

Constructor & Destructor Documentation

DtAssistantNtfyLvlUpdateMsg::DtAssistantNtfyLvlUpdateMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().

Referenced by clone(), and create().

DtAssistantNtfyLvlUpdateMsg::DtAssistantNtfyLvlUpdateMsg ( const DtNetAssistantNtfyLvlUpdateMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtAssistantNtfyLvlUpdateMsg::DtAssistantNtfyLvlUpdateMsg ( DtNotifyLevelType  notifyLevel,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtAssistantNtfyLvlUpdateMsg::~DtAssistantNtfyLvlUpdateMsg ( )
virtual

Destructor.

Member Function Documentation

void DtAssistantNtfyLvlUpdateMsg::addCallback ( DtRtiAssistantClient conn,
DtAssistantNtfyLvlUpdateCb  cb,
void *  usr 
)
static
DtAssistantMsg * DtAssistantNtfyLvlUpdateMsg::clone ( bool  copy = true) const
virtual

Return a copy/empty object of the same type as this.

Implements DtAssistantMsg.

References DtAssistantNtfyLvlUpdateMsg(), and netAssistantNtfyLvlUpdateMsg().

DtAssistantMsg * DtAssistantNtfyLvlUpdateMsg::create ( const DtNetAssistantMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static

Creators.

References DtAssistantNtfyLvlUpdateMsg().

DtAssistantMsg * DtAssistantNtfyLvlUpdateMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static
DtAssistantMsgKind DtAssistantNtfyLvlUpdateMsg::internalMsgKind ( )
protectedvirtual

Returns the kind of a DtAssistantNtfyLvlUpdateMsg message.

Implements DtAssistantMsg.

References DtAssistantNtfyLvlUpdateMsgKind.

Referenced by DtAssistantNtfyLvlUpdateMsg().

int DtAssistantNtfyLvlUpdateMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantNtfyLvlUpdateMsg().

DtNetAssistantNtfyLvlUpdateMsg * DtAssistantNtfyLvlUpdateMsg::netAssistantNtfyLvlUpdateMsg ( )
protectedvirtual

The network representation for the message.

Referenced by clone(), notifyLevel(), and setNotifyLevel().

const DtNetAssistantNtfyLvlUpdateMsg * DtAssistantNtfyLvlUpdateMsg::netAssistantNtfyLvlUpdateMsg ( ) const
protectedvirtual
DtNotifyLevelType DtAssistantNtfyLvlUpdateMsg::notifyLevel ( ) const
virtual
void DtAssistantNtfyLvlUpdateMsg::printData ( ) const
virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References notifyLevel().

void DtAssistantNtfyLvlUpdateMsg::removeCallback ( DtRtiAssistantClient conn,
DtAssistantNtfyLvlUpdateCb  cb,
void *  usr 
)
static
void DtAssistantNtfyLvlUpdateMsg::setNotifyLevel ( DtNotifyLevelType  level)
virtual

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

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)