MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtDiscObjMsg Class Reference
+ Inheritance diagram for DtDiscObjMsg:
+ Collaboration diagram for DtDiscObjMsg:

List of all members.

Public Member Functions

 DtDiscObjMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtDiscObjMsg (DtObjectInstanceHandle objHandleValue, DtObjectClassHandle classHandleValue, DtFederateHandle owner, bool removeDiscoverValue, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtDiscObjMsg (const DtNetDiscObjMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtDiscObjMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (DtObjectInstanceHandle objHandleValue, DtObjectClassHandle classHandleValue, DtFederateHandle owner, bool removeDiscoverValue)
 Set all fields simultaneously.
virtual void setObjHandle (DtObjectInstanceHandle objHandle)
 Add/get object handles to/from message.
virtual void setObjHandles (const std::set< DtObjectInstanceHandle > &objHandles)
virtual void getObjHandles (std::vector< DtObjectInstanceHandle > &objHandles) const
virtual void setClassHandle (DtObjectClassHandle hand)
 Set/Get class handle.
virtual DtObjectClassHandle classHandle () const
virtual void setOwnerHandle (DtFederateHandle owner)
 Set/Get owner handle (federate or LRC that owns privilegeToDelete) Lets owner know if it needs to be updated at discovered federate.
virtual DtFederateHandle ownerHandle () const
virtual void setRemoveDiscover (bool removeDiscoverValue)
 Set/Get remove discover - indicates if the discovery was removed at the discovered federate.
virtual bool removeDiscover () const
virtual void printData (DtLogicalTimeFactory *logicalTimeFactory) const
 Print the data section.

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, DtDiscObjCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtDiscObjCb cb, void *usr)

Protected Member Functions

virtual DtNetDiscObjMsgnetDiscObjMsg ()
 The network representation.
virtual const DtNetDiscObjMsgnetDiscObjMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an RegObj Msg.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual void setObjHandleCount (unsigned long count)
 Set/Get number of object handles included in message.
virtual unsigned long objHandleCount () const
virtual const DtNetU32 * objHandlesPtr () const
 Get the address of the object handles in the message.
virtual DtNetU32 * objHandlesPtr ()
virtual DtDiscObjMsgself () const
 Casts away const-ness.

Constructor & Destructor Documentation

DtDiscObjMsg::DtDiscObjMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

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

Referenced by clone(), and create().

DtDiscObjMsg::DtDiscObjMsg ( DtObjectInstanceHandle  objHandleValue,
DtObjectClassHandle  classHandleValue,
DtFederateHandle  owner,
bool  removeDiscoverValue,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtDiscObjMsg::DtDiscObjMsg ( const DtNetDiscObjMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

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

Destructor.


Member Function Documentation

void DtDiscObjMsg::addCallback ( DtConnectionMgr conn,
DtDiscObjCb  cb,
void *  usr 
) [static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtDiscObjMsgKind.

Referenced by DtObjectMgr::DtObjectMgr().

DtRtiMsg * DtDiscObjMsg::clone ( bool  copy = true) const [virtual]

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

Implements DtRtiMsg.

References DtDiscObjMsg(), and netDiscObjMsg().

DtRtiMsg * DtDiscObjMsg::create ( const DtNetMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Creator.

References DtDiscObjMsg().

DtRtiMsg * DtDiscObjMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER) [static]

Creator.

References DtDiscObjMsg().

void DtDiscObjMsg::getObjHandles ( std::vector< DtObjectInstanceHandle > &  objHandles) const [virtual]

Returns the kind of an RegObj Msg.

Implements DtRtiMsg.

References DtDiscObjMsgKind.

Referenced by DtDiscObjMsg().

int DtDiscObjMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtDiscObjMsg().

DtNetDiscObjMsg * DtDiscObjMsg::netDiscObjMsg ( ) [protected, virtual]
const DtNetDiscObjMsg * DtDiscObjMsg::netDiscObjMsg ( ) const [protected, virtual]
unsigned long DtDiscObjMsg::objHandleCount ( ) const [protected, virtual]
const DtNetU32 * DtDiscObjMsg::objHandlesPtr ( ) const [protected, virtual]

Get the address of the object handles in the message.

References netDiscObjMsg().

Referenced by getObjHandles(), and setObjHandles().

DtNetU32 * DtDiscObjMsg::objHandlesPtr ( ) [protected, virtual]

References netDiscObjMsg().

void DtDiscObjMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References classHandle(), getObjHandles(), ownerHandle(), and removeDiscover().

void DtDiscObjMsg::removeCallback ( DtConnectionMgr conn,
DtDiscObjCb  cb,
void *  usr 
) [static]
bool DtDiscObjMsg::removeDiscover ( ) const [virtual]
DtDiscObjMsg * DtDiscObjMsg::self ( ) const [inline, protected, virtual]

Casts away const-ness.

void DtDiscObjMsg::set ( DtObjectInstanceHandle  objHandleValue,
DtObjectClassHandle  classHandleValue,
DtFederateHandle  owner,
bool  removeDiscoverValue 
) [virtual]

Set/Get class handle.

References DtNetDiscObjMsg::classHandle, and netDiscObjMsg().

Referenced by DtObjectMgr::sendPendingDiscoveries(), and set().

void DtDiscObjMsg::setObjHandle ( DtObjectInstanceHandle  objHandle) [virtual]

Add/get object handles to/from message.

References setObjHandles().

Referenced by set().

void DtDiscObjMsg::setObjHandleCount ( unsigned long  count) [protected, virtual]

Set/Get number of object handles included in message.

References netDiscObjMsg(), and DtNetDiscObjMsg::numObjHandles.

Referenced by setObjHandles().

void DtDiscObjMsg::setObjHandles ( const std::set< DtObjectInstanceHandle > &  objHandles) [virtual]

Set/Get owner handle (federate or LRC that owns privilegeToDelete) Lets owner know if it needs to be updated at discovered federate.

References netDiscObjMsg(), and DtNetDiscObjMsg::ownerHandle.

Referenced by DtObjectMgr::sendPendingDiscoveries(), and set().

void DtDiscObjMsg::setRemoveDiscover ( bool  removeDiscoverValue) [virtual]

Set/Get remove discover - indicates if the discovery was removed at the discovered federate.

Allows federate(s) owning attributes to adjust advisories

References netDiscObjMsg(), and DtNetDiscObjMsg::removeDiscover.

Referenced by DtObjectMgr::sendPendingDiscoveries(), and set().


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)