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

Public Member Functions

 DtQueryTransportMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtQueryTransportMsg (DtFederateHandle targetFed, DtQueryTransMsgKind kind, DtObjectInstanceHandle objHand, DtAttributeHandle handle, DtTransportType transType, DtFederateHandle sendingFed=0, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtQueryTransportMsg (const DtNetQueryTransportMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtQueryTransportMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (DtFederateHandle targetFed, DtQueryTransMsgKind kind, DtObjectInstanceHandle objHand, DtAttributeHandle handle, DtTransportType transType, DtFederateHandle sendingFed=0)
 Set all fields simultaneously.
virtual void setQueryTransportMsgKind (DtQueryTransMsgKind kind)
 Set/Get kind.
virtual DtQueryTransMsgKind queryTransportMsgKind () const
virtual void setObjHandle (DtObjectInstanceHandle id)
 Set/Get handle.
virtual DtObjectInstanceHandle objHandle () const
virtual void setClassHandle (DtObjectClassHandle handle)
virtual DtObjectClassHandle classHandle () const
virtual void setRecipientFederate (DtFederateHandle hand)
 Set/Get recipient federate handle.
virtual DtFederateHandle recipientFederate () const
virtual void setSendingFederate (DtFederateHandle handle)
 Set/Get sending federate handle.
virtual DtFederateHandle sendingFederate () const
virtual void setHandle (const DtAttributeHandle &handle)
 Set/Get attribute handles.
virtual const DtAttributeHandlehandle () const
virtual void setTransportType (DtTransportType type)
 Set/Get the Transportation Type.
virtual DtTransportType transportationType () const
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)
 Creator.
static void addCallback (DtConnectionMgr *conn, DtQueryTransportCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtQueryTransportCb 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 int tagFieldSize () const
 Returns size of tag field.
virtual DtNetQueryTransportMsgnetQueryTransportMsg ()
 The network representation.
virtual const
DtNetQueryTransportMsg
netQueryTransportMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an Ownership Msg.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual DtQueryTransportMsgself () 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

int myDirty
DtAttributeHandlemyHandle
DtTransportType myTransportType
- 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

DtQueryTransportMsg::DtQueryTransportMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

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

Referenced by clone(), and create().

DtQueryTransportMsg::DtQueryTransportMsg ( DtFederateHandle  targetFed,
DtQueryTransMsgKind  kind,
DtObjectInstanceHandle  objHand,
DtAttributeHandle  handle,
DtTransportType  transType,
DtFederateHandle  sendingFed = 0,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtQueryTransportMsg::DtQueryTransportMsg ( const DtNetQueryTransportMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtQueryTransportMsg::~DtQueryTransportMsg ( )
virtual

Destructor.

Member Function Documentation

void DtQueryTransportMsg::addCallback ( DtConnectionMgr conn,
DtQueryTransportCb  cb,
void *  usr 
)
static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtQueryTransportMsgKind.

Referenced by DtObjectMgr::DtObjectMgr().

DtObjectClassHandle DtQueryTransportMsg::classHandle ( ) const
virtual
DtRtiMsg * DtQueryTransportMsg::clone ( bool  copy = true) const
virtual

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

Implements DtRtiMsg.

References DtQueryTransportMsg(), and netQueryTransportMsg().

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

Creator.

References DtQueryTransportMsg().

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

Creator.

References DtQueryTransportMsg().

const DtAttributeHandle & DtQueryTransportMsg::handle ( ) const
virtual
DtRtiMsgKind DtQueryTransportMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an Ownership Msg.

Implements DtRtiMsg.

References DtQueryTransportMsgKind.

Referenced by DtQueryTransportMsg().

int DtQueryTransportMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtQueryTransportMsg().

DtNetQueryTransportMsg * DtQueryTransportMsg::netQueryTransportMsg ( )
protectedvirtual
const DtNetQueryTransportMsg * DtQueryTransportMsg::netQueryTransportMsg ( ) const
protectedvirtual
DtObjectInstanceHandle DtQueryTransportMsg::objHandle ( ) const
virtual
void DtQueryTransportMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const
virtual
DtQueryTransMsgKind DtQueryTransportMsg::queryTransportMsgKind ( ) const
virtual
DtFederateHandle DtQueryTransportMsg::recipientFederate ( ) const
virtual
void DtQueryTransportMsg::removeCallback ( DtConnectionMgr conn,
DtQueryTransportCb  cb,
void *  usr 
)
static
DtQueryTransportMsg * DtQueryTransportMsg::self ( ) const
inlineprotectedvirtual

Casts away const-ness.

DtFederateHandle DtQueryTransportMsg::sendingFederate ( ) const
virtual
void DtQueryTransportMsg::set ( DtFederateHandle  targetFed,
DtQueryTransMsgKind  kind,
DtObjectInstanceHandle  objHand,
DtAttributeHandle  handle,
DtTransportType  transType,
DtFederateHandle  sendingFed = 0 
)
virtual
void DtQueryTransportMsg::setClassHandle ( DtObjectClassHandle  handle)
virtual
void DtQueryTransportMsg::setHandle ( const DtAttributeHandle handle)
virtual

Set/Get attribute handles.

References DtNetQueryTransportMsg::handle, myDirty, and netQueryTransportMsg().

Referenced by DtQueryTransportMsg(), and set().

void DtQueryTransportMsg::setObjHandle ( DtObjectInstanceHandle  id)
virtual

Set/Get handle.

References DtNetQueryTransportMsg::id, and netQueryTransportMsg().

Referenced by DtQueryTransportMsg(), and set().

void DtQueryTransportMsg::setQueryTransportMsgKind ( DtQueryTransMsgKind  kind)
virtual

Set/Get kind.

References netQueryTransportMsg(), and DtNetQueryTransportMsg::queryMsgKind.

Referenced by DtQueryTransportMsg(), and set().

void DtQueryTransportMsg::setRecipientFederate ( DtFederateHandle  hand)
virtual

Set/Get recipient federate handle.

References netQueryTransportMsg(), and DtNetQueryTransportMsg::recvFed.

Referenced by DtQueryTransportMsg(), and set().

void DtQueryTransportMsg::setSendingFederate ( DtFederateHandle  handle)
virtual

Set/Get sending federate handle.

References netQueryTransportMsg(), and DtNetQueryTransportMsg::sendFed.

Referenced by DtQueryTransportMsg(), and set().

void DtQueryTransportMsg::setTransportType ( DtTransportType  type)
virtual

Set/Get the Transportation Type.

References netQueryTransportMsg(), and DtNetQueryTransportMsg::transportType.

Referenced by DtQueryTransportMsg(), and set().

int DtQueryTransportMsg::tagFieldSize ( ) const
protectedvirtual

Returns size of tag field.

References netQueryTransportMsg(), and DtNetQueryTransportMsg::tagSize.

DtTransportType DtQueryTransportMsg::transportationType ( ) const
virtual

Member Data Documentation

int DtQueryTransportMsg::myDirty
protected

Referenced by handle(), and setHandle().

DtAttributeHandle* DtQueryTransportMsg::myHandle
protected

Referenced by handle(), and printData().

DtTransportType DtQueryTransportMsg::myTransportType
protected

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

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)