intClassInfo.h

Go to the documentation of this file.

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


#ifndef DtInteractionClassInfo_H_
#define DtInteractionClassInfo_H_

#include <vlutil/vlFedTarget.h>
#include <vlutil/vlList.h>
#include <vlutil/vlHashlist.h>
#include <vlutil/vlInetAddr.h>
#include "rtiMsConfig.h"
#include "internalTypes.h"
#include "bitMask.h"
#include "paramInfo.h"
#include "fedTargetHelper.h"

class DtRtiSaveFile;
class DtParamInfo;
class DtInteractionMgr;
class DtInteractionRegionSet;
class DtInteractionClassPacket;


enum DtSubcribeInteractionType
{
   DtSubcribeInteractionNone = 0,
   DtSubcribeInteractionActive = 1,
   DtSubcribeInteractionPassive = 2
};

typedef std::vector<DtParamInfo> DtParamVector;

class DT_DLL_LRC DtInteractionClassInfo
{
public:

   DtInteractionClassInfo(const char* name, DtInteractionClassInfo* base,
      DtInteractionClassHandle handle, DtSharingType sharing,
      MAKRti::DtString semantics, MAKRti::DtTransportType transport,
      MAKRti::DtOrderType order );

   DtInteractionClassInfo(const DtInteractionClassInfo& orig);

   DtInteractionClassInfo& operator=
      (const DtInteractionClassInfo& orig);

   virtual ~DtInteractionClassInfo();

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

   virtual void addParam(const char* paramName, const char* semantics,
      bool addSorted);

   virtual void addSubclass(DtInteractionClassInfo* sub);
   
   virtual DtDimensionHandleSet const & dimensions() const;
   virtual void setDimensions(DtDimensionHandleSet const & dimList);

   virtual void addDimension(DtDimensionHandle dimHandle);
   virtual void removeDimension(DtDimensionHandle dimHandle);

   virtual const char* name() const;

   virtual bool isName(const char* name);
   virtual bool isFullName(const char* name);

   virtual DtParameterHandle paramHandle(const char* theName);

   virtual char* paramName(DtParameterHandle theHandle);

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

   virtual DtInteractionClassInfo* baseClass() const;

   virtual void setBaseClass(DtInteractionClassInfo* base);

   virtual MAKRti::DtList* subclasses();

   virtual int isOfClass(DtInteractionClassHandle handle) const;

   virtual void publish(DtInteractionMgr* interMgr);
   virtual void unpublish();

   virtual int published() const;

   virtual void subscribe(bool active);
   virtual void unsubscribe();
   
   virtual int subscribed() const;

   virtual void remoteSubscribe(
      DtFederateHandle fedHandle, DtInteractionMgr* interMgr);

   virtual void remotePassiveSubscribe(
      DtFederateHandle fedHandle, DtInteractionMgr* interMgr);
   
   virtual void remoteUnsubscribe(
      DtFederateHandle fedHandle, DtInteractionMgr* interMgr,
      bool forSmartForwarding);

   virtual bool remoteFederateIsSubscribed(
      DtFederateHandle fedHandle) const;

   virtual int numRemoteFederatesSubscribed() const;

   virtual const MAKRti::DtList& subscribedFederates() const;

   virtual bool relevant() const;

   virtual DtParamInfo* paramByName(const char* theName);
   virtual DtParamInfo* paramByHandle(const  DtParameterHandle theHandle);

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

   DtSharingType sharing() const;
   void setSharing(const DtSharingType sharing );

   const char* semantics() const;
   void setSemantics(const MAKRti::DtString& semantics);

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

   virtual void setSpaceHandle(DtSpaceHandle spaceHandleValue);
   virtual DtSpaceHandle spaceHandle() const;

   virtual MAKRti::DtInetAddr destinationAddress() const;
   virtual MAKRti::DtInetAddr destinationDevice() const;
   virtual void setDestination(MAKRti::DtInetAddr addr, MAKRti::DtInetAddr devAddr, 
      bool inclusive, MAKRti::DtInetAddr oldAddr, MAKRti::DtInetAddr oldDevAddr);

   virtual int subscribedWithRegion() const;

   virtual int numParameters() const;

   virtual DtParamVector const& params() const;

   virtual DtBitMask getDestinations(bool includeBaseClass=true) const;

   virtual void forceDestinations(DtBitMask const& mask, MAKRti::DtTime delay);

   virtual void overrideDestinations(DtBitMask const& mask);

   virtual void clearDestinationOverride();

#ifdef DDM

   virtual int numRemoteFederatesSubscribedWithRegion() const;

   virtual void remoteSubscribe(
      DtFederateHandle fedHandle,
      DtHandle regionSetHandle,
      DtInteractionMgr* interMgr);

   virtual bool remoteFederateIsSubscribedWithRegion(
      DtFederateHandle fedHandle) const;
   virtual bool remoteFederateIsSubscribedWithRegion(
      DtFederateHandle fedHandle, DtHandle regionSetHandle) const;

   virtual void remoteUnsubscribeRegion(DtFederateHandle fedHandle,
      DtHandle regionSetHandle, DtInteractionMgr* interMgr);

   virtual DtInteractionRegionSet* subRegionSet();
   virtual void setSubRegionSet(DtInteractionRegionSet* regSet);

   virtual DtInteractionRegionSet* pasRegionSet();
   virtual void setPasRegionSet(DtInteractionRegionSet* regSet);
#endif

#ifdef DtMOM

   virtual unsigned long sentTally(MAKRti::DtTransportType transport);
   virtual void incrementSentTally(MAKRti::DtTransportType transport);
   virtual void setSentTally(unsigned long value, MAKRti::DtTransportType transport);
   virtual unsigned long receiveTally(MAKRti::DtTransportType transport);
   virtual void incrementReceiveTally(MAKRti::DtTransportType transport);
   virtual void setReceiveTally(unsigned long value, MAKRti::DtTransportType transport);

   virtual void overrideRelevance();
#endif

   virtual bool save( DtRtiSaveFile& file );
   virtual bool restore( DtInteractionClassPacket* packet );

   virtual void print() const;

   virtual bool sameAncestry(const DtInteractionClassInfo*) const; 
   bool operator==( const DtInteractionClassInfo& other ) const;
   bool operator!=( const DtInteractionClassInfo& other ) const;

   bool isScaffolding() const;

   
protected:


   static bool sameInteractionClass( const DtInteractionClassInfo&, 
      const DtInteractionClassInfo& );
   static bool sameParamsUnsorted( const std::vector<DtParamInfo>&, 
      const std::vector<DtParamInfo>& );
   static  bool sameParamsSorted( const std::vector<DtParamInfo>&, 
      const std::vector<DtParamInfo>& );
   virtual void addRemoteSubscription(DtFederateHandle fedHandle);
   virtual void addRemotePassiveSubscription(DtFederateHandle fedHandle);   
   virtual void deleteRemoteSubscription(DtFederateHandle fedHandle,
      bool isForSmartForwarding=false);

#ifdef DDM


   virtual void addRemoteSubscription(DtFederateHandle fedHandle,
      DtHandle regionSetHandle);
   virtual void deleteRemoteSubscription(DtFederateHandle fedHandle,
      DtHandle regionSetHandle);
#endif

   virtual void updateRelevance(DtInteractionMgr* interMgr);

   void addParamSorted( const char* paramName, MAKRti::DtString semantics);
   void addParamUnsorted( const char* paramName, MAKRti::DtString semantics);

protected:
   
   MAKRti::DtString myName;
   DtInteractionClassHandle myHandle;
   DtSpaceHandle mySpaceHandle;
   DtDimensionHandleSet myDimensions;
   MAKRti::DtFomType myFomType;
   DtSubcribeInteractionType mySubscribed;
   int myPublished;
   DtInteractionClassInfo* myBase;
   MAKRti::DtList mySubclasses;
   MAKRti::DtTransportType myTransport; 
   MAKRti::DtString mySemantics;
   DtSharingType mySharing;

#ifdef DtMOM
   bool myRelevantOverride;
   unsigned long myBestEffortSentTally;
   unsigned long myBestEffortReceiveTally;
   unsigned long myReliableSentTally;
   unsigned long myReliableReceiveTally;
#endif

   MAKRti::DtOrderType myOrder;
   
   DtParamVector myParams;
   int myFirstParam;

   MAKRti::DtHashlist myRemoteSubscriptions;
   MAKRti::DtHashlist myRemotePassiveSubscriptions;  
   DtBitMask  myRemoteSubscriberMask;
   DtBitMask*  myForceDestinationsMask;
   DtBitMask*  myOverrideDestinationsMask;
   MAKRti::DtTime myForceDestinationsTime;
   bool  myRelevant;
   MAKRti::DtInetAddr myAddr;
   MAKRti::DtInetAddr myDevAddr;
   MAKRti::DtClock myClock;

#ifdef DDM
   MAKRti::DtHashlist myRemoteRegionSubscriptions;
   DtBitMask  myRemoteRegionSubscriberMask;
   DtBitMask  myCombinedSubscriptionMask;
   DtInteractionRegionSet* mySubRegSet;
   DtInteractionRegionSet* myPasRegSet;
#endif

private:
   static const unsigned int theMaxParams;
   
};

#endif