shipClutterAreaControllerDescriptor.h

Go to the documentation of this file.

#pragma once

#include <vrfobjparam/componentDescriptor.h>
#include <vrfobjparam/vrfobjparamDefines.h>
#include <vrfutil/rwEntityTypeList.h>
#include <vrfutil/nLengthIntegerVector.h>
#include <unordered_set>


class DT_DLL_vrfobjparam DtShipClutterAreaControllerDescriptor : public DtComponentDescriptor
{
public:
   class MMSIEntry : public DtReaderWriter
   {
   public:
      MMSIEntry(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
      MMSIEntry(const MMSIEntry& orig);

      virtual int mmsi() const;
      virtual const DtRwEntityType& entityType() const;

      virtual const char* readerWriterType() const override;

      static const char* theXmlType();

      virtual const char* xmlType() const override {
         return theXmlType();
      }

   protected:
      DtRwInt myMMSI;
      DtRwEntityType myEntityType;
   };

   class IMOEntry : public DtReaderWriter
   {
   public:
      IMOEntry(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
      IMOEntry(const IMOEntry& orig);

      virtual int imo() const;
      virtual const DtRwEntityType& entityType() const;

      virtual const char* readerWriterType() const override;

      static const char* theXmlType();

      virtual const char* xmlType() const override {
         return theXmlType();
      }

   protected:
      DtRwInt myIMO;
      DtRwEntityType myEntityType;
   };

   class VesselTypeCodeEntry: public DtReaderWriter
   {
   public:
      VesselTypeCodeEntry(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
      VesselTypeCodeEntry(const VesselTypeCodeEntry& orig);
      
      virtual const DtNLengthIntegerVector& typeCodeLeadingDigits() const;
      virtual const DtNLengthIntegerVector& explicitTypeCodes() const;
      virtual const std::unordered_set<int>& combinedTypeCodes() const;
      virtual const DtRwEntityTypeList& entityTypes() const;
      virtual bool useHullLength() const;
      
      virtual const char* readerWriterType() const override;

      static const char* theXmlType();

      virtual const char* xmlType() const override {
         return theXmlType();
      }
      
   protected:
      DtNLengthIntegerVector myTypeCodeLeadingDigits;
      DtNLengthIntegerVector myExplicitTypeCodes;
      DtRwEntityTypeList myEntityTypes;
      DtRwBoolean myUseHullLength;
      mutable std::unordered_set<int> myCombinedTypeCodes;
   };

   typedef DtRwTemplatedListPtr<MMSIEntry, true> MMSIMappingList;
   typedef DtRwTemplatedListPtr<IMOEntry, true> IMOMappingList;
   typedef DtRwTemplatedListPtr<VesselTypeCodeEntry, true> VesselTypeCodeList;  

   DtShipClutterAreaControllerDescriptor(const DtString& name,
      DtReaderWriterRegistry * parentRegistry = 0);

   virtual ~DtShipClutterAreaControllerDescriptor() override;

   DtShipClutterAreaControllerDescriptor(
      const DtShipClutterAreaControllerDescriptor& orig,
      DtReaderWriterRegistry * parentRegistry = 0);

   DtShipClutterAreaControllerDescriptor& operator=(
      const DtShipClutterAreaControllerDescriptor& orig);

   virtual DtString type() const override;

   virtual const MMSIMappingList&      mmsiMappingList() const;
   virtual const IMOMappingList&       imoMappingList() const;
   virtual const VesselTypeCodeList&   vesselTypeCodeList() const;
   virtual const DtRwEntityTypeList&   excludedEntityTypes() const;
   virtual const DtRwTemplatedIntList& excludedMMSIList() const;
   virtual const DtRwTemplatedIntList& excludedIMOList() const;


   virtual int maxClutterShipsPerArea() const;
   virtual void setMaxClutterShipsPerArea(int n);


   virtual int maxEntitiesCreatedPerTick() const;
   virtual void setEntitiesCreatedPerTick(int n);


   virtual double checkPeriod() const;
   virtual void setCheckPeriod(int p);


   virtual double requestPeriod() const;
   virtual void setRequestPeriod(int p);


   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const override;
   
   static DtComponentDescriptor* creator();

protected:

   MMSIMappingList      myMMSIMappingList;
   IMOMappingList       myIMOMappingList;
   VesselTypeCodeList   myVesselTypeCodeList;
   DtRwEntityTypeList   myExcludedEntityTypes;
   DtRwTemplatedIntList myExcludedMMSIList;
   DtRwTemplatedIntList myExcludedIMOList;


   DtRwInt myMaxClutterShipsPerArea;

   DtRwInt myMaxEntitiesCreatedPerTick;

   DtRwReal myCheckPeriod;

   DtRwReal myRequestPeriod;

};