simulationObjectCategoryInformation.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2017 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include "vrfutil/vrfutilDefines.h"
#include <vrfutil/rwColor.h>
#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>

#include <map>
#include <set>

class DtFilename;

const int DtSpecialAllTagRank = 10000;

class DT_DLL_vrfutil DtSimulationObjectCategoryInformation
{
public:
   struct CategoryInformation
   {
      CategoryInformation() : rank(100), topLevelTag(0), visible(true), organizeOnListView(false) {};
      CategoryInformation(const CategoryInformation& orig) : rank(orig.rank), visible(orig.visible), topLevelTag(orig.topLevelTag), iconFilename(orig.iconFilename), category(orig.category),
         displayName(orig.displayName), organizeOnListView(orig.organizeOnListView), color(orig.color) {};

      bool operator==(const CategoryInformation& rhs) const
      {
         return ((rank == rhs.rank) && (topLevelTag == rhs.topLevelTag) && (iconFilename == rhs.iconFilename) && (category == rhs.category) && (visible == rhs.visible)
                 && (displayName == rhs.displayName) && (organizeOnListView == rhs.organizeOnListView) && (color == rhs.color));
      }

      bool operator!=(const CategoryInformation& rhs) const { return !(*this == rhs); };

      CategoryInformation& operator=(const CategoryInformation& rhs)
      {
         category = rhs.category;
         rank = rhs.rank;
         topLevelTag = rhs.topLevelTag;
         iconFilename = rhs.iconFilename;
         visible = rhs.visible;
         displayName = rhs.displayName;
         organizeOnListView = rhs.organizeOnListView;
         color = rhs.color;

         return *this;
      }

      DtRwColor color;
      int rank;
      int topLevelTag;
      DtString iconFilename;
      DtString category;
      bool organizeOnListView;
      bool visible;
      DtString displayName;
   };

   typedef std::map<DtString, CategoryInformation> Categories;

public:
   DtSimulationObjectCategoryInformation();
   DtSimulationObjectCategoryInformation(const DtSimulationObjectCategoryInformation&);

   virtual ~DtSimulationObjectCategoryInformation();

   virtual bool load(const DtFilename&, bool clear = false);

   virtual void clear();

   virtual bool save(const DtFilename&);

   virtual void addCategoryInformation(const DtString&, int rank = 100, int topLevelTag = 0, const DtString& iconFilename = "", bool visible = true,
      const DtString& displayName = "", bool organizeOnListView = false, const DtRwColor& color = DtRwColor());
   virtual void addCategoryInformation(const DtString&, const CategoryInformation& cat);

   virtual void removeCategoryInformation(const DtString&);

   virtual bool hasCategory(const DtString&) const;

   virtual int topLevelTag(const DtString& cat) const;

   virtual std::set<DtString> topLevelTags(int level = 1) const;

   virtual CategoryInformation categoryInformation(const DtString&) const;

   const Categories& categories() const
   {
      return myCategories;
   }

   DtSimulationObjectCategoryInformation& operator=(const DtSimulationObjectCategoryInformation&);

   bool operator==(const DtSimulationObjectCategoryInformation&) const;
   bool operator!=(const DtSimulationObjectCategoryInformation& orig) const
   {
      return !(*this == orig);
   }

   static DtFilename categoriesFilename();
   static void setCategoriesFilename(const DtFilename&);

protected:
   Categories myCategories;
};