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

Public Member Functions

 DtRegObjMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtRegObjMsg (DtObjectInstanceHandle objHandleValue, const char *objNameValue, DtObjectClassHandle classHandleValue, const DtAttributeHandleSet &attrSet, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtRegObjMsg (const DtNetRegObjMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtRegObjMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (DtObjectInstanceHandle objHandleValue, const char *objNameValue, DtObjectClassHandle classHandleValue, const DtAttributeHandleSet &attrSet)
 Set all fields simultaneously.
virtual void setClassHandle (DtObjectClassHandle hand)
 Set/Get class handle.
virtual DtObjectClassHandle classHandle () const
virtual void setObjHandle (DtObjectInstanceHandle id)
 Set/Get object handle.
virtual DtObjectInstanceHandle objHandle () const
virtual void setObjName (const char *name)
 Set/Get object name.
virtual const char * objName () const
virtual void setAttrHandles (const DtAttributeHandleSet &attrs)
 Set/Get attribute handles.
virtual const
DtAttributeHandleSet
attrHandles () 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, DtRegObjCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtRegObjCb 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 DtNetRegObjMsgnetRegObjMsg ()
 The network representation.
virtual const DtNetRegObjMsgnetRegObjMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an RegObj Msg.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual char * namePtr ()
 Returns pointer to the name in the netMsg.
virtual unsigned long nameFieldSize () const
 Returns size of name field.
virtual DtRegObjMsgself () 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
DtAttributeHandleSetmyAttrs
MAKRti::DtString myName
- 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

DtRegObjMsg::DtRegObjMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

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

Referenced by clone(), and create().

DtRegObjMsg::DtRegObjMsg ( DtObjectInstanceHandle  objHandleValue,
const char *  objNameValue,
DtObjectClassHandle  classHandleValue,
const DtAttributeHandleSet attrSet,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtRegObjMsg::DtRegObjMsg ( const DtNetRegObjMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtRegObjMsg::~DtRegObjMsg ( )
virtual

Destructor.

References myAttrs.

Member Function Documentation

void DtRegObjMsg::addCallback ( DtConnectionMgr conn,
DtRegObjCb  cb,
void *  usr 
)
static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtRegObjMsgKind.

Referenced by DtObjectMgr::DtObjectMgr().

const DtAttributeHandleSet & DtRegObjMsg::attrHandles ( ) const
virtual
DtObjectClassHandle DtRegObjMsg::classHandle ( ) const
virtual
DtRtiMsg * DtRegObjMsg::clone ( bool  copy = true) const
virtual

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

Implements DtRtiMsg.

References DtRegObjMsg(), and netRegObjMsg().

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

Creator.

References DtRegObjMsg().

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

Creator.

References DtRegObjMsg().

DtRtiMsgKind DtRegObjMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an RegObj Msg.

Implements DtRtiMsg.

References DtRegObjMsgKind.

Referenced by DtRegObjMsg().

int DtRegObjMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtRegObjMsg().

unsigned long DtRegObjMsg::nameFieldSize ( ) const
protectedvirtual

Returns size of name field.

References DtNetRegObjMsg::nameSize, and netRegObjMsg().

Referenced by setObjName().

char * DtRegObjMsg::namePtr ( )
protectedvirtual

Returns pointer to the name in the netMsg.

References DtNetRegObjMsg::handleSet, and netRegObjMsg().

Referenced by DtRegObjMsg(), and setObjName().

DtNetRegObjMsg * DtRegObjMsg::netRegObjMsg ( )
protectedvirtual
const DtNetRegObjMsg * DtRegObjMsg::netRegObjMsg ( ) const
protectedvirtual
DtObjectInstanceHandle DtRegObjMsg::objHandle ( ) const
virtual
const char * DtRegObjMsg::objName ( ) const
virtual

References myName.

Referenced by printData(), and DtObjectMgr::processRegister().

void DtRegObjMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const
virtual

Print the data section.

Reimplemented from DtRtiMsg.

References attrHandles(), classHandle(), objHandle(), objName(), and DtRtiMsg::print().

void DtRegObjMsg::removeCallback ( DtConnectionMgr conn,
DtRegObjCb  cb,
void *  usr 
)
static
DtRegObjMsg * DtRegObjMsg::self ( ) const
inlineprotectedvirtual

Casts away const-ness.

void DtRegObjMsg::set ( DtObjectInstanceHandle  objHandleValue,
const char *  objNameValue,
DtObjectClassHandle  classHandleValue,
const DtAttributeHandleSet attrSet 
)
virtual

Set all fields simultaneously.

References setAttrHandles(), setClassHandle(), setObjHandle(), and setObjName().

Referenced by DtObjectMgr::sendRegisterMsg().

void DtRegObjMsg::setAttrHandles ( const DtAttributeHandleSet attrs)
virtual

Set/Get attribute handles.

References myDirty, and netRegObjMsg().

Referenced by DtRegObjMsg(), and set().

void DtRegObjMsg::setClassHandle ( DtObjectClassHandle  hand)
virtual

Set/Get class handle.

References DtNetRegObjMsg::handle, and netRegObjMsg().

Referenced by DtRegObjMsg(), and set().

void DtRegObjMsg::setObjHandle ( DtObjectInstanceHandle  id)
virtual

Set/Get object handle.

References DtNetRegObjMsg::id, and netRegObjMsg().

Referenced by DtRegObjMsg(), and set().

void DtRegObjMsg::setObjName ( const char *  name)
virtual

Member Data Documentation

DtAttributeHandleSet* DtRegObjMsg::myAttrs
protected

Referenced by attrHandles(), and ~DtRegObjMsg().

int DtRegObjMsg::myDirty
protected

Referenced by attrHandles(), and setAttrHandles().

MAKRti::DtString DtRegObjMsg::myName
protected

Referenced by DtRegObjMsg(), objName(), and setObjName().


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)