MAK RTIspy API Documentation for HLA Evolved
 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 | Protected Attributes
DtAssistantLogMsg Class Reference

The DtAssistantLogMsg defines a wrapper for the RTI Assistant log message used to send a full log from an rtiexec to an Assistant for display. More...

+ Inheritance diagram for DtAssistantLogMsg:
+ Collaboration diagram for DtAssistantLogMsg:

Public Member Functions

 DtAssistantLogMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors. More...
 
 DtAssistantLogMsg (const DtNetAssistantLogMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
virtual ~DtAssistantLogMsg ()
 Destructor. More...
 
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this. More...
 
virtual void setLog (const DtLogEntryList &log, unsigned maxSize)
 Set log. More...
 
virtual const char * nextEntry (DtNotifyLevelType &notifyLevel) const
 Returns a pointer to the next entry and fills in its notify level. More...
 
virtual unsigned textSize () const
 Get total size of text. 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 (DtRtiAssistantServer *conn, DtAssistantLogCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type. More...
 
static void removeCallback (DtRtiAssistantServer *conn, DtAssistantLogCb cb, void *usr)
 
static void addCallback (DtRtiAssistantPeer *conn, DtAssistantLogCb cb, void *usr)
 Adds or removes a callback with the given Assistant peer for this message type. More...
 
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantLogCb 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 DtNetAssistantLogMsgnetAssistantLogMsg ()
 The network representation for the notify message. More...
 
virtual const
DtNetAssistantLogMsg
netAssistantLogMsg () const
 
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantLogMsg message. More...
 
virtual int minSize () const
 Returns minimum size of a message, including header. More...
 
virtual void setTextSize (unsigned size)
 Set total size of text. More...
 
virtual void setNumEntries (unsigned num)
 Set/Get number of log entries. More...
 
virtual unsigned numEntries () const
 
virtual const DtNetU8 * notifyLevelPtr () const
 Return pointer to notify levels location in message. More...
 
virtual DtNetU8 * notifyLevelPtr ()
 
virtual const char * textPtr () const
 Return pointer to text location in message. More...
 
virtual char * textPtr ()
 
- 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 ()
 

Protected Attributes

const char * myNextTextPtr
 The next text location to read from the message. More...
 
unsigned myNextNum
 The next entry to read from the message. More...
 

Detailed Description

The DtAssistantLogMsg defines a wrapper for the RTI Assistant log message used to send a full log from an rtiexec to an Assistant for display.

RTI Assistant.

Constructor & Destructor Documentation

DtAssistantLogMsg::DtAssistantLogMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

DtAssistantLogMsg::DtAssistantLogMsg ( const DtNetAssistantLogMsg netRep,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
virtual DtAssistantLogMsg::~DtAssistantLogMsg ( )
virtual

Destructor.

Member Function Documentation

static void DtAssistantLogMsg::addCallback ( DtRtiAssistantServer conn,
DtAssistantLogCb  cb,
void *  usr 
)
static

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

static void DtAssistantLogMsg::addCallback ( DtRtiAssistantPeer conn,
DtAssistantLogCb  cb,
void *  usr 
)
static

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

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

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

Implements DtAssistantMsg.

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

Creators.

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

Returns the kind of a DtAssistantLogMsg message.

Implements DtAssistantMsg.

virtual int DtAssistantLogMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantLogMsg* DtAssistantLogMsg::netAssistantLogMsg ( )
protectedvirtual

The network representation for the notify message.

virtual const DtNetAssistantLogMsg* DtAssistantLogMsg::netAssistantLogMsg ( ) const
protectedvirtual
virtual const char* DtAssistantLogMsg::nextEntry ( DtNotifyLevelType &  notifyLevel) const
virtual

Returns a pointer to the next entry and fills in its notify level.

Returns 0 if there are no more entries.

virtual const DtNetU8* DtAssistantLogMsg::notifyLevelPtr ( ) const
protectedvirtual

Return pointer to notify levels location in message.

virtual DtNetU8* DtAssistantLogMsg::notifyLevelPtr ( )
protectedvirtual
virtual unsigned DtAssistantLogMsg::numEntries ( ) const
protectedvirtual
virtual void DtAssistantLogMsg::printData ( ) const
virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantLogMsg::removeCallback ( DtRtiAssistantServer conn,
DtAssistantLogCb  cb,
void *  usr 
)
static
static void DtAssistantLogMsg::removeCallback ( DtRtiAssistantPeer conn,
DtAssistantLogCb  cb,
void *  usr 
)
static
virtual void DtAssistantLogMsg::setLog ( const DtLogEntryList log,
unsigned  maxSize 
)
virtual

Set log.

virtual void DtAssistantLogMsg::setNumEntries ( unsigned  num)
protectedvirtual

Set/Get number of log entries.

virtual void DtAssistantLogMsg::setTextSize ( unsigned  size)
protectedvirtual

Set total size of text.

virtual const char* DtAssistantLogMsg::textPtr ( ) const
protectedvirtual

Return pointer to text location in message.

virtual char* DtAssistantLogMsg::textPtr ( )
protectedvirtual
virtual unsigned DtAssistantLogMsg::textSize ( ) const
virtual

Get total size of text.

Member Data Documentation

unsigned DtAssistantLogMsg::myNextNum
mutableprotected

The next entry to read from the message.

const char* DtAssistantLogMsg::myNextTextPtr
mutableprotected

The next text location to read from the message.


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

Document ID: Generated on Mon Sep 7 15:40:32 EDT 2020 from SVN revision 217499
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)