subscriptionListFile.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
******************************************************************************/


#ifndef subscriptionListFile_H_
#define subscriptionListFile_H_

#include <lgrSim/lgrSim.h>
#include <lgrUtil/virtualConstructor.h>
#include <vector>
#include <map>
#include <vl/region.h>
#include <mtl/envValue.h>

class DtString;

namespace MAKLogger
{
   class DT_DLL_LGRSIM DtSubscriptionListFile
   {
   public:
      class DimensionDesc;
      class ExtentDesc;
      class AttributeDesc;
      class RegionDesc;
      typedef std::set<RegionDesc> RegionDescSet;

   public:
      DT_VIRTUAL_CTR(DtSubscriptionListFile,())

      
      virtual ~DtSubscriptionListFile();

      virtual bool defaultObjectClassExists() const;

      virtual bool defaultInteractionClassExists() const;

      virtual std::set<DtString> objectClasses() const;

      virtual void setObjectClassList(const std::vector<DtString>& list);

      virtual std::set<DtString> interactionClasses() const;

      virtual void setInteractionClassList(const std::vector<DtString>& list);

      virtual void setRegionDescSet(const DtString& name, const DtSubscriptionListFile::RegionDescSet& desc);

      virtual bool getRegionDescSet(const DtString& descName, DtSubscriptionListFile::RegionDescSet& regionDesc) const;

      virtual bool regionDescSetExists(const DtString& descName) const;

      virtual bool addObject(const DtString& name, const DtString& regionSetName);

      virtual void removeObject(const DtString& name);

      virtual bool addInteractionClass(const DtString& className, const DtString& regionSetName);

      virtual void removeInteractionClass(const DtString& className);

      virtual const DtString* regionDescSetNameForObjectClass(const DtString& className) const;

      virtual const DtString* regionDescSetNameForInteractionClass(const DtString& className) const;

      virtual const DtSubscriptionListFile::RegionDescSet* regionDescSetForObjectClass(const DtString& className,
         bool ignoreDefaults=false) const;

      virtual const DtSubscriptionListFile::RegionDescSet* regionDescSetForInteractionClass(const DtString& className, bool ignoreDefaults=false) const;

      virtual unsigned int getRegionSetForObject(DtExerciseConn* exconn,
         const DtString& name, DtDDMRegionSet& regionSet, bool cacheRegions=true) const;

      virtual unsigned int getRegionSetForInteractionClass(DtExerciseConn* exconn,
         const DtString& className, DtDDMRegionSet& regionSet, bool cacheRegions=true ) const;

      virtual void clearRegions();

      virtual bool readFromFile(const DtString& filename);

      virtual bool writeToFile(const DtString& filename) const;

      virtual const DtString& defaultRegionSetNameObjectClassKey() const;

      virtual const DtString& defaultRegionSetNameInteractionClassKey() const;

      virtual DtSubscriptionListFile diffSubscriptionList(const DtSubscriptionListFile& newsublist,
                                                             std::set<DtString>& modifiedObjectClasses,
                                                             std::set<DtString>& modifiedInteractionClasses);

   protected:

      virtual const DtString* regionDescSetNameForClassName(
         const std::map<DtString, DtString>& classNameToDescNameMap, const DtString& defaultName,
         const DtString& className) const;

      virtual const DtSubscriptionListFile::RegionDescSet* regionDescSetForClassName(
         const std::map<DtString, DtString>& classNameToDescNameMap, const DtString& defaultName,
         const DtString& className, bool ignoreDefaults=false) const;

      virtual DtDDMRegionSP createRegion(DtExerciseConn* exconn,
         const DtSubscriptionListFile::RegionDesc& regionDescriptor) const;

      virtual unsigned int getRegionSet(DtExerciseConn* exconn,
         const DtSubscriptionListFile::RegionDescSet& regionDescSet, DtDDMRegionSet& regionSet,
         bool cacheRegions=true) const;

      virtual bool readRegion(DtEnvironment& env, DtEnvValueSP region, RegionDesc& regionDescriptor);

      virtual bool readAttribute(DtEnvironment& env, DtEnvValueSP attribute, AttributeDesc& attrributeDescriptor);

      virtual bool readExtent(DtEnvironment& env, DtEnvValueSP extent, ExtentDesc& extentDescriptor);

      virtual bool readDimension(DtEnvironment& env, DtEnvValueSP dimension, DimensionDesc& dimimensionDescriptor);

      virtual bool readBound(DtEnvironment& env, DtEnvValueSP dimension, const DtString& boundName, unsigned long& value);

      virtual bool readRegionSet(DtEnvironment& env, const std::map<DtString,
         RegionDesc>& regionmap, DtEnvValueSP regionset,
         DtString& regionsetname, RegionDescSet& regdescset);

      virtual bool readClassRegion(DtEnvironment& env, DtEnvValueSP classRegion, DtString& regionSetName, DtString* className=0);

      virtual void collectRegions(std::map<RegionDesc, DtString>& regionsToWrite) const;

      virtual void addRegionsToEnv(std::map<RegionDesc, DtString>& regionsToWrite, DtEnvironment& env) const;

      void addRegionSetsToEnv(std::map<RegionDesc, DtString>& regionsToWrite, DtEnvironment& env) const;

      void addObjectClassesToEnv(DtEnvironment& env) const;

      virtual  void addInteractionClassesToEnv(DtEnvironment& env) const;


   public:
      class DT_DLL_LGRSIM DimensionDesc {
      public:
         DtString name;
         unsigned long lower;
         unsigned long upper;

         DimensionDesc() : lower(), upper()
         {

         }
         ~DimensionDesc();

         bool operator<(const DimensionDesc other) const;

         bool operator==(const DimensionDesc other) const;
         bool operator!=(const DimensionDesc other) const;

         int serialize(char* buffer, int maxsize) const;
         int deserialize(const char* buffer);
      };

      class DT_DLL_LGRSIM ExtentDesc {
      public:
         std::set<DimensionDesc> dimensions;

         ~ExtentDesc();

         bool operator<(const ExtentDesc other) const;

         bool operator==(const ExtentDesc other) const;
         bool operator!=(const ExtentDesc other) const;

         int serialize(char* buffer, int maxsize) const;
         int deserialize(const char* buffer);
      };

      class DT_DLL_LGRSIM AttributeDesc {
      public:
         DtString className;
         DtString attrName;

         bool operator<(const AttributeDesc other) const;

         bool operator==(const AttributeDesc other) const;
         bool operator!=(const AttributeDesc other) const;

         int serialize(char* buffer, int maxsize) const;
         int deserialize(const char* buffer);
      };
      typedef std::set<AttributeDesc> AttributeDescSet;

      class DT_DLL_LGRSIM RegionDesc {
      public:
         DtString space;
         std::set<ExtentDesc> extents;
         std::map<DtString, AttributeDescSet> attributes;

         DtString name;
         unsigned long regionToken;

         RegionDesc() : regionToken() {}
         ~RegionDesc();

         bool operator<(const RegionDesc other) const;

         bool operator==(const RegionDesc other) const;

         int serialize(char* buffer, int maxsize) const;
         int deserialize(const char* buffer);
      };

   protected:
      std::map<DtString, RegionDescSet> myRegionDescSetMap;

      mutable std::map<DtString, DtDDMRegionSP> myRegions;

      std::map<DtString, DtString> myObjectToRegionSetMap;

      std::map<DtString, DtString> myInteractionClassToRegionSetMap;
      
      DtString myDefaultRegionSetNameObjectClassKey;

      DtString myDefaultRegionSetNameInteractionClassKey;
      
   };
}

#endif