MAK RTIspy API Documentation for HLA Evolved
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantMsg Class Reference

Base class for assistant Messages. More...

+ Inheritance diagram for DtAssistantMsg:
+ Collaboration diagram for DtAssistantMsg:

List of all members.

Public Member Functions

virtual ~DtAssistantMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const =0
 Return a copy/empty object of the same type as this.
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 void printData () 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 const char * kindToString (DtAssistantMsgKind kind)
 Returns the name of the message, by kind enumeration.

Protected Member Functions

 DtAssistantMsg ()
 Constructor.
virtual DtAssistantMsgKind internalMsgKind ()=0
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

Base class for assistant Messages.


Constructor & Destructor Documentation

Destructor.

Constructor.


Member Function Documentation

void DtAssistantMsg::adjustBytes ( int  offset,
int  numBytes 
) [inline, protected, virtual]

Adjust numBytes bytes at the indicated offset in the net rep.

Uses insertBytes or deleteBytes based on sign of numBytes

References rti1516e::insertBytes().

Referenced by DtAssistantLatencyReportMsg::resize().

void DtAssistantMsg::adjustBytes ( void *  address,
int  numBytes 
) [inline, protected, virtual]

Adjust the numBytes starting at the indicated address.

Assumes that address falls within the net rep. Uses insertBytes or deleteBytes based on sign of numBytes

References rti1516e::insertBytes().

virtual DtAssistantMsg* DtAssistantMsg::clone ( bool  copy = true) const [pure virtual]

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

NOTE: The transport type is not carried in the network representation used to make clones; therefore, it must be set after the clone is made

Implemented in DtAssistantCommandMsg, DtAssistantTestMgrStatusMsg, DtAssistantShowDialogMsg, DtAssistantLatencyReportMsg, DtAssistantChangeLatencyTestModeMsg, DtAssistantShutdownMsg, DtAssistantStateObserveMsg, DtAssistantLogMsg, DtAssistantLrcCompInfoMsg, DtAssistantNotifyMsg, DtAssistantPopupMsg, DtAssistantAwaitingForwardersMsg, DtAssistantConnMsg, DtAssistantRtiexecCompInfoMsg, DtAssistantRtiForwarderCompInfoMsg, DtAssistantConnQueryMsg, DtAssistantLightweightInfoMsg, DtAssistantShmCompInfoMsg, DtAssistantWwwCompInfoMsg, DtAssistantExecStateMsg, DtAssistantFederateStateMsg, DtAssistantFederationStateMsg, DtAssistantForwarderStateMsg, DtAssistantInfoMsg, DtAssistantLicQueryMsg, DtAssistantNtfyLvlUpdateMsg, DtAssistantRidParamsMsg, DtAssistantStartRtiexecMsg, DtAssistantSyncPtUpdateMsg, DtAssistantDeleteFederateMsg, DtAssistantDeleteFederationMsg, DtAssistantExecObserveRspMsg, DtAssistantExitMsg, DtAssistantTimeStateMsg, DtAssistantLicServerInfoMsg, DtAssistantLogEnableMsg, DtAssistantLogRequestMsg, DtAssistantNetworkTestEnableMsg, DtAssistantNotifyObserveMsg, DtAssistantQueryMsg, DtAssistantSignalTickedMsg, DtAssistantRemovalMsg, and DtAssistantFederateSignalTickIntervalMsg.

Referenced by DtAssistantMsgQueue::addMsg(), DtRtiAssistantPeer::forwardMsg(), and DtRtiAssistantClient::processRespMsg().

int DtAssistantMsg::compId ( ) const [virtual]
DtInetAddr DtAssistantMsg::destAddr ( ) const [virtual]

Get/Set the IP address of the destination of this message.

Assistant-to-Assistant messages only.

References DtNetAssistantSrcDestInfo::destAddr, DtNetAssistantSrcDestInfo::inetAddrFamily, and srcDestInfoPtr().

Referenced by DtRtiAssistantPeer::needsProcessing(), and DtRtiAssistantPeer::sendMsg().

int DtAssistantMsg::destId ( ) const [virtual]

Get/Set the ID of the destination of this message.

Assistant-to-Assistant messages only.

References DtNetAssistantSrcDestInfo::destId, and srcDestInfoPtr().

void DtAssistantMsg::initAssistantMsg ( int  size,
DtAssistantMsgKind  msgKindVal,
DtBufferPtr  buffer 
) [protected]

Called by ctor, so not virtual.

References DtAssistantMessageVersion, DtNetAssistantMsgHeader::msgKind, netHeader(), and DtNetAssistantMsgHeader::version.

Referenced by DtAssistantAwaitingForwardersMsg::DtAssistantAwaitingForwardersMsg(), DtAssistantChangeLatencyTestModeMsg::DtAssistantChangeLatencyTestModeMsg(), DtAssistantCommandMsg::DtAssistantCommandMsg(), DtAssistantConnMsg::DtAssistantConnMsg(), DtAssistantConnQueryMsg::DtAssistantConnQueryMsg(), DtAssistantDeleteFederateMsg::DtAssistantDeleteFederateMsg(), DtAssistantDeleteFederationMsg::DtAssistantDeleteFederationMsg(), DtAssistantExecObserveRspMsg::DtAssistantExecObserveRspMsg(), DtAssistantExitMsg::DtAssistantExitMsg(), DtAssistantFederateSignalTickIntervalMsg::DtAssistantFederateSignalTickIntervalMsg(), DtAssistantFederateStateMsg::DtAssistantFederateStateMsg(), DtAssistantFederationStateMsg::DtAssistantFederationStateMsg(), DtAssistantForwarderStateMsg::DtAssistantForwarderStateMsg(), DtAssistantInfoMsg::DtAssistantInfoMsg(), DtAssistantLatencyReportMsg::DtAssistantLatencyReportMsg(), DtAssistantLicQueryMsg::DtAssistantLicQueryMsg(), DtAssistantLicServerInfoMsg::DtAssistantLicServerInfoMsg(), DtAssistantLightweightInfoMsg::DtAssistantLightweightInfoMsg(), DtAssistantLogEnableMsg::DtAssistantLogEnableMsg(), DtAssistantLogMsg::DtAssistantLogMsg(), DtAssistantLogRequestMsg::DtAssistantLogRequestMsg(), DtAssistantLrcCompInfoMsg::DtAssistantLrcCompInfoMsg(), DtAssistantNetworkTestEnableMsg::DtAssistantNetworkTestEnableMsg(), DtAssistantNotifyMsg::DtAssistantNotifyMsg(), DtAssistantNotifyObserveMsg::DtAssistantNotifyObserveMsg(), DtAssistantNtfyLvlUpdateMsg::DtAssistantNtfyLvlUpdateMsg(), DtAssistantPopupMsg::DtAssistantPopupMsg(), DtAssistantQueryMsg::DtAssistantQueryMsg(), DtAssistantRemovalMsg::DtAssistantRemovalMsg(), DtAssistantRidParamsMsg::DtAssistantRidParamsMsg(), DtAssistantRtiexecCompInfoMsg::DtAssistantRtiexecCompInfoMsg(), DtAssistantRtiForwarderCompInfoMsg::DtAssistantRtiForwarderCompInfoMsg(), DtAssistantShmCompInfoMsg::DtAssistantShmCompInfoMsg(), DtAssistantShowDialogMsg::DtAssistantShowDialogMsg(), DtAssistantShutdownMsg::DtAssistantShutdownMsg(), DtAssistantSignalTickedMsg::DtAssistantSignalTickedMsg(), DtAssistantStateObserveMsg::DtAssistantStateObserveMsg(), DtAssistantSyncPtUpdateMsg::DtAssistantSyncPtUpdateMsg(), DtAssistantTestMgrStatusMsg::DtAssistantTestMgrStatusMsg(), DtAssistantTimeStateMsg::DtAssistantTimeStateMsg(), and DtAssistantWwwCompInfoMsg::DtAssistantWwwCompInfoMsg().

void DtAssistantMsg::initAssistantMsg ( const void *  initial,
int  size,
DtBufferPtr  buffer 
) [protected]
void DtAssistantMsg::initAssistantMsg ( const DtNetAssistantMsgHeader header,
DtBufferPtr  buffer 
) [protected]
virtual DtAssistantMsgKind DtAssistantMsg::internalMsgKind ( ) [protected, pure virtual]
bool DtAssistantMsg::isOk ( ) const [inline, virtual]
bool DtAssistantMsg::isValidVersion ( ) const [virtual]

Returns bool: message version is valid?

References DtAssistantMessageVersion, netHeader(), and DtNetAssistantMsgHeader::versionMatches().

const char * DtAssistantMsg::kindToString ( DtAssistantMsgKind  kind) [static]
DtAssistantMsgKind DtAssistantMsg::msgKind ( ) const [inline, virtual]
DtNetAssistantMsgHeader * DtAssistantMsg::netHeader ( ) const [inline, virtual]
void DtAssistantMsg::print ( ) const [virtual]

Printing functions.

References printData(), and printHeader().

void DtAssistantMsg::printData ( ) const [virtual]
void DtAssistantMsg::printHeader ( ) const [virtual]

References kindToString(), msgKind(), and version().

Referenced by print().

void DtAssistantMsg::resizeForSrcDestInfo ( ) [protected, virtual]

Allocates memory at the end of the message for source/destination information needed when sending messages between assistants.

References isAssistantToAssistantMessage(), netHeader(), and DtNetAssistantMsgHeader::srcDestInfoSize.

Referenced by setCompId(), setDestAddr(), setDestId(), setSourceAddr(), setSourceHost(), and setSourceId().

void DtAssistantMsg::setCompId ( int  compId) [virtual]
void DtAssistantMsg::setDestAddr ( const MAKRti::DtInetAddr &  addr) [virtual]
void DtAssistantMsg::setDestId ( int  id) [virtual]
void DtAssistantMsg::setSourceAddr ( const MAKRti::DtInetAddr &  addr) [virtual]
void DtAssistantMsg::setSourceHost ( const MAKRti::DtString &  addr) [virtual]
void DtAssistantMsg::setSourceHostSize ( unsigned long  size) [protected, virtual]

Set/Get source host name text size.

References srcDestInfoPtr(), and DtNetAssistantSrcDestInfo::srcHostSize.

Referenced by setSourceHost().

void DtAssistantMsg::setSourceId ( int  id) [virtual]
void DtAssistantMsg::sizeChanged ( int  size) [protected, virtual]

Called whenever size is changed using changeSize, or insert/deleteBytes.

References netHeader(), and DtNetAssistantMsgHeader::totalSize.

DtInetAddr DtAssistantMsg::sourceAddr ( ) const [virtual]
DtString DtAssistantMsg::sourceHost ( ) const [virtual]
const char * DtAssistantMsg::sourceHostPtr ( ) const [protected, virtual]

Return pointer to source host name in message.

References srcDestInfoPtr().

Referenced by setSourceHost(), and sourceHost().

char * DtAssistantMsg::sourceHostPtr ( ) [protected, virtual]

References srcDestInfoPtr().

unsigned long DtAssistantMsg::sourceHostSize ( ) const [protected, virtual]
int DtAssistantMsg::sourceId ( ) const [virtual]
const DtNetAssistantSrcDestInfo * DtAssistantMsg::srcDestInfoPtr ( ) const [protected, virtual]

Return pointer to source/destination information in the message.

If the message does not contain this info, will return 0.

References isAssistantToAssistantMessage(), netHeader(), and DtNetAssistantMsgHeader::srcDestInfoSize.

Referenced by compId(), destAddr(), destId(), setCompId(), setDestAddr(), setDestId(), setSourceAddr(), setSourceHostSize(), setSourceId(), sourceAddr(), sourceHost(), sourceHostPtr(), sourceHostSize(), and sourceId().

int DtAssistantMsg::version ( ) const [virtual]

Return the message version.

References DtAssistantMessageVersion, and netHeader().

Referenced by printHeader(), and DtAssistantFederateStateMsg::setHlaVersion().


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)