MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantNotifyObserveMsg Class Reference

The DtAssistantNotifyObserveMsg defines a wrapper for the RTI Assistant message used by the Assistant to inform remote Assistants that it wants to receive all notification messages. More...

+ Inheritance diagram for DtAssistantNotifyObserveMsg:
+ Collaboration diagram for DtAssistantNotifyObserveMsg:

Public Member Functions

 DtAssistantNotifyObserveMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor. More...
 
 DtAssistantNotifyObserveMsg (const DtNetAssistantNotifyObserveMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor. More...
 
virtual ~DtAssistantNotifyObserveMsg ()
 Destructor. More...
 
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this. More...
 
virtual bool isObserved () const
 Returns whether notifications are or are not being observed. More...
 
virtual void setIsObserved (bool observed)
 Set whether notifications are or are not being observed. More...
 
virtual void printData () const
 Print the data section. More...
 
- Public Member Functions inherited from DtAssistantMsg
virtual ~DtAssistantMsg ()
 Destructor. More...
 
virtual DtNetAssistantMsgHeadernetHeader () const
 Get header of network representation. More...
 
virtual int version () const
 Return the message version. More...
 
virtual bool isValidVersion () const
 Returns bool: message version is valid? More...
 
virtual DtAssistantMsgKind msgKind () const
 Get the message kind. More...
 
virtual void print () const
 Printing functions. More...
 
virtual void printHeader () const
 
virtual void printSrcDest () const
 
virtual bool isOk () const
 Message is good? More...
 
bool isAssistantToAssistantMessage () const
 Returns whether or not this message contains source/destination information included in messages sent between assistants. More...
 
virtual MAKRti::DtInetAddr sourceAddr () const
 Get/Set the IP address of the source of this message. More...
 
virtual void setSourceAddr (const MAKRti::DtInetAddr &addr)
 
virtual int sourceId () const
 Get/Set the ID of the source of this message. More...
 
virtual void setSourceId (int id)
 
virtual MAKRti::DtString sourceHost () const
 Get/Set the host name of the source of this message. More...
 
virtual void setSourceHost (const MAKRti::DtString &addr)
 
virtual MAKRti::DtInetAddr destAddr () const
 Get/Set the IP address of the destination of this message. More...
 
virtual void setDestAddr (const MAKRti::DtInetAddr &addr)
 
virtual int destId () const
 Get/Set the ID of the destination of this message. More...
 
virtual void setDestId (int id)
 
virtual int compId () const
 Get/Set the related component's connection ID. More...
 
virtual void setCompId (int compId)
 
virtual const DtAssistantUuidsourceUuid () const
 Get/Set the uuid of the source of this message. More...
 
virtual void setSourceUuid (const DtAssistantUuid &uuid)
 
virtual bool isForeign () const
 Get/Set the whether the source considers the destination foreign Assistant-to-Assistant messages only. More...
 
virtual void setIsForeign (bool isForeignDestination)
 
virtual DtU32 sequence () const
 Get/Set sequence number Assistant-to-Assistant messages only. More...
 
virtual void setSequence (DtU32 sequenceNumber)
 

Static Public Member Functions

static DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators. More...
 
static DtAssistantMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
static void addCallback (DtRtiAssistantPeer *conn, DtAssistantNotifyObserveCb cb, void *usr)
 Adds or removes a callback with the given Assistant peer for this message type. More...
 
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantNotifyObserveCb 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. More...
 

Protected Member Functions

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

Detailed Description

The DtAssistantNotifyObserveMsg defines a wrapper for the RTI Assistant message used by the Assistant to inform remote Assistants that it wants to receive all notification messages.

Constructor & Destructor Documentation

DtAssistantNotifyObserveMsg::DtAssistantNotifyObserveMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

DtAssistantNotifyObserveMsg::DtAssistantNotifyObserveMsg ( const DtNetAssistantNotifyObserveMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

virtual DtAssistantNotifyObserveMsg::~DtAssistantNotifyObserveMsg ( )
virtual

Destructor.

Member Function Documentation

static void DtAssistantNotifyObserveMsg::addCallback ( DtRtiAssistantPeer conn,
DtAssistantNotifyObserveCb  cb,
void *  usr 
)
static

Adds or removes a callback with the given Assistant peer for this message type.

virtual DtAssistantMsg* DtAssistantNotifyObserveMsg::clone ( bool  copy = true) const
virtual

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

Implements DtAssistantMsg.

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

Creators.

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

Returns the kind of a DtAssistantExitMsg message.

Implements DtAssistantMsg.

virtual bool DtAssistantNotifyObserveMsg::isObserved ( ) const
virtual

Returns whether notifications are or are not being observed.

virtual int DtAssistantNotifyObserveMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantNotifyObserveMsg* DtAssistantNotifyObserveMsg::netAssistantNotifyObserveMsg ( )
protectedvirtual

The network representation for the state observe message.

virtual const DtNetAssistantNotifyObserveMsg* DtAssistantNotifyObserveMsg::netAssistantNotifyObserveMsg ( ) const
protectedvirtual
virtual void DtAssistantNotifyObserveMsg::printData ( ) const
virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantNotifyObserveMsg::removeCallback ( DtRtiAssistantPeer conn,
DtAssistantNotifyObserveCb  cb,
void *  usr 
)
static
virtual void DtAssistantNotifyObserveMsg::setIsObserved ( bool  observed)
virtual

Set whether notifications are or are not being observed.


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

Document ID: Generated on Sun Jul 20 16:15:30 EDT 2025 from SVN revision 277985
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)