MAK RTIspy API Documentation for HLA Evolved
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtSubObjMsg Class Reference
+ Inheritance diagram for DtSubObjMsg:
+ Collaboration diagram for DtSubObjMsg:

List of all members.

Public Member Functions

 DtSubObjMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtSubObjMsg (DtObjectClassHandle theObj, bool isPassiveValue, bool replacementValue, const DtAttributeHandleSet &theSet, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 DtSubObjMsg (const DtNetSubObjMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtSubObjMsg ()
 Destructor.
virtual DtRtiMsg * clone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (DtObjectClassHandle theObj, bool isPassiveValue, bool replacementValue, const DtAttributeHandleSet &theSet)
 Set all fields simultaneously.
virtual void setObjectClassHandle (DtObjectClassHandle hand)
 Set/Get handle.
virtual DtObjectClassHandle objectClassHandle () const
virtual void setIsPassive (bool isPassiveValue)
 Set/Get isPassive.
virtual bool isPassive () const
virtual void setReplacement (bool replacementValue)
 Set/Get replacement (if false passive subscription will not replace any existing active subscription)
virtual bool replacement () 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.

Static Public Member Functions

static DtRtiMsg * create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static DtRtiMsg * create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static void addCallback (DtConnectionMgr *conn, DtSubObjCb cb, void *usr, bool isMomCallback=false)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtSubObjCb cb, void *usr, bool isMomCallback=false)

Protected Member Functions

virtual DtNetSubObjMsg * netSubObjMsg ()
 The network representation.
virtual const DtNetSubObjMsg * netSubObjMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an SubObj Msg.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual DtSubObjMsg * self () const
 Casts away const-ness.

Protected Attributes

int myDirty
DtAttributeHandleSet * myAttrs

Constructor & Destructor Documentation

DtSubObjMsg::DtSubObjMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

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

Referenced by clone(), and create().

DtSubObjMsg::DtSubObjMsg ( DtObjectClassHandle  theObj,
bool  isPassiveValue,
bool  replacementValue,
const DtAttributeHandleSet &  theSet,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtSubObjMsg::DtSubObjMsg ( const DtNetSubObjMsg *  netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

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

Destructor.

References myAttrs.


Member Function Documentation

void DtSubObjMsg::addCallback ( DtConnectionMgr *  conn,
DtSubObjCb  cb,
void *  usr,
bool  isMomCallback = false 
) [static]

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtSubObjMsgKind.

Referenced by DtObjectMgr::DtObjectMgr().

const DtAttributeHandleSet & DtSubObjMsg::attrHandles ( ) const [virtual]
DtRtiMsg * DtSubObjMsg::clone ( bool  copy = true) const [virtual]

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

Implements DtRtiMsg.

References DtSubObjMsg(), and netSubObjMsg().

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

Creator.

References DtSubObjMsg().

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

Creator.

References DtSubObjMsg().

Returns the kind of an SubObj Msg.

Implements DtRtiMsg.

References DtSubObjMsgKind.

Referenced by DtSubObjMsg().

bool DtSubObjMsg::isPassive ( ) const [virtual]
int DtSubObjMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtSubObjMsg().

DtNetSubObjMsg * DtSubObjMsg::netSubObjMsg ( ) [protected, virtual]
const DtNetSubObjMsg * DtSubObjMsg::netSubObjMsg ( ) const [protected, virtual]
void DtSubObjMsg::printData ( DtLogicalTimeFactory *  logicalTimeFactory) const [virtual]

Print the data section.

Reimplemented from DtRtiMsg.

References attrHandles(), isPassive(), objectClassHandle(), DtRtiMsg::print(), and replacement().

void DtSubObjMsg::removeCallback ( DtConnectionMgr *  conn,
DtSubObjCb  cb,
void *  usr,
bool  isMomCallback = false 
) [static]
bool DtSubObjMsg::replacement ( ) const [virtual]
DtSubObjMsg * DtSubObjMsg::self ( ) const [inline, protected, virtual]

Casts away const-ness.

void DtSubObjMsg::set ( DtObjectClassHandle  theObj,
bool  isPassiveValue,
bool  replacementValue,
const DtAttributeHandleSet &  theSet 
) [virtual]

Set all fields simultaneously.

References setAttrHandles(), setIsPassive(), setObjectClassHandle(), and setReplacement().

Referenced by DtObjectMgr::sendSubscribeMsg().

void DtSubObjMsg::setAttrHandles ( const DtAttributeHandleSet &  attrs) [virtual]

Set/Get attribute handles.

References myDirty, and netSubObjMsg().

Referenced by DtSubObjMsg(), and set().

void DtSubObjMsg::setIsPassive ( bool  isPassiveValue) [virtual]

Set/Get isPassive.

References DtNetSubObjMsg::isPassive, and netSubObjMsg().

Referenced by DtSubObjMsg(), and set().

Set/Get handle.

References DtNetSubObjMsg::handle, and netSubObjMsg().

Referenced by DtSubObjMsg(), and set().

void DtSubObjMsg::setReplacement ( bool  replacementValue) [virtual]

Set/Get replacement (if false passive subscription will not replace any existing active subscription)

References netSubObjMsg(), and DtNetSubObjMsg::replacement.

Referenced by DtSubObjMsg(), and set().


Member Data Documentation

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

int DtSubObjMsg::myDirty [protected]

Referenced by attrHandles(), and setAttrHandles().


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)