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

Public Member Functions

 DtNetworkMapRspMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtNetworkMapRspMsg (unsigned long sourceId, unsigned long requestorId, const MAKRti::DtString &xml, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtNetworkMapRspMsg (const DtNetNetworkMapRspMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtNetworkMapRspMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual unsigned long sourceId () const
 Set/Get source connection handle for the source of the current hop in the overall request.
virtual void setSourceId (unsigned long connId)
virtual unsigned long requestorId () const
 Set/Get originating requestor connection handle - this is essentially a unique ID for the request ( there may be multiple intermediate requests in flight from the same source, but only one request at a time per requestor)
virtual void setRequestorId (unsigned long connId)
virtual const MAKRti::DtString & payload () const
 Set/Get the payload data.
virtual void setPayload (const MAKRti::DtString &xml)
virtual void printData (DtLogicalTimeFactory *logicalTimeFactory) const
 Print the data section.
- Public Member Functions inherited from DtRtiMsg
virtual ~DtRtiMsg ()
 Destructor.
virtual DtRtiMsgcloneWithTransport (bool copy=true) const
 Return a copy/empty object of the same type as this using clone and set the transport type from the host message.
virtual DtNetMsgHeadernetHeader () 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 void setFedEx (const MAKRti::DtString &name)
 All RTI messages contain information to identify which federation execution the message applies to.
virtual void setFedEx (int handle)
 Set federation execution identifier as a handle.
virtual bool isForExec (const MAKRti::DtString &execName, int execHandle) const
 Returns true if the current message belongs to the indicated federation execution, false otherwise.
virtual DtRtiMsgKind msgKind () const
 Get the message kind.
virtual const char * kindString () const
 Returns the message kind string name.
virtual bool isConstrained () const
 Return boolean: message type can be time constrained?
virtual bool isAllowedDuringSave () const
 Return boolean: message type can be processed during save?
virtual void setTime (const RTI::FedTime &time)
 Set/Get time Used in timestamped messages.
virtual RTI::FedTime const * time (DtLogicalTimeFactory *fedTimeFactory) const
virtual bool hasTime () const
 Returns true if time field is valid.
virtual void setSerialNumber (unsigned long serialNumberValue)
 Set/Get event retraction serial number Used in timestamped messages.
virtual unsigned long serialNumber () const
virtual void setTransportType (DtTransportHandle type)
 Set/Get transport type.
virtual DtTransportHandle transportType () const
virtual DtOrderHandle orderType () const
 This base implementation always returns recieve order.
virtual bool isMetadataPresent () const
 Test if metadata has been added to a DtRtiMsg object.
virtual bool addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL)
 Allocate space for next block of metadata.
virtual void removeMetadata (unsigned int size)
 Update the size of the message when metadata has been removed.
bool isInteractionMsgType () const
 Utility functions, check the message type against known interaciton/update message types.
bool isUpdateMsgType () const
virtual void print (DtLogicalTimeFactory *logicalTimeFactory) const
 Printing functions.
virtual void printHeader (DtLogicalTimeFactory *logicalTimeFactory) const
virtual void printTime (const char *label, RTI::FedTime const *timeValue) const
 Print the given time.
virtual void printInterval (const char *label, RTI::FedTime const *intervalValue) const
 Print the interval.
virtual int status () const
 Returns MSG_STATUS_OK if OK, a reason enumeration otherwise.
virtual const MAKRti::DtString fedExName () const
 These two functions should be avoided in favor of isForExec().
virtual int fedExHandle () const
 Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name.
virtual void setFederateHandle (DtFederateHandle handle)
 Set/Get federate handle.
virtual DtFederateHandle federateHandle () const
 Set/Get federate handle.
virtual void setSequenceNumber (unsigned long value)
 Set/Get message sequence number.
virtual unsigned long sequenceNumber () const
 Set/Get message sequence number.
virtual void setServiceCallNumber (unsigned long value)
 Set/Get service call number.
virtual unsigned long serviceCallNumber () const
 Set/Get service call number.
virtual void setTriggerMessageNumber (unsigned long value)
 Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).
virtual unsigned long triggerMessageNumber () const
 Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent).

Static Public Member Functions

static DtRtiMsgcreate (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static DtRtiMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void addCallback (DtConnectionMgr *conn, DtNetworkMapResponseCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtNetworkMapResponseCb cb, void *usr)
- Static Public Member Functions inherited from DtRtiMsg
static const DtNetMsgHeadernetHeader (const void *buffer)
 Extracts the header network representation from the buffer.
static const char * kindToString (DtRtiMsgKind kind)
 Returns the name of the message, by kind enumeration.
static const char * kindString (const void *buffer)
 Extracts the message kind from the given buffer and returns its string name.
static const DtRtiMsgKind msgKind (const void *buffer)
 Extracts the message kind from the given buffer.
static unsigned int version (const void *buffer)
 Extracts the message version form the given buffer.
static unsigned int fedExHandle (const void *buffer)
 Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name)
static DtFederateHandle federateHandle (const void *buffer)
 Extracts the message federate handle form the given buffer.
static unsigned long sequenceNumber (const void *buffer)
 Extracts the message sequence number form the given buffer.
static void setDefaultRegionSet (unsigned long defaultRegionSet)
 Set the default region set handle.
static void setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled)
 Set/Get flag to enable use of 32 bit size field for attribute/parameter values.
static bool use32BitsForValueSize ()
static void setSmartForwardingEnabled (bool enabled)
 Set/Get is SmartForwarding enabled?
static bool smartForwardingEnabled ()

Protected Member Functions

virtual DtNetNetworkMapRspMsgnetNetworkMapRspMsg ()
 The network representation.
virtual const
DtNetNetworkMapRspMsg
netNetworkMapRspMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an DtNetworkMapRspMsg Msg.
virtual char * netMsgPayload ()
 Get a pointer to the message payload.
virtual int minSize () const
 Returns minimum size of a message, including header.
- Protected Member Functions inherited from DtRtiMsg
 DtRtiMsg ()
 Constructor.
virtual void sizeChanged (int size)
 Called whenever size is changed using changeSize, or insert/deleteBytes.
void initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer)
 Called by ctor, so not virtual.
void initDtRtiMsg (const void *initial, int size, DtBufferPtr buffer)
void initDtRtiMsg (const DtNetMsgHeader *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 addres.

Protected Attributes

MAKRti::DtString myXmlResponse
 Network Map XML response data.
- Protected Attributes inherited from DtRtiMsg
DtTransportHandle myTransportType
DtOrderHandle myOrderType
RTI::FedTimemyFedTime
bool myTimeIsValid
bool myConstrained
bool myAllowedDuringSave
unsigned long mySerialNumber
unsigned long myServiceCallNumber
unsigned long myTriggerMessage

Additional Inherited Members

- Static Public Attributes inherited from DtRtiMsg
static unsigned long theDefaultRegionSetHandle = 0
static const char * theDefaultTag = NULL
- Static Protected Attributes inherited from DtRtiMsg
static bool theUse32BitsForValueSize = false
static bool theSmartForwardingEnabled = false

Constructor & Destructor Documentation

DtNetworkMapRspMsg::DtNetworkMapRspMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and minSize().

Referenced by clone(), and create().

DtNetworkMapRspMsg::DtNetworkMapRspMsg ( unsigned long  sourceId,
unsigned long  requestorId,
const MAKRti::DtString &  xml,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtNetworkMapRspMsg::DtNetworkMapRspMsg ( const DtNetNetworkMapRspMsg netRep,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtNetworkMapRspMsg::~DtNetworkMapRspMsg ( )
virtual

Destructor.

Member Function Documentation

void DtNetworkMapRspMsg::addCallback ( DtConnectionMgr conn,
DtNetworkMapResponseCb  cb,
void *  usr 
)
static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtNetworkMapRspMsgKind.

DtRtiMsg * DtNetworkMapRspMsg::clone ( bool  copy = true) const
virtual

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

Implements DtRtiMsg.

References DtNetworkMapRspMsg(), and netNetworkMapRspMsg().

DtRtiMsg * DtNetworkMapRspMsg::create ( const DtNetMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static

Creator.

References DtNetworkMapRspMsg().

DtRtiMsg * DtNetworkMapRspMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static

References DtNetworkMapRspMsg().

DtRtiMsgKind DtNetworkMapRspMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an DtNetworkMapRspMsg Msg.

Implements DtRtiMsg.

References DtNetworkMapRspMsgKind.

Referenced by DtNetworkMapRspMsg().

int DtNetworkMapRspMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtNetworkMapRspMsg().

char * DtNetworkMapRspMsg::netMsgPayload ( )
protectedvirtual

Get a pointer to the message payload.

References netNetworkMapRspMsg(), and DtNetNetworkMapRspMsg::payloadLength.

Referenced by DtNetworkMapRspMsg(), and setPayload().

DtNetNetworkMapRspMsg * DtNetworkMapRspMsg::netNetworkMapRspMsg ( )
protectedvirtual
const DtNetNetworkMapRspMsg * DtNetworkMapRspMsg::netNetworkMapRspMsg ( ) const
protectedvirtual
const MAKRti::DtString & DtNetworkMapRspMsg::payload ( ) const
virtual

Set/Get the payload data.

References myXmlResponse.

Referenced by printData().

void DtNetworkMapRspMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const
virtual

Print the data section.

Reimplemented from DtRtiMsg.

References payload(), requestorId(), and sourceId().

void DtNetworkMapRspMsg::removeCallback ( DtConnectionMgr conn,
DtNetworkMapResponseCb  cb,
void *  usr 
)
static
unsigned long DtNetworkMapRspMsg::requestorId ( ) const
virtual

Set/Get originating requestor connection handle - this is essentially a unique ID for the request ( there may be multiple intermediate requests in flight from the same source, but only one request at a time per requestor)

References netNetworkMapRspMsg(), and DtNetNetworkMapRspMsg::requestorId.

Referenced by printData().

void DtNetworkMapRspMsg::setPayload ( const MAKRti::DtString &  xml)
virtual
void DtNetworkMapRspMsg::setRequestorId ( unsigned long  connId)
virtual
void DtNetworkMapRspMsg::setSourceId ( unsigned long  connId)
virtual
unsigned long DtNetworkMapRspMsg::sourceId ( ) const
virtual

Set/Get source connection handle for the source of the current hop in the overall request.

References netNetworkMapRspMsg(), and DtNetNetworkMapRspMsg::sourceId.

Referenced by printData().

Member Data Documentation

MAKRti::DtString DtNetworkMapRspMsg::myXmlResponse
protected

Network Map XML response data.

Referenced by DtNetworkMapRspMsg(), payload(), and setPayload().


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

Document ID: Generated on Wed Mar 11 20:26:49 EDT 2015 from SVN revision 150939
Copyright © 2005-2015 VT MÄK Inc. All Rights Reserved (www.mak.com)