attrInfo.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: attrInfo.h,v $ $Revision: 1.27 $ $State: Exp $
*********************************************************************/


#ifndef DtAttrInfo_H_
#define DtAttrInfo_H_

#include <rtiMsConfig.h>
#include <internalTypes.h>

#include <vlutil/vlHashlist.h>
#include <vlutil/vlMachineTypes.h>
#include <vlutil/vlFedTarget.h>

#include <set>
#include <map>

#define DtPrivilegeToDelete 0

class DtSubRegionSet;

class DT_DLL_LRC DtAttrInfo
{
public:

   DtAttrInfo();
   DtAttrInfo(const char* attrName, DtAttributeHandle handle);
   DtAttrInfo(const DtAttrInfo& orig);

   DtAttrInfo& operator=(const DtAttrInfo& orig);
   bool operator==(const DtAttrInfo& orig);
   bool operator!=(const DtAttrInfo& orig);

   virtual ~DtAttrInfo();

   virtual void setFomType(MAKRti::DtFomType type);
   virtual MAKRti::DtFomType fomType() const;

   virtual void publish();
   virtual void unpublish();

   virtual int published() const;

   virtual void subscribe();
   virtual void unsubscribe();

   virtual int subscribed() const;

   virtual const char* name() const;
   virtual void setName(const char* nameValue);

   virtual DtAttributeHandle handle() const;
   virtual void setHandle(DtAttributeHandle handleValue);

   virtual bool isName(const char* name);

   virtual void addRemoteSubscription(DtFederateHandle fedHandle);
   virtual void deleteRemoteSubscription(DtFederateHandle fedHandle);
   virtual void emptyRemoteSubscription();

   virtual void addRemoteSubscriptionWithRegion(DtFederateHandle fedHandle,
      DtHandle regionSetHandle);
   virtual void deleteRemoteSubscriptionWithRegion(
      DtFederateHandle fedHandle);
   virtual void emptyRemoteSubscriptionWithRegion();

   virtual DtHandle remoteRegionSubscription(
      DtFederateHandle fedHandle) const;

   int numRemoteFederatesSubscribed();

   int numRemoteFederatesSubscribedWithRegion();

   virtual bool remoteFederateIsSubscribed(
      DtFederateHandle fedHandle) const;


   virtual const DtFederateHandleStdSet& subscribedFederates() const;

   virtual bool remoteFederateIsSubscribedWithRegion(
      DtFederateHandle fedHandle) const;

   virtual void setRelevant(bool onOff);
   virtual bool relevant() const;

   virtual MAKRti::DtTransportType transport() const;
   virtual void setTransport(MAKRti::DtTransportType theTransport);

   virtual MAKRti::DtOrderType order() const;
   virtual void setOrder(MAKRti::DtOrderType theOrder);

   virtual DtSpaceHandle space() const;
   virtual void setSpace(DtSpaceHandle spaceVal);

   virtual DtFomUpdateType updateType() const;
   virtual void setUpdateType(DtFomUpdateType val);

   virtual MAKRti::DtString updateCondition() const;
   virtual void setUpdateCondition(MAKRti::DtString val);

   virtual DtOwnershipType ownershipType() const;
   virtual void setOwnershipType(DtOwnershipType val);

   virtual MAKRti::DtString semantics() const;
   virtual void setSemantics(MAKRti::DtString val);

   virtual MAKRti::DtString notes() const;
   virtual void setNotes(MAKRti::DtString val);

   virtual DtSharingType sharingType() const;
   virtual void setSharingType(DtSharingType val);

   virtual DtDimensionHandleStdSet const & dimensions() const;
   virtual void setDimensions(DtDimensionHandleStdSet const & dimList);

   virtual void addDimension(DtDimensionHandle dimHandle);
   virtual void addDimension(DtDimensionHandleStdSet const& dimensions);
   virtual void removeDimension(DtDimensionHandle dimHandle);

   virtual DtSubRegionSet* subRegionSet() const;
   virtual void setSubRegionSet(DtSubRegionSet* setVal);

   virtual DtSubRegionSet* pasRegionSet() const;
   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;
   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;

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

protected:

   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;
   DtDimensionHandleStdSet myDimensions;
   DtSubRegionSet* myAssocSubRegSet;
   DtSubRegionSet* myAssocPasRegSet;

   DtFederateHandleStdSet myRemoteSubscriptions;
   std::map<DtFederateHandle, DtHandle> myRemoteRegionSubscriptions;

   float mySubscribedRate;
   MAKRti::DtString mySubscribedRateName;

public:
   static const MAKRti::DtString thePrivilegeToDelete;
   static const MAKRti::DtString thePrivilegeToDeleteObject;
   static const MAKRti::DtString theHlaPrivilegeToDeleteObject;
};


typedef std::map<DtAttributeHandle, DtAttrInfo*> DtAttributeByHandleMap;
typedef std::map<MAKRti::DtString, DtAttrInfo*> DtAttributeByNameMap;

#endif