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
DtAssistantStartRtiForwarderMsg Class Reference
+ Inheritance diagram for DtAssistantStartRtiForwarderMsg:
+ Collaboration diagram for DtAssistantStartRtiForwarderMsg:

Public Member Functions

 DtAssistantStartRtiForwarderMsg (MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 CTOR.
 DtAssistantStartRtiForwarderMsg (const DtNetAssistantStartRtiexecMsg *netRep, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 CTOR.
virtual ~DtAssistantStartRtiForwarderMsg ()
 Virtual DTOR.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
- Public Member Functions inherited from DtAssistantStartRtiexecMsg
 DtAssistantStartRtiexecMsg (MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 CTOR.
 DtAssistantStartRtiexecMsg (const DtNetAssistantStartRtiexecMsg *netRep, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 CTOR.
virtual ~DtAssistantStartRtiexecMsg ()
 Virtual DTOR.
virtual void setHostName (const DtString &name)
 Set the host name.
virtual MAKRti::DtString hostName () const
 Get the host name.
virtual void setTcpAddress (const MAKRti::DtInetAddr &ipAddr)
 Set TCP IP address.
virtual MAKRti::DtInetAddr tcpAddress () const
 Get TCP IP address.
virtual void setTcpPort (int port)
 Set TCP port number.
virtual int tcpPort () const
 Get TCP port number.
virtual void setTcpInterfaceAddress (const MAKRti::DtInetAddr &ipAddr)
 Set TCP interface IP address.
virtual MAKRti::DtInetAddr tcpInterfaceAddress () const
 Get TCP interface IP address.
virtual void setUdpAddress (const MAKRti::DtInetAddr &ipAddr)
 Set UDP IP address.
virtual MAKRti::DtInetAddr udpAddress () const
 Get UDP IP address.
virtual void setUdpPort (int port)
 Set UDP port number.
virtual int udpPort () const
 Get UDP port number.
virtual void setUdpInterfaceAddress (const MAKRti::DtInetAddr &ipAddr)
 Set UDP interface IP address.
virtual MAKRti::DtInetAddr udpInterfaceAddress () const
 Get UDP interface IP address.
virtual void setForwarderPort (int port)
 Set the forwarder port.
virtual int forwarderPort () const
 Get the forwarder port.
virtual void setForwarderToConnectTo (const MAKRti::DtInetAddr &ipAddr)
 Set other forwarder to connect to.
virtual MAKRti::DtInetAddr forwarderToConnectTo () const
 Get the other forwarder to connect to.
virtual void setFullCompliance (bool val)
 Set the flag indicating if rtiexec is running with full compliance.
virtual bool fullCompliance () const
 Get the flag indicating if rtiexec is running with full compliance.
virtual void setIsRidPreconfigured (bool val)
 Set the flag indicating the RID configuration is a preconfigured one.
virtual bool isRidPreconfigured () const
 Get the flag indicating the RID configuration is a preconfigured one.
virtual void setRidConfigurationName (const MAKRti::DtString &name)
 Set the RID configuration name.
virtual MAKRti::DtString ridConfigurationName () const
 Get the RID configuration name.
virtual void setRidLisp (const MAKRti::DtString &lispStr)
 Set the RID lisp string.
virtual MAKRti::DtString ridLisp () const
 Get the RID lisp string.
virtual void setConnectionName (const MAKRti::DtString &name)
 Set the connection name.
virtual MAKRti::DtString connectionName () const
 Get the connection name.
virtual void printData () const
 Print the data section.
- Public Member Functions inherited from DtAssistantMsg
virtual ~DtAssistantMsg ()
 Destructor.
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 printSrcDest () 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)
virtual const DtAssistantUuidsourceUuid () const
 Get/Set the uuid of the source of this message.
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.
virtual void setIsForeign (bool isForeignDestination)
virtual DtU32 sequence () const
 Get/Set sequence number Assistant-to-Assistant messages only.
virtual void setSequence (DtU32 sequenceNumber)

Static Public Member Functions

static DtAssistantMsgcreate (MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Static creation method.
static DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Static creation method.
static void addCallback (DtRtiAssistantPeer *conn, DtAssistantStartRtiForwarderCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type.
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantStartRtiForwarderCb cb, void *usr)
- Static Public Member Functions inherited from DtAssistantStartRtiexecMsg
static void addCallback (DtRtiAssistantPeer *conn, DtAssistantStartRtiexecCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type.
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantStartRtiexecCb 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.

Protected Member Functions

virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantStartRtiForwarderMsg message.
- Protected Member Functions inherited from DtAssistantStartRtiexecMsg
virtual void setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily fam)
 Set the IP address family.
virtual
MAKRti::DtInetUtils::DtInetAddrFamily 
addressFamily () const
 Get the IP address family.
virtual
DtNetAssistantStartRtiexecMsg
netAssistantStartRtiexecMsg ()
 The network representation for the start rtiexec message.
virtual const
DtNetAssistantStartRtiexecMsg
netAssistantStartRtiexecMsg () const
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual void setHostNameSize (unsigned size)
 Set host name size.
virtual unsigned hostNameSize () const
 Get host name size.
virtual void setConnectionNameSize (unsigned size)
 Set connection name size.
virtual unsigned connectionNameSize () const
 Get connection name size.
virtual void setRidConfigurationNameSize (unsigned size)
 Set RID configuration name size.
virtual unsigned ridConfigurationNameSize () const
 Get RID configuration name size.
virtual void setRidLispSize (unsigned size)
 Set RID lisp size.
virtual unsigned ridLispSize () const
 Get RID lisp size.
virtual const char * hostNamePtr () const
 Return pointer to host name location in message.
virtual char * hostNamePtr ()
 Return pointer to host name location in message.
virtual const char * connectionNamePtr () const
 Return pointer to connection name location in message.
virtual char * connectionNamePtr ()
 Return pointer to connection name location in message.
virtual const char * ridConfigurationNamePtr () const
 Return pointer to RID configuration name location in message.
virtual char * ridConfigurationNamePtr ()
 Return pointer to RID configuration name location in message.
virtual const char * ridLispPtr () const
 Return pointer to RID lisp location in message.
virtual char * ridLispPtr ()
 Return pointer to RID lisp location in message.
- Protected Member Functions inherited from DtAssistantMsg
 DtAssistantMsg ()
 Constructor.
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 ()

Constructor & Destructor Documentation

DtAssistantStartRtiForwarderMsg::DtAssistantStartRtiForwarderMsg ( MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

CTOR.

DtAssistantStartRtiForwarderMsg::DtAssistantStartRtiForwarderMsg ( const DtNetAssistantStartRtiexecMsg netRep,
MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

CTOR.

virtual DtAssistantStartRtiForwarderMsg::~DtAssistantStartRtiForwarderMsg ( )
virtual

Virtual DTOR.

Member Function Documentation

static void DtAssistantStartRtiForwarderMsg::addCallback ( DtRtiAssistantPeer conn,
DtAssistantStartRtiForwarderCb  cb,
void *  usr 
)
static

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

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

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

Reimplemented from DtAssistantStartRtiexecMsg.

static DtAssistantMsg* DtAssistantStartRtiForwarderMsg::create ( MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static

Static creation method.

Reimplemented from DtAssistantStartRtiexecMsg.

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

Static creation method.

Reimplemented from DtAssistantStartRtiexecMsg.

virtual DtAssistantMsgKind DtAssistantStartRtiForwarderMsg::internalMsgKind ( )
protectedvirtual

Returns the kind of a DtAssistantStartRtiForwarderMsg message.

Reimplemented from DtAssistantStartRtiexecMsg.

static void DtAssistantStartRtiForwarderMsg::removeCallback ( DtRtiAssistantPeer conn,
DtAssistantStartRtiForwarderCb  cb,
void *  usr 
)
static

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

Document ID: Generated on Fri Sep 27 00:57:56 EDT 2019 from SVN revision 201708
Copyright © 2005-2018 VT MÄK Inc. All Rights Reserved (www.mak.com)