![]() |
MAK RTIspy API Documentation for HLA 1516
|
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. | |
| DtAssistantLogMsg (const DtNetAssistantLogMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| virtual | ~DtAssistantLogMsg () |
| Destructor. | |
| virtual DtAssistantMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. | |
| virtual void | setLog (const DtLogEntryList &log, unsigned maxSize) |
| Set log. | |
| virtual const char * | nextEntry (DtNotifyLevelType ¬ifyLevel) const |
| Returns a pointer to the next entry and fills in its notify level. | |
| virtual unsigned | textSize () const |
| Get total size of text. | |
| virtual void | printData () const |
| Print the data section. | |
Static Public Member Functions | |
| static DtAssistantMsg * | create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creators. | |
| static DtAssistantMsg * | create (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. | |
| 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. | |
| static void | removeCallback (DtRtiAssistantPeer *conn, DtAssistantLogCb cb, void *usr) |
Protected Member Functions | |
| virtual DtNetAssistantLogMsg * | netAssistantLogMsg () |
| The network representation for the notify message. | |
| virtual const DtNetAssistantLogMsg * | netAssistantLogMsg () const |
| virtual DtAssistantMsgKind | internalMsgKind () |
| Returns the kind of a DtAssistantLogMsg message. | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. | |
| virtual void | setTextSize (unsigned size) |
| Set total size of text. | |
| virtual void | setNumEntries (unsigned num) |
| Set/Get number of log entries. | |
| virtual unsigned | numEntries () const |
| virtual const DtNetU8 * | notifyLevelPtr () const |
| Return pointer to notify levels location in message. | |
| virtual DtNetU8 * | notifyLevelPtr () |
| virtual const char * | textPtr () const |
| Return pointer to text location in message. | |
| virtual char * | textPtr () |
Protected Attributes | |
| const char * | myNextTextPtr |
| The next text location to read from the message. | |
| unsigned | myNextNum |
| The next entry to read from the message. | |
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.
| DtAssistantLogMsg::DtAssistantLogMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().
| DtAssistantLogMsg::DtAssistantLogMsg | ( | const DtNetAssistantLogMsg * | netRep, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
References DtNetAssistantLogMsg::header, and DtAssistantMsg::initAssistantMsg().
| DtAssistantLogMsg::~DtAssistantLogMsg | ( | ) | [virtual] |
Destructor.
| void DtAssistantLogMsg::addCallback | ( | DtRtiAssistantServer * | conn, |
| DtAssistantLogCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Adds or removes a callback with the given Assistant server for this message type.
References DtRtiAssistantServer::addMsgCallback(), and DtAssistantLogMsgKind.
Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr(), and DtAssistantNetworkCompViewMgr::DtAssistantNetworkCompViewMgr().
| void DtAssistantLogMsg::addCallback | ( | DtRtiAssistantPeer * | conn, |
| DtAssistantLogCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Adds or removes a callback with the given Assistant peer for this message type.
References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantLogMsgKind.
| DtAssistantMsg * DtAssistantLogMsg::clone | ( | bool | copy = true | ) | const [virtual] |
Return a copy/empty object of the same type as this.
Implements DtAssistantMsg.
References DtAssistantLogMsg(), and netAssistantLogMsg().
| DtAssistantMsg * DtAssistantLogMsg::create | ( | const DtNetAssistantMsgHeader * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) | [static] |
Creators.
References DtAssistantLogMsg().
| DtAssistantMsg * DtAssistantLogMsg::create | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) | [static] |
References DtAssistantLogMsg().
| DtAssistantMsgKind DtAssistantLogMsg::internalMsgKind | ( | ) | [protected, virtual] |
Returns the kind of a DtAssistantLogMsg message.
Implements DtAssistantMsg.
References DtAssistantLogMsgKind.
Referenced by DtAssistantLogMsg().
| int DtAssistantLogMsg::minSize | ( | ) | const [protected, virtual] |
Returns minimum size of a message, including header.
Referenced by DtAssistantLogMsg(), and setLog().
| DtNetAssistantLogMsg * DtAssistantLogMsg::netAssistantLogMsg | ( | ) | [protected, virtual] |
The network representation for the notify message.
Referenced by clone(), notifyLevelPtr(), numEntries(), setNumEntries(), setTextSize(), and textSize().
| const DtNetAssistantLogMsg * DtAssistantLogMsg::netAssistantLogMsg | ( | ) | const [protected, 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.
References myNextNum, myNextTextPtr, notifyLevelPtr(), numEntries(), and textPtr().
Referenced by DtAssistantNetworkCompViewMgr::processRtiexecLogMsg().
| const DtNetU8 * DtAssistantLogMsg::notifyLevelPtr | ( | ) | const [protected, virtual] |
Return pointer to notify levels location in message.
References netAssistantLogMsg().
Referenced by nextEntry(), setLog(), and textPtr().
| DtNetU8 * DtAssistantLogMsg::notifyLevelPtr | ( | ) | [protected, virtual] |
References netAssistantLogMsg().
| unsigned DtAssistantLogMsg::numEntries | ( | ) | const [protected, virtual] |
References netAssistantLogMsg(), and DtNetAssistantLogMsg::numEntries.
Referenced by nextEntry(), printData(), setLog(), and textPtr().
| void DtAssistantLogMsg::printData | ( | ) | const [virtual] |
| void DtAssistantLogMsg::removeCallback | ( | DtRtiAssistantServer * | conn, |
| DtAssistantLogCb | cb, | ||
| void * | usr | ||
| ) | [static] |
| void DtAssistantLogMsg::removeCallback | ( | DtRtiAssistantPeer * | conn, |
| DtAssistantLogCb | cb, | ||
| void * | usr | ||
| ) | [static] |
References DtAssistantLogMsgKind, and DtRtiAssistantPeer::removeMsgCallback().
| void DtAssistantLogMsg::setLog | ( | const DtLogEntryList & | log, |
| unsigned | maxSize | ||
| ) | [virtual] |
Set log.
References rti1516e::insertBytes(), minSize(), notifyLevelPtr(), numEntries(), setNumEntries(), setTextSize(), textPtr(), and textSize().
Referenced by DtRtiAssistantExecClient::sendLogMsg().
| void DtAssistantLogMsg::setNumEntries | ( | unsigned | num | ) | [protected, virtual] |
Set/Get number of log entries.
References netAssistantLogMsg(), and DtNetAssistantLogMsg::numEntries.
Referenced by setLog().
| void DtAssistantLogMsg::setTextSize | ( | unsigned | size | ) | [protected, virtual] |
Set total size of text.
References netAssistantLogMsg(), and DtNetAssistantLogMsg::textSize.
Referenced by setLog().
| const char * DtAssistantLogMsg::textPtr | ( | ) | const [protected, virtual] |
Return pointer to text location in message.
References notifyLevelPtr(), and numEntries().
Referenced by nextEntry(), and setLog().
| char * DtAssistantLogMsg::textPtr | ( | ) | [protected, virtual] |
References notifyLevelPtr(), and numEntries().
| unsigned DtAssistantLogMsg::textSize | ( | ) | const [virtual] |
Get total size of text.
References netAssistantLogMsg(), and DtNetAssistantLogMsg::textSize.
Referenced by DtAssistantNetworkCompViewMgr::processRtiexecLogMsg(), and setLog().
unsigned DtAssistantLogMsg::myNextNum [mutable, protected] |
The next entry to read from the message.
Referenced by nextEntry().
const char* DtAssistantLogMsg::myNextTextPtr [mutable, protected] |
The next text location to read from the message.
Referenced by nextEntry().