MAK RTIspy API Documentation for HLA 1.3
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtPartnerFederateMsg Class Reference
+ Inheritance diagram for DtPartnerFederateMsg:
+ Collaboration diagram for DtPartnerFederateMsg:

Public Member Functions

 DtPartnerFederateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtPartnerFederateMsg (DtFederateHandle partnerHandle, DtPartnerResponse response, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtPartnerFederateMsg (const DtNetPartnerFederateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtPartnerFederateMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (DtFederateHandle partnerHandle, DtPartnerResponse response)
 Set all the fields.
virtual void printData (DtLogicalTimeFactory *logicalTimeFactory) const
 Print the data section.
virtual DtFederateHandle partnerFederate () const
 Get partner federate handle.
virtual void setPartnerFederate (DtFederateHandle fedHandle)
 Set partner federate handle.
virtual DtPartnerResponse partnerResponse () const
 Get partner response.
virtual void setPartnerResponse (DtPartnerResponse response)
 Set partner response.
- 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)
 Creator.
static void addCallback (DtConnectionMgr *conn, DtPartnerFederateCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtPartnerFederateCb cb, void *usr)
- Static Public Member Functions inherited from DtRtiMsg
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 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 DtNetPartnerFederateMsgnetPartnerFederateMsg ()
 The network representation.
virtual const
DtNetPartnerFederateMsg
netPartnerFederateMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an Restore Reply Msg.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual DtPartnerFederateMsgself () const
 Casts away const-ness.
- 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

char * myLabel
- 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

DtPartnerFederateMsg::DtPartnerFederateMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

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

Referenced by clone(), and create().

DtPartnerFederateMsg::DtPartnerFederateMsg ( DtFederateHandle  partnerHandle,
DtPartnerResponse  response,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtPartnerFederateMsg::DtPartnerFederateMsg ( const DtNetPartnerFederateMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtPartnerFederateMsg::~DtPartnerFederateMsg ( )
virtual

Destructor.

Member Function Documentation

void DtPartnerFederateMsg::addCallback ( DtConnectionMgr conn,
DtPartnerFederateCb  cb,
void *  usr 
)
static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtPartnerFederateMsgKind.

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

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

Implements DtRtiMsg.

References DtPartnerFederateMsg(), and netPartnerFederateMsg().

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

Creator.

References DtPartnerFederateMsg().

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

Creator.

References DtPartnerFederateMsg().

DtRtiMsgKind DtPartnerFederateMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an Restore Reply Msg.

Implements DtRtiMsg.

References DtPartnerFederateMsgKind.

Referenced by DtPartnerFederateMsg().

int DtPartnerFederateMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtPartnerFederateMsg().

DtNetPartnerFederateMsg * DtPartnerFederateMsg::netPartnerFederateMsg ( )
protectedvirtual

The network representation.

Referenced by clone(), partnerFederate(), partnerResponse(), setPartnerFederate(), and setPartnerResponse().

const DtNetPartnerFederateMsg * DtPartnerFederateMsg::netPartnerFederateMsg ( ) const
protectedvirtual
DtFederateHandle DtPartnerFederateMsg::partnerFederate ( ) const
virtual
DtPartnerResponse DtPartnerFederateMsg::partnerResponse ( ) const
virtual
void DtPartnerFederateMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const
virtual

Print the data section.

Reimplemented from DtRtiMsg.

References DtPartnerResponseInvalid, partnerFederate(), partnerResponse(), and theResponseStrings.

void DtPartnerFederateMsg::removeCallback ( DtConnectionMgr conn,
DtPartnerFederateCb  cb,
void *  usr 
)
static
DtPartnerFederateMsg * DtPartnerFederateMsg::self ( ) const
inlineprotectedvirtual

Casts away const-ness.

void DtPartnerFederateMsg::set ( DtFederateHandle  partnerHandle,
DtPartnerResponse  response 
)
virtual

Set all the fields.

References setPartnerFederate(), and setPartnerResponse().

Referenced by DtPartnerMgr::sendPartnerMessage().

void DtPartnerFederateMsg::setPartnerFederate ( DtFederateHandle  fedHandle)
virtual

Set partner federate handle.

References netPartnerFederateMsg(), and DtNetPartnerFederateMsg::partnerHandle.

Referenced by set().

void DtPartnerFederateMsg::setPartnerResponse ( DtPartnerResponse  response)
virtual

Set partner response.

References netPartnerFederateMsg(), and DtNetPartnerFederateMsg::response.

Referenced by set().

Member Data Documentation

char* DtPartnerFederateMsg::myLabel
protected

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

Document ID: Generated on Tue May 7 16:26:47 EDT 2013 from SVN revision 126903
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)