enumDictionary.h

Go to the documentation of this file.

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


#pragma once

#include <vlpi/entityTypeRange.h>
#include <vlutil/vlMachineTypes.h>
#include <vlutil/vlPrint.h>


enum DtEntityTypeField
{
   DtNoEntityTypeField = 0,
   DtKindField = 1,
   DtDomainField = 2,
   DtCountryField = 3,
   DtCategoryField = 4,
   DtSubcategoryField = 5,
   DtSpecificField = 6,
   DtExtraField = 7,
   DtNumEntityTypeFields
};

typedef unsigned DtEnumUid;

enum DtSisoEnumUid
{
   DtKindUid = 7,
   DtCountryUid = 29,
   DtEntityTypesUid = 30,
   DtArticulatedPartsUid = 59,
   DtWarheadUid = 60,
   DtEmitterNameUid = 75,
   DtEmitterSystemFunctionUid = 76,
   DtEmitterBeamFunctionUid = 78,
   DtAcousticSystemNameUid = 144,
   DtAcousticBeamFunctionUid = 145,
   DtScanPatternUid = 147,
   DtAggregateKindUid = 206,
   DtAggregateCategoryUid = 207,
   DtAggregateSubcategoryUid = 208,
   DtAggregateSpecificUid = 209,
   DtIsPartOfStationNameUid = 212,
   DtPropulsionPlantConfigurationUid = 335
};

enum DtVrfEnumUid
{
   DtVrfRangeRingUid = 2000000,
   DtVrfResourceBinsUid = DtVrfRangeRingUid + 1,
   DtVrfResourceMeasurementsUid = DtVrfResourceBinsUid + 1,
   DtVrfResourceDefaultMeasurementUid = DtVrfResourceMeasurementsUid + 1,
};

struct DtEnumInfo
{
   DtEnumInfo() {};
   DtEnumInfo(const DtString& d, const DtString& s = DtString::nullString(), bool dep = false)
      : description(d), fileSource(s), deprecated(dep) {};

   int operator==(const DtEnumInfo &other) const
   {
      return (description == other.description);
   }

   int operator!=(const DtEnumInfo &other) const
   {
      return !operator==(other);
   }

   DtString description;
   DtString fileSource;
   bool deprecated = false;
};

class DT_DLL_VLPROTIND DtEnumDictionary
{
public:

   static const unsigned theMakUidRangeStart = 1000000;
   static const unsigned theMakUidRangeEnd = 2000000;

   static const unsigned theVrfUidRangeStart = 2000000;
   static const unsigned theVrfUidRangeEnd = 3000000;

   static const unsigned theAssignedUidRangeStart = 10000000;

   typedef std::map<int, DtEnumInfo> EnumMap;
   typedef std::map<DtEntityType, DtString> EntityTypeDescriptionMap;

   DtEnumDictionary();

   virtual ~DtEnumDictionary();



   virtual EnumMap entityTypeEnumValues(DtEntityTypeField fieldLevel,
      const DtEntityType& higherLevelFields = DtEntityType::defaultType()) const;

   virtual int entityTypeValueFromName(DtEntityTypeField fieldLevel, const DtString& name,
      const DtEntityType& higherLevelFields = DtEntityType::defaultType()) const;

   virtual DtString entityTypeNameFromValue(DtEntityTypeField fieldLevel,
      const DtEntityType& entityType) const;

   virtual DtString displayName(const DtEntityType&, bool includeKind = true,
      int stopAt = DtSubcategoryField, bool* isDeprecated = 0) const;

   virtual void findEntriesContaining(const DtString& text, EntityTypeDescriptionMap& results,
      int maxResults);

   virtual bool isDeprecatedEntityTypeValue(DtEntityTypeField fieldLevel,
      const DtEntityType& entityType) const;

   virtual void addEntityTypeEnum(DtEntityTypeField fieldLevel, const EnumMap& enums,
      const DtEntityTypeRange& applic = DtEntityTypeRange::AllEntityTypes());

   virtual void addEntityTypeEnumWithUid(DtEnumUid uid, DtEntityTypeField fieldLevel, 
      const EnumMap& enums, const DtEntityTypeRange& applic = DtEntityTypeRange::AllEntityTypes());




   virtual void addEnum(DtEnumUid uid, const EnumMap& list, const DtString& name, const DtString& description = "");

   virtual void merge(const DtEnumDictionary&);

   virtual const EnumMap& enumValues(DtEnumUid uid) const;

   virtual int nextId(DtEnumUid uid, bool startFromUser = true) const;

   virtual DtString enumName(DtEnumUid uid) const;
   virtual DtString enumDescription(DtEnumUid uid) const;

   virtual std::vector<DtEnumUid> enumUid(const DtString& name) const;

   virtual int enumValueFromName(DtEnumUid uid, const DtString& n) const;

   virtual DtString enumNameFromValue(DtEnumUid uid, int v) const;

   virtual bool hasNameFromValue(DtEnumUid uid, int val) const;

   virtual bool removeValue(DtEnumUid uid, int val);

   virtual bool isDeprecatedValue(DtEnumUid uid, int val) const;


   virtual void print(std::ostream& strm) const;

   struct EnumInformation
   {
      EnumInformation(const DtString& n, const DtString& d) : name(n), description(d) {};

      DtString name;
      DtString description;
   };

   typedef std::map<DtEnumUid, EnumInformation> UidToNameMap;
   const UidToNameMap& uidToNameMap() const
   {
      return myUidToNameMap;
   }

protected:

   // Needs to be a multimap because there is no guarantee text is unique.
   typedef std::multimap<DtString, DtEnumUid> NameToUidMap;
   typedef std::map<DtEnumUid, EnumMap> UidEnumMap;
   typedef std::vector<EnumMap> UidEnumList;
   typedef std::map<DtEntityTypeRange, DtEnumUid> TypeRangeUidMap;
   typedef std::vector<TypeRangeUidMap> EntityTypeUidList;
   // Needs to be a multimap because items on different entity type branches may have matching names.
   typedef std::multimap<DtString, std::pair<DtEntityType, DtString> > DescriptionEntityTypeMap;

   virtual void mergeEnumMap(EnumMap& dest, const EnumMap& src) const;

   virtual DtEnumUid getAssignedUid();

   virtual void printMap(const EnumMap& enumMap, std::ostream& strm, unsigned indentLvl) const;

   virtual void printMap(const TypeRangeUidMap& enumMap, std::ostream& strm, unsigned indentLvl) const;

   static void setEntityTypeField(DtEntityType& entityType, DtEntityTypeField field, int val);

   static int getEntityTypeField(const DtEntityType& entityType, DtEntityTypeField field);

protected:



   UidEnumMap myEntityTypeEnums;

   EntityTypeUidList myEntityTypeApplicabilityList;

   DescriptionEntityTypeMap myEntityTypeDescriptions;




   UidEnumMap myEnums;

   NameToUidMap myNameToUidMap;

   UidToNameMap myUidToNameMap;


   DtEnumUid myNextAssignedUid;
   
   static const EnumMap theEmptyMap;
};