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
DtAssistantTestMgrStatusMsg Class Reference

The DtAssistantTestMgrStatusMsg defines a msg for a client to report the results of a latency test. More...

+ Inheritance diagram for DtAssistantTestMgrStatusMsg:
+ Collaboration diagram for DtAssistantTestMgrStatusMsg:

Public Member Functions

 DtAssistantTestMgrStatusMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors. More...
 
 DtAssistantTestMgrStatusMsg (bool testingEnabled, bool testCapable, bool isContinuous, bool inProgress, int numInitiated=0, int numReports=0, unsigned long federationHdl=0, unsigned long federateHdl=0, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
 DtAssistantTestMgrStatusMsg (const DtNetAssistantTestMgrStatusMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 
virtual ~DtAssistantTestMgrStatusMsg ()
 Destructor. More...
 
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this. More...
 
virtual void printData () const
 Print the data section. More...
 
virtual bool testingEnabled () const
 Is the LRC's test manager enabled? More...
 
virtual bool testCapable () const
 Is the LRC currently capable of running a test? More...
 
virtual bool continuousTesting () const
 Is the LRC's test manager currently running a continuous test? More...
 
virtual bool testInProgress () const
 Is the LRC currently running a test? More...
 
virtual unsigned numTestsInitiated () const
 Number of tests the federate has initiated. More...
 
virtual unsigned numTestReports () const
 Number of test reports the federate has generated. More...
 
virtual unsigned long federationHdl () const
 The handle of the federation that this message is concerning. More...
 
virtual unsigned long federateHdl () const
 The handle of the federate that this message is concerning. 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, DtAssistantTestMgrStatusCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type. More...
 
static void removeCallback (DtRtiAssistantServer *conn, DtAssistantTestMgrStatusCb cb, void *usr)
 
static void addCallback (DtRtiAssistantPeer *conn, DtAssistantTestMgrStatusCb cb, void *usr)
 Adds or removes a callback with the given Assistant peer for this message type. More...
 
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantTestMgrStatusCb 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
DtNetAssistantTestMgrStatusMsg
netAssistantTestMgrStatusMsg ()
 The network representation for the AssistantTestMgrStatusMsg message. More...
 
virtual const
DtNetAssistantTestMgrStatusMsg
netAssistantTestMgrStatusMsg () const
 
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantTestMgrStatusMsg message. 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 DtAssistantTestMgrStatusMsg defines a msg for a client to report the results of a latency test.

Constructor & Destructor Documentation

DtAssistantTestMgrStatusMsg::DtAssistantTestMgrStatusMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

DtAssistantTestMgrStatusMsg::DtAssistantTestMgrStatusMsg ( bool  testingEnabled,
bool  testCapable,
bool  isContinuous,
bool  inProgress,
int  numInitiated = 0,
int  numReports = 0,
unsigned long  federationHdl = 0,
unsigned long  federateHdl = 0,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtAssistantTestMgrStatusMsg::DtAssistantTestMgrStatusMsg ( const DtNetAssistantTestMgrStatusMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
virtual DtAssistantTestMgrStatusMsg::~DtAssistantTestMgrStatusMsg ( )
virtual

Destructor.

Member Function Documentation

static void DtAssistantTestMgrStatusMsg::addCallback ( DtRtiAssistantServer conn,
DtAssistantTestMgrStatusCb  cb,
void *  usr 
)
static

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

static void DtAssistantTestMgrStatusMsg::addCallback ( DtRtiAssistantPeer conn,
DtAssistantTestMgrStatusCb  cb,
void *  usr 
)
static

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

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

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

Implements DtAssistantMsg.

virtual bool DtAssistantTestMgrStatusMsg::continuousTesting ( ) const
virtual

Is the LRC's test manager currently running a continuous test?

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

Creators.

static DtAssistantMsg* DtAssistantTestMgrStatusMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static
virtual unsigned long DtAssistantTestMgrStatusMsg::federateHdl ( ) const
virtual

The handle of the federate that this message is concerning.

This field is only used if the message is from an rtiexec.

virtual unsigned long DtAssistantTestMgrStatusMsg::federationHdl ( ) const
virtual

The handle of the federation that this message is concerning.

This field is only used if the message is from an rtiexec.

virtual DtAssistantMsgKind DtAssistantTestMgrStatusMsg::internalMsgKind ( )
protectedvirtual

Returns the kind of a DtAssistantTestMgrStatusMsg message.

Implements DtAssistantMsg.

virtual DtNetAssistantTestMgrStatusMsg* DtAssistantTestMgrStatusMsg::netAssistantTestMgrStatusMsg ( )
protectedvirtual

The network representation for the AssistantTestMgrStatusMsg message.

virtual const DtNetAssistantTestMgrStatusMsg* DtAssistantTestMgrStatusMsg::netAssistantTestMgrStatusMsg ( ) const
protectedvirtual
virtual unsigned DtAssistantTestMgrStatusMsg::numTestReports ( ) const
virtual

Number of test reports the federate has generated.

virtual unsigned DtAssistantTestMgrStatusMsg::numTestsInitiated ( ) const
virtual

Number of tests the federate has initiated.

virtual void DtAssistantTestMgrStatusMsg::printData ( ) const
virtual

Print the data section.

Reimplemented from DtAssistantMsg.

static void DtAssistantTestMgrStatusMsg::removeCallback ( DtRtiAssistantServer conn,
DtAssistantTestMgrStatusCb  cb,
void *  usr 
)
static
static void DtAssistantTestMgrStatusMsg::removeCallback ( DtRtiAssistantPeer conn,
DtAssistantTestMgrStatusCb  cb,
void *  usr 
)
static
virtual bool DtAssistantTestMgrStatusMsg::testCapable ( ) const
virtual

Is the LRC currently capable of running a test?

virtual bool DtAssistantTestMgrStatusMsg::testingEnabled ( ) const
virtual

Is the LRC's test manager enabled?

virtual bool DtAssistantTestMgrStatusMsg::testInProgress ( ) const
virtual

Is the LRC currently running a test?


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

Document ID: Generated on Thu May 11 15:55:32 EDT 2023 from SVN revision 254743
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)