MAK RTIspy API Documentation for HLA Evolved
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtTransferRidParamsMsg Class Reference

Sent by Federates to request testing of the RID file from RtiExec. More...

+ Inheritance diagram for DtTransferRidParamsMsg:
+ Collaboration diagram for DtTransferRidParamsMsg:

Public Member Functions

 DtTransferRidParamsMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Default / Send constructor.
 DtTransferRidParamsMsg (const DtNetTransferRidParamsMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Recv Constructor (from incoming message)
virtual ~DtTransferRidParamsMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual int minSize () const
virtual void setDestinationID (const DtFederateHandle &destination)
 Set/Get destination Federate Id ( 0 == RtiExec )
virtual DtFederateHandle destinationID () const
virtual void writeRidTestBlock (const char *ridTestBlock, unsigned int blockSize)
 Write / Read Rid Test block contents.
virtual const char * readRidTestBlock () 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 for receiving.
static DtRtiMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator for sending.
static void addCallback (DtConnectionMgr *conn, DtRidTestRespCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtRidTestRespCb 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 DtNetTransferRidParamsMsgnetTransferMsg ()
 The network representation.
virtual const
DtNetTransferRidParamsMsg
netTransferMsg () const
virtual char * fileBufferPtr () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an Create Msg.
virtual DtTransferRidParamsMsgself () 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.

Additional Inherited Members

- Static Public Attributes inherited from DtRtiMsg
static unsigned long theDefaultRegionSetHandle = 0
static const char * theDefaultTag = NULL
- 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
- Static Protected Attributes inherited from DtRtiMsg
static bool theUse32BitsForValueSize = false
static bool theSmartForwardingEnabled = false

Detailed Description

Sent by Federates to request testing of the RID file from RtiExec.

Constructor & Destructor Documentation

DtTransferRidParamsMsg::DtTransferRidParamsMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Default / Send constructor.

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

Referenced by clone(), and create().

DtTransferRidParamsMsg::DtTransferRidParamsMsg ( const DtNetTransferRidParamsMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Recv Constructor (from incoming message)

References DtNetTransferRidParamsMsg::header, and DtRtiMsg::initDtRtiMsg().

DtTransferRidParamsMsg::~DtTransferRidParamsMsg ( )
virtual

Destructor.

Member Function Documentation

void DtTransferRidParamsMsg::addCallback ( DtConnectionMgr conn,
DtRidTestRespCb  cb,
void *  usr 
)
static
DtRtiMsg * DtTransferRidParamsMsg::clone ( bool  copy = true) const
virtual

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

Implements DtRtiMsg.

References DtTransferRidParamsMsg(), and netTransferMsg().

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

Creator for receiving.

References DtTransferRidParamsMsg().

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

Creator for sending.

References DtTransferRidParamsMsg().

DtFederateHandle DtTransferRidParamsMsg::destinationID ( ) const
virtual
char * DtTransferRidParamsMsg::fileBufferPtr ( ) const
protectedvirtual
DtRtiMsgKind DtTransferRidParamsMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an Create Msg.

Implements DtRtiMsg.

References DtTransferRidParamsMsgKind.

Referenced by DtTransferRidParamsMsg().

int DtTransferRidParamsMsg::minSize ( ) const
virtual

Referenced by DtTransferRidParamsMsg().

DtNetTransferRidParamsMsg * DtTransferRidParamsMsg::netTransferMsg ( )
protectedvirtual

The network representation.

Referenced by clone(), destinationID(), fileBufferPtr(), and setDestinationID().

const DtNetTransferRidParamsMsg * DtTransferRidParamsMsg::netTransferMsg ( ) const
protectedvirtual
void DtTransferRidParamsMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const
virtual

Print the data section.

Reimplemented from DtRtiMsg.

References destinationID(), and fileBufferPtr().

const char * DtTransferRidParamsMsg::readRidTestBlock ( ) const
virtual
void DtTransferRidParamsMsg::removeCallback ( DtConnectionMgr conn,
DtRidTestRespCb  cb,
void *  usr 
)
static
DtTransferRidParamsMsg * DtTransferRidParamsMsg::self ( ) const
inlineprotectedvirtual

Casts away const-ness.

void DtTransferRidParamsMsg::setDestinationID ( const DtFederateHandle destination)
virtual

Set/Get destination Federate Id ( 0 == RtiExec )

References DtNetTransferRidParamsMsg::destination, and netTransferMsg().

Referenced by DtRtiExec::ridRequestCb(), and DtFedExec::sendTransferRidParamsMsg().

void DtTransferRidParamsMsg::writeRidTestBlock ( const char *  ridTestBlock,
unsigned int  blockSize 
)
virtual

Write / Read Rid Test block contents.

References fileBufferPtr(), and rti1516e::insertBytes().

Referenced by DtRtiExec::ridRequestCb(), and DtFedExec::sendTransferRidParamsMsg().


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)