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

List of all members.

Public Member Functions

 DtAttrInfo ()
 Constructors.
 DtAttrInfo (const char *attrName, int handle)
 DtAttrInfo (const DtAttrInfo &orig)
DtAttrInfooperator= (const DtAttrInfo &orig)
 operators
bool operator== (const DtAttrInfo &orig)
bool operator!= (const DtAttrInfo &orig)
virtual ~DtAttrInfo ()
 Destructor.
virtual void setFomType (MAKRti::DtFomType type)
 Set/Get the FOM type.
virtual MAKRti::DtFomType fomType () const
virtual void publish ()
 Publish/unpublish this attribute.
virtual void unpublish ()
virtual int published () const
 Returns 1 if this attribute is published, 0 otherwise.
virtual void subscribe ()
 DM Subscribe/unsubscribe to this attribute.
virtual void unsubscribe ()
virtual int subscribed () const
 Returns 1 if this attribute is subscribed, 0 otherwise.
virtual const char * name () const
 Get/set name.
virtual void setName (const char *nameValue)
virtual DtAttributeHandle handle () const
 Get/set handle.
virtual void setHandle (DtAttributeHandle handleValue)
virtual bool isName (const char *name)
 Return boolean: name matches (case insensitive)?
virtual void addRemoteSubscription (DtFederateHandle fedHandle)
 Add/delete remote subscription to this class by indicated federate No effect if already subscribed/unsubscribed.
virtual void deleteRemoteSubscription (DtFederateHandle fedHandle)
virtual void emptyRemoteSubscription ()
virtual void addRemoteSubscriptionWithRegion (DtFederateHandle fedHandle, DtHandle regionSetHandle)
 Add/delete remote subscription to this class by indicated federate No effect if already subscribed/unsubscribed.
virtual void deleteRemoteSubscriptionWithRegion (DtFederateHandle fedHandle)
virtual void emptyRemoteSubscriptionWithRegion ()
virtual DtHandle remoteRegionSubscription (DtFederateHandle fedHandle) const
 Return the remote region set handle (0 if not subscribed with region)
int numRemoteFederatesSubscribed ()
 Returns number of remote federates subscribed to this class.
int numRemoteFederatesSubscribedWithRegion ()
 Returns number of remote federates subscribed to this class with Region.
virtual bool remoteFederateIsSubscribed (DtFederateHandle fedHandle) const
 Returns true if the remote federate is subscribed to this class.
virtual const std::set
< DtFederateHandle > & 
subscribedFederates () const
 Returns set of federates who are subscribed to this attr.
virtual bool remoteFederateIsSubscribedWithRegion (DtFederateHandle fedHandle) const
 Returns true if the remote federate is subscribed with region to this class.
virtual void setRelevant (bool onOff)
 Set/Get relevance Relevance indicates whether there one or more remote subscriptions The relevance state can be determined from the remote subscribe lists, but setting this state separately allows for it to be compared before and after the remote subscriptions are modified.
virtual bool relevant () const
virtual MAKRti::DtTransportType transport () const
 Set/Get transport type representing transport mechanism.
virtual void setTransport (MAKRti::DtTransportType theTransport)
virtual MAKRti::DtOrderType order () const
 Set/Get order type.
virtual void setOrder (MAKRti::DtOrderType theOrder)
virtual DtSpaceHandle space () const
 Set/Get routing space.
virtual void setSpace (DtSpaceHandle spaceVal)
virtual DtFomUpdateType updateType () const
 Set/ Get this attribute's updateType.
virtual void setUpdateType (DtFomUpdateType val)
virtual MAKRti::DtString updateCondition () const
 Set / Get the update Condition.
virtual void setUpdateCondition (MAKRti::DtString val)
virtual DtOwnershipType ownershipType () const
 Set / Get ownershipType.
virtual void setOwnershipType (DtOwnershipType val)
virtual MAKRti::DtString semantics () const
 Set / Get semantics of attribute.
virtual void setSemantics (MAKRti::DtString val)
virtual MAKRti::DtString notes () const
 Set / Get notes for attribute.
virtual void setNotes (MAKRti::DtString val)
virtual DtSharingType sharingType () const
 Set this attribute's sharingType.
virtual void setSharingType (DtSharingType val)
virtual DtDimensionHandleSet
const & 
dimensions () const
 Set/Get dimensions.
virtual void setDimensions (DtDimensionHandleSet const &dimList)
virtual void addDimension (DtDimensionHandle dimHandle)
 Add/Remove a demision handle.
virtual void removeDimension (DtDimensionHandle dimHandle)
virtual DtSubRegionSet * subRegionSet () const
 Set/Get associated active subscription region set.
virtual void setSubRegionSet (DtSubRegionSet *setVal)
virtual DtSubRegionSet * pasRegionSet () const
 Set/Get associated passive subscription region set.
virtual void setPasRegionSet (DtSubRegionSet *setVal)
virtual float subscribedRate () const
virtual const MAKRti::DtString & subscribedRateName () const
virtual void setSubscribedRate (float rate, const MAKRti::DtString &name)
virtual bool sameDataTypes (const DtAttrInfo &) const
 Test for equality.
virtual bool sameUpdateType (const DtAttrInfo &) const
virtual bool sameUpdateCondition (const DtAttrInfo &) const
virtual bool sameSharing (const DtAttrInfo &) const
virtual bool sameDimensions (const DtAttrInfo &) const
virtual bool sameTransportation (const DtAttrInfo &) const
virtual bool sameOrder (const DtAttrInfo &) const
virtual bool sameSemantics (const DtAttrInfo &) const
virtual bool sameOwnership (const DtAttrInfo &) const
virtual bool sameNotes (const DtAttrInfo &) const
virtual void print () const
 Print the contents.

Static Public Member Functions

static bool nameIsPrivilegeToDelete (char const *name, MAKRti::DtFomType compareType)
static char const * privilegeToDeleteName (MAKRti::DtFomType compareType)

Static Public Attributes

static const MAKRti::DtString thePrivilegeToDelete
static const MAKRti::DtString thePrivilegeToDeleteObject
static const MAKRti::DtString theHlaPrivilegeToDeleteObject

Protected Attributes

MAKRti::DtString myName
DtAttributeHandle myHandle
MAKRti::DtFomType myFomType
int myPublished
int mySubscribed
bool myRelevant
MAKRti::DtTransportType myTransport
MAKRti::DtOrderType myOrder
DtFomUpdateType myUpdateType
MAKRti::DtString myUpdateCondition
DtSharingType mySharingType
DtOwnershipType myOwnershipType
MAKRti::DtString mySemantics
MAKRti::DtString myNotes
DtSpaceHandle mySpace
DtDimensionHandleSet myDimensions
DtSubRegionSet * myAssocSubRegSet
DtSubRegionSet * myAssocPasRegSet
std::set< DtFederateHandlemyRemoteSubscriptions
std::map< DtFederateHandle,
DtHandle
myRemoteRegionSubscriptions
float mySubscribedRate
 How fast I want to receive updates.
MAKRti::DtString mySubscribedRateName

Constructor & Destructor Documentation

Constructors.

DtAttrInfo::DtAttrInfo ( const char *  attrName,
int  handle 
)
DtAttrInfo::~DtAttrInfo ( ) [virtual]

Member Function Documentation

void DtAttrInfo::addDimension ( DtDimensionHandle  dimHandle) [virtual]
void DtAttrInfo::addRemoteSubscription ( DtFederateHandle  fedHandle) [virtual]

Add/delete remote subscription to this class by indicated federate No effect if already subscribed/unsubscribed.

References myRemoteSubscriptions, and remoteFederateIsSubscribed().

void DtAttrInfo::addRemoteSubscriptionWithRegion ( DtFederateHandle  fedHandle,
DtHandle  regionSetHandle 
) [virtual]

Add/delete remote subscription to this class by indicated federate No effect if already subscribed/unsubscribed.

References myRemoteRegionSubscriptions.

DtDimensionHandleSet const & DtAttrInfo::dimensions ( ) const [virtual]

References myRemoteSubscriptions.

Referenced by ~DtAttrInfo().

References myRemoteRegionSubscriptions.

Referenced by ~DtAttrInfo().

MAKRti::DtFomType DtAttrInfo::fomType ( ) const [virtual]

References myFomType.

Referenced by isName().

bool DtAttrInfo::isName ( const char *  name) [virtual]

Return boolean: name matches (case insensitive)?

References DtPrivilegeToDelete, fomType(), myHandle, myName, name(), and nameIsPrivilegeToDelete().

const char * DtAttrInfo::name ( ) const [virtual]
bool DtAttrInfo::nameIsPrivilegeToDelete ( char const *  name,
MAKRti::DtFomType  compareType 
) [static]
MAKRti::DtString DtAttrInfo::notes ( ) const [virtual]

Set / Get notes for attribute.

References myNotes.

Referenced by sameNotes().

Returns number of remote federates subscribed to this class.

References myRemoteSubscriptions.

Referenced by DtObjectClassInfo::updateRelevance().

Returns number of remote federates subscribed to this class with Region.

References myRemoteRegionSubscriptions.

Referenced by DtObjectClassInfo::updateRelevance().

bool DtAttrInfo::operator!= ( const DtAttrInfo orig)
DtAttrInfo & DtAttrInfo::operator= ( const DtAttrInfo orig)
bool DtAttrInfo::operator== ( const DtAttrInfo orig)
MAKRti::DtOrderType DtAttrInfo::order ( ) const [virtual]
DtSubRegionSet * DtAttrInfo::pasRegionSet ( ) const [virtual]

Set/Get associated passive subscription region set.

References myAssocPasRegSet.

Referenced by DtObjectClassInfo::isSubscribed().

void DtAttrInfo::print ( ) const [virtual]

Print the contents.

References myDimensions, myHandle, myName, myOrder, mySpace, and myTransport.

char const * DtAttrInfo::privilegeToDeleteName ( MAKRti::DtFomType  compareType) [static]
void DtAttrInfo::publish ( ) [virtual]

Publish/unpublish this attribute.

References myPublished.

int DtAttrInfo::published ( ) const [virtual]

Returns 1 if this attribute is published, 0 otherwise.

References myPublished.

Referenced by DtObjectClassInfo::updateRelevance().

bool DtAttrInfo::relevant ( ) const [virtual]

Returns true if the remote federate is subscribed to this class.

References myRemoteSubscriptions.

Referenced by addRemoteSubscription(), deleteRemoteSubscription(), and DtObjectClassInfo::updateRelevance().

Returns true if the remote federate is subscribed with region to this class.

References myRemoteRegionSubscriptions.

Referenced by deleteRemoteSubscriptionWithRegion(), DtObjectClassInfo::removeSubscriptions(), and DtObjectClassInfo::updateRelevance().

Return the remote region set handle (0 if not subscribed with region)

References DtDefaultRegionSetHandle, and myRemoteRegionSubscriptions.

void DtAttrInfo::removeDimension ( DtDimensionHandle  dimHandle) [virtual]

References myDimensions.

bool DtAttrInfo::sameDataTypes ( const DtAttrInfo second) const [virtual]

Test for equality.

bool DtAttrInfo::sameDimensions ( const DtAttrInfo second) const [virtual]

References dimensions().

bool DtAttrInfo::sameNotes ( const DtAttrInfo second) const [virtual]

References notes().

bool DtAttrInfo::sameOrder ( const DtAttrInfo second) const [virtual]

References order().

bool DtAttrInfo::sameOwnership ( const DtAttrInfo second) const [virtual]

References ownershipType().

bool DtAttrInfo::sameSemantics ( const DtAttrInfo second) const [virtual]

References semantics().

bool DtAttrInfo::sameSharing ( const DtAttrInfo second) const [virtual]

References sharingType().

bool DtAttrInfo::sameTransportation ( const DtAttrInfo second) const [virtual]

References transport().

bool DtAttrInfo::sameUpdateCondition ( const DtAttrInfo second) const [virtual]

References updateCondition().

bool DtAttrInfo::sameUpdateType ( const DtAttrInfo second) const [virtual]

References updateType().

MAKRti::DtString DtAttrInfo::semantics ( ) const [virtual]

Set / Get semantics of attribute.

References mySemantics.

Referenced by DtObjectClassInfo::DtObjectClassInfo(), DtFomClassMgr::mergeAttributes(), and sameSemantics().

void DtAttrInfo::setDimensions ( DtDimensionHandleSet const &  dimList) [virtual]
void DtAttrInfo::setFomType ( MAKRti::DtFomType  type) [virtual]

Set/Get the FOM type.

References myFomType.

void DtAttrInfo::setHandle ( DtAttributeHandle  handleValue) [virtual]

References myHandle.

void DtAttrInfo::setName ( const char *  nameValue) [virtual]

References myName.

void DtAttrInfo::setNotes ( MAKRti::DtString  val) [virtual]

References myNotes.

void DtAttrInfo::setOrder ( MAKRti::DtOrderType  theOrder) [virtual]

References myOrder.

References myOwnershipType.

void DtAttrInfo::setPasRegionSet ( DtSubRegionSet *  setVal) [virtual]

References myAssocPasRegSet.

void DtAttrInfo::setRelevant ( bool  onOff) [virtual]

Set/Get relevance Relevance indicates whether there one or more remote subscriptions The relevance state can be determined from the remote subscribe lists, but setting this state separately allows for it to be compared before and after the remote subscriptions are modified.

References myRelevant.

Referenced by DtObjectClassInfo::updateRelevance().

void DtAttrInfo::setSemantics ( MAKRti::DtString  val) [virtual]

References mySemantics.

void DtAttrInfo::setSharingType ( DtSharingType  val) [virtual]

References mySharingType.

void DtAttrInfo::setSpace ( DtSpaceHandle  spaceVal) [virtual]

References mySpace.

void DtAttrInfo::setSubRegionSet ( DtSubRegionSet *  setVal) [virtual]

References myAssocSubRegSet.

void DtAttrInfo::setSubscribedRate ( float  rate,
const MAKRti::DtString &  name 
) [virtual]
void DtAttrInfo::setTransport ( MAKRti::DtTransportType  theTransport) [virtual]
void DtAttrInfo::setUpdateCondition ( MAKRti::DtString  val) [virtual]

References myUpdateCondition.

void DtAttrInfo::setUpdateType ( DtFomUpdateType  val) [virtual]

References myUpdateType.

Set this attribute's sharingType.

References mySharingType.

Referenced by DtObjectClassInfo::DtObjectClassInfo(), DtFomClassMgr::mergeAttributes(), and sameSharing().

DtSpaceHandle DtAttrInfo::space ( ) const [virtual]
DtSubRegionSet * DtAttrInfo::subRegionSet ( ) const [virtual]

Set/Get associated active subscription region set.

References myAssocSubRegSet.

Referenced by DtObjectClassInfo::isSubscribed().

void DtAttrInfo::subscribe ( ) [virtual]

DM Subscribe/unsubscribe to this attribute.

References mySubscribed.

int DtAttrInfo::subscribed ( ) const [virtual]

Returns 1 if this attribute is subscribed, 0 otherwise.

References myAssocPasRegSet, myAssocSubRegSet, and mySubscribed.

const std::set< DtFederateHandle > & DtAttrInfo::subscribedFederates ( ) const [virtual]

Returns set of federates who are subscribed to this attr.

References myRemoteSubscriptions.

Referenced by DtObjOwnershipInfoXmlBlock::getAttrInfo().

float DtAttrInfo::subscribedRate ( ) const [virtual]

References mySubscribedRate.

Referenced by DtRtiObject::okToReceive().

const MAKRti::DtString & DtAttrInfo::subscribedRateName ( ) const [virtual]

References mySubscribedRateName.

MAKRti::DtTransportType DtAttrInfo::transport ( ) const [virtual]

Set/Get transport type representing transport mechanism.

References myTransport.

Referenced by DtObjectClassInfo::attrTransport(), DtObjectClassInfo::DtObjectClassInfo(), DtFomClassMgr::mergeAttributes(), and sameTransportation().

void DtAttrInfo::unpublish ( ) [virtual]

References myPublished.

void DtAttrInfo::unsubscribe ( ) [virtual]

References mySubscribed.

MAKRti::DtString DtAttrInfo::updateCondition ( ) const [virtual]

Set/ Get this attribute's updateType.

References myUpdateType.

Referenced by DtObjectClassInfo::DtObjectClassInfo(), DtFomClassMgr::mergeAttributes(), and sameUpdateType().


Member Data Documentation

DtSubRegionSet* DtAttrInfo::myAssocPasRegSet [protected]
DtSubRegionSet* DtAttrInfo::myAssocSubRegSet [protected]
MAKRti::DtFomType DtAttrInfo::myFomType [protected]

Referenced by fomType(), operator=(), and setFomType().

MAKRti::DtString DtAttrInfo::myName [protected]

Referenced by isName(), name(), operator=(), print(), and setName().

MAKRti::DtString DtAttrInfo::myNotes [protected]

Referenced by notes(), operator=(), and setNotes().

MAKRti::DtOrderType DtAttrInfo::myOrder [protected]

Referenced by operator=(), order(), print(), and setOrder().

int DtAttrInfo::myPublished [protected]

Referenced by operator=(), relevant(), and setRelevant().

MAKRti::DtString DtAttrInfo::mySemantics [protected]

Referenced by operator=(), semantics(), and setSemantics().

Referenced by operator=(), print(), setSpace(), and space().

int DtAttrInfo::mySubscribed [protected]
float DtAttrInfo::mySubscribedRate [protected]

How fast I want to receive updates.

Referenced by operator=(), setSubscribedRate(), and subscribedRate().

MAKRti::DtString DtAttrInfo::mySubscribedRateName [protected]
MAKRti::DtTransportType DtAttrInfo::myTransport [protected]
MAKRti::DtString DtAttrInfo::myUpdateCondition [protected]
const MAKRti::DtString DtAttrInfo::theHlaPrivilegeToDeleteObject [static]
const MAKRti::DtString DtAttrInfo::thePrivilegeToDelete [static]

Referenced by nameIsPrivilegeToDelete().

const MAKRti::DtString DtAttrInfo::thePrivilegeToDeleteObject [static]

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)