environmentalStateComponent.h

Go to the documentation of this file.

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

#pragma once

#include "vrfStateData/simulatedObjectStateComponent.h"
#include "vrfStateData/doubleBufferedDataStorage.h"
#include <legionStandardOM/sets/readEnvironmentProcessRepository.hpp>
#include <legionStandardOM/sets/writeEnvironmentProcessRepository.hpp>
#include "vrfOM/sets/writeVrfEnvironmentRecordRepository.hpp"
#include "vrfOM/sets/readVrfEnvironmentRecordRepository.hpp"
#include <boost/signals2.hpp>

#include <vlutil/vlString.h>

class DtRwIntelCollectionArea;

#define DtLineWidthFromAppearance(theAppr) ((theAppr >> 28) & 0x0000000F)
#define DtLineWidthToAppearance(theLineWidth) (theLineWidth << 28)
#define DtLineStyleFromAppearance(theAppr) ((theAppr >> 8) & 0x0000000F)
#define DtLineStyleToAppearance(theLineStyle) (theLineStyle << 8)
#define DtFillStyleFromAppearance(theAppr) ((theAppr >> 12) & 0x0000000F)
#define DtFillStyleToAppearance(theFillStyle) (theFillStyle << 12)

namespace makVrf
{
   DT_DLL_vrfStateData extern Legion::AttributeSetId theVrfEnvironmentRecordSetType;

   struct DT_DLL_vrfStateData DtEnvironmentalStateComponentData 
   {
      DtEnvironmentalStateComponentData()
      : myUUID(DtUUID::nullUUID())
      , myIsLocal(false)
      , myCheckForNameReservation(true)
      , myPhysicalLineHeight(0.)
      , myPhysicalLineWidth(0.)
      , myCeilingHeight(0.)
      , myTickPeriod(-1)
      {};

      DtEnvironmentalStateComponentData(const DtEnvironmentalStateComponentData& orig)
      {
         myPhysicalLineHeight = orig.myPhysicalLineHeight;
         myPhysicalLineWidth = orig.myPhysicalLineWidth;
         myCeilingHeight = orig.myCeilingHeight;
         myGlobalId = orig.myGlobalId;
         myUUID = orig.myUUID;
         myMarkingText = orig.myMarkingText;
         myEntityId = orig.myEntityId;
         myIsLocal = orig.myIsLocal;
         myCheckForNameReservation = orig.myCheckForNameReservation;
         myTickPeriod = orig.myTickPeriod;
         myUserData = orig.myUserData;
      }

      DtEnvironmentalStateComponentData& operator=(const DtEnvironmentalStateComponentData& orig)
      {
         myPhysicalLineHeight = orig.myPhysicalLineHeight;
         myPhysicalLineWidth = orig.myPhysicalLineWidth;
         myGlobalId = orig.myGlobalId;
         myUUID = orig.myUUID;
         myMarkingText = orig.myMarkingText;
         myEntityId = orig.myEntityId;
         myIsLocal = orig.myIsLocal;
         myCheckForNameReservation = orig.myCheckForNameReservation;
         myCeilingHeight = orig.myCeilingHeight;
         myTickPeriod = orig.myTickPeriod;
         myUserData = orig.myUserData;

         return *this;
      }

      DEFINE_ACCESSOR_MUTATOR(double, physicalLineHeight, PhysicalLineHeight)
      DEFINE_ACCESSOR_MUTATOR(double, physicalLineWidth, PhysicalLineWidth)
      DEFINE_ACCESSOR_MUTATOR(double, ceilingHeight, CeilingHeight)
      DEFINE_ACCESSOR_MUTATOR(DtString, globalId, GlobalId)
      DEFINE_ACCESSOR_MUTATOR(DtEntityIdentifier, entityId, EntityId)
      DEFINE_ACCESSOR_MUTATOR(DtUUID, uuid, UUID)
      DEFINE_ACCESSOR_MUTATOR(DtString, markingText, MarkingText)
      DEFINE_ACCESSOR_MUTATOR(bool, isLocal, IsLocal)
      DEFINE_ACCESSOR_MUTATOR(bool, checkForNameReservation, CheckForNameReservation)
      DEFINE_ACCESSOR_MUTATOR(int, tickPeriod, TickPeriod)
      DEFINE_ACCESSOR_MUTATOR(unsigned long long, userData, UserData)

   protected:
      double myPhysicalLineHeight;
      double myPhysicalLineWidth;
      double myCeilingHeight;
      unsigned long long myUserData = 0;
      DtString myGlobalId;
      DtString myMarkingText;
      DtEntityIdentifier myEntityId;
      DtUUID myUUID;
      bool myIsLocal;
      bool myCheckForNameReservation;
      int myTickPeriod;
   };

   class DT_DLL_vrfStateData DtEnvironmentalStateComponent : public DtSimulatedObjectStateComponent
   {
   public:
      DEFINE_STATE_COMPONENT_TYPE(DtStateComponent::EnvironmentalStateComponent)

      DtEnvironmentalStateComponent(DtStateData* storage)
      : DtSimulatedObjectStateComponent(storage)
      , myUUIDColumn(0xFFFFFFFF)
      , myMarkingTextColumn(0xFFFFFFFF)
      , myForceTypeColumn(0xFFFFFFFF)
      , myEntityIdColumn(0xFFFFFFFF)
      , myAppearanceBitsColumn(0xFFFFFFFF)
      , myObjectTypeColumn(0xFFFFFFFF)
      {
      }

      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(int, tickPeriod, TickPeriod)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(int, color, Color)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(DtString, userData, UserData)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(double, physicalLineHeight, PhysicalLineHeight)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(double, physicalLineWidth, PhysicalLineWidth)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(double, ceilingHeight, CeilingHeight)
      UNDEFINED_RETURNVALUE_ACCESSOR(int, penStyle)
      UNDEFINED_RETURNVALUE_ACCESSOR(int, fillStyle)
      UNDEFINED_RETURNVALUE_ACCESSOR(int, lineWidth)

      virtual double intelAreaModifierForForce(int forceType) const { throw DtUnimplementedMethod("intelAreaModifierForForce(int) is not implemented for this class"); };

      virtual int recordCount() const { throw DtUnimplementedMethod("recordCount is not implemented for this class."); };
      
      virtual std::vector<UInt64> records() const { throw DtUnimplementedMethod("records is not implemented for this class."); };

      virtual void addRecord(Legion::WriteStateInstance) { throw DtUnimplementedMethod("addRecord is not implemented for this class."); };

      virtual void removeRecord(Legion::WriteStateInstance) { throw DtUnimplementedMethod("addRecord is not implemented for this class."); };

      virtual UInt64 instanceHandle() const { throw DtUnimplementedMethod("instanceHandle is not implemented for this class."); };

   protected:
      UInt32 myUUIDColumn;
      UInt32 myMarkingTextColumn;
      UInt32 myForceTypeColumn;
      UInt32 myEntityIdColumn;
      UInt32 myAppearanceBitsColumn;
      UInt32 myObjectTypeColumn;
   };

   class DT_DLL_vrfStateData DtEnvironmentalStateComponentNextFrame : public DtEnvironmentalStateComponent
   {
   public:
      DtEnvironmentalStateComponentNextFrame( DtStateData*);
      virtual ~DtEnvironmentalStateComponentNextFrame() override;

      const DtEnvironmentalStateComponentData& frameState() const { return myData; };
      DtEnvironmentalStateComponentData& frameState() { return myData; };
   
      virtual const int penStyle() const override;
      virtual const int fillStyle() const override;
      virtual const int lineWidth() const override;

      virtual const bool& isLocal() const override;
      virtual void setIsLocal(const bool&) override;

      virtual const unsigned long long orbatId() const override { return 0; };
      virtual void setOrbatId(const unsigned long long&) override {}
   
      virtual const bool& checkForNameReservation() const override;
      virtual void setCheckForNameReservation(const bool&) override;
   
      virtual const DtString& globalId() const override;
      virtual void setGlobalId(const DtString&) override;

      virtual const DtUUID& uuid() const override;
      virtual void setUUID(const DtUUID&) override;

      virtual const DtString& markingText() const override;
      virtual void setMarkingText(const DtString&) override;

      virtual const DtForceType forceType() const override;
      virtual void setForceType(const DtForceType&) override;

      virtual const UInt32 appearanceBits() const override;
      virtual void setAppearanceBits(const UInt32&) override;
      void setAppearance(const DtAppearance&);

      virtual const DtEntityType entityType() const override { return objectType(); };
      virtual const DtEntityType objectType() const override;
      virtual void setEntityType(const DtEntityType& t) override;

      virtual const DtSimulationAddress simEngineAddress() const override;

      virtual const unsigned long long userLongLongData() const override;
      virtual void setUserLongLongData(const unsigned long long&) override;

      virtual const DtEntityIdentifier& entityId() const override;
      virtual void setEntityId(const DtEntityIdentifier&) override;

      virtual const int tickPeriod() const override;
      virtual void setTickPeriod(const int&) override;

      virtual const int color() const override;
      virtual void setColor(const int&) override;

      virtual const DtString userData() const override;
      virtual void setUserData(const DtString&) override;

      virtual const double& physicalLineHeight() const override;
      virtual void setPhysicalLineHeight(const double&) override;

      virtual const double& ceilingHeight() const override;
      virtual void setCeilingHeight(const double&) override;

      virtual const double& physicalLineWidth() const override;
      virtual void setPhysicalLineWidth(const double&) override;

      double floor() const;

      virtual void makeWritable() override;

      virtual void makeReadOnly() override;

      virtual int recordCount() const override;
      
      virtual std::vector<UInt64> records() const override;

      virtual void addRecord(Legion::WriteStateInstance) override;

      virtual void removeRecord(Legion::WriteStateInstance) override;

      virtual UInt64 instanceHandle() const override;

      void updateVrfStateComponentParameters();

   protected:
      void updatePhysicalLineHeightInformation();
      void updateCeilingInformation();
      void updatePhysicalLineWidthInformation();

   protected:
      LOM::WriteEnvironmentProcessRepository myWriteEnvironmentProcessRepository;
      VRF::WriteVrfEnvironmentRecordRepository myWriteVrfEnvironmentRecordRepository;
      mutable DtEnvironmentalStateComponentData myData;
   };

   class DT_DLL_vrfStateData DtEnvironmentalStateComponentCurrentFrame : public DtEnvironmentalStateComponent
   {
   public:
      DtEnvironmentalStateComponentCurrentFrame(DtStateData*);
      virtual ~DtEnvironmentalStateComponentCurrentFrame() override;

      const DtEnvironmentalStateComponentData& frameState() const { return myData; };

      virtual const bool& isLocal() const override;
      virtual const bool& checkForNameReservation() const override;
      virtual const DtString& globalId() const override;
      virtual const DtUUID& uuid() const override;
      virtual const DtString& markingText() const override;
      virtual const DtForceType forceType() const override;
      virtual const DtEntityType entityType() const override { return objectType(); };
      virtual const DtEntityType objectType() const override;
      virtual const DtEntityIdentifier& entityId() const override;
      virtual const UInt32 appearanceBits() const override;
      virtual const int tickPeriod() const override;
      virtual const int color() const override;
      virtual const DtString userData() const override;
      virtual const double& physicalLineHeight() const override;
      virtual const double& physicalLineWidth() const override;
      virtual const double& ceilingHeight() const override;
      virtual double intelAreaModifierForForce(int forceType) const override;
      virtual const unsigned long long userLongLongData() const override;
      virtual const unsigned long long orbatId() const override { return 0; };
      virtual const DtSimulationAddress simEngineAddress() const override;
   
      virtual const int penStyle() const override;
      virtual const int fillStyle() const override;
      virtual const int lineWidth() const override;

      bool readComponentValid() const;

      bool findReadComponent();

      virtual int recordCount() const override;
      
      virtual std::vector<UInt64> records() const override;

      virtual UInt64 instanceHandle() const override;

      bool checkForUpdatedItems();

   protected:
      const DtUUID _uuid() const;
      const DtString _markingText() const;
      const DtEntityIdentifier _entityId() const;

      void completeSetup();
      void updateVrfStateComponentParameters();

      void updatePhysicalLineHeightInformation();
      void updateCeilingInformation();
      void updatePhysicalLineWidthInformation();

      void handleDataUpdated(const std::vector<UInt32>& attributesUpdated);
      bool checkUUIDChanged();
      bool checkForceChanged();
      bool checkMarkingTextChanged();
      bool checkEntityIdChanged();

      friend class DtEnvironmentalStateComponentImplementation;
      void advanceFrame(const DtEnvironmentalStateComponentData& data)
      {
         myData = data;
      }

   protected:
      boost::signals2::scoped_connection myVrfStateComponentChangedConnection;
      DtRwIntelCollectionArea* myIntelCollectionAreaInformation;
      LOM::ReadEnvironmentProcessRepository myReadEnvironmentProcessRepository;
      VRF::ReadVrfEnvironmentRecordRepository myReadVrfEnvironmentRecordRepository;
      unsigned int myCallbackHandle;
      unsigned int myDataCallbackHandle;
      UInt32 myCenterPointColumn;
      UInt32 myOrientationColumn;
      int myForceId;
      std::string myMarkingText;

      DtEnvironmentalStateComponentData myData;
   };

   class DT_DLL_vrfStateData DtEnvironmentalStateComponentImplementation : public DtDoubleBufferedStateComponent<DtEnvironmentalStateComponent>
   {
   public:
      DtEnvironmentalStateComponentImplementation(DtStateData* sd);
      virtual ~DtEnvironmentalStateComponentImplementation() override;

      bool isDoubleBuffered() { return true; };
      virtual const DtFrameStateInterface* currentFrameState() const override { return &myCurrentFrameState; }
      virtual DtFrameStateInterface* nextFrameState() override { return &myNextFrameState; };
      virtual const DtFrameStateInterface* nextFrameState() const override { return &myNextFrameState; };

      virtual bool forceAdvance() override;
      static void addAdditionalTableColumns(Legion::SimulationDatabase* db);

      virtual void updateDataStorage() override
      {
         if (!myFoundComponent)
         {
            myFoundComponent = myCurrentFrameState.findReadComponent();
         }

         if (myNextFrameState.isWritable())
         {
            myNextFrameState.updateVrfStateComponentParameters();
            myCurrentFrameState.advanceFrame(myNextFrameState.frameState());
         }

         myCurrentFrameState.checkForUpdatedItems();
         myCurrentFrameState.emitComponentUpdated();
      }

      virtual void updateStateData(DtStateData* sd) override
      {
         myCurrentFrameState.updateStateData(sd);
         myNextFrameState.updateStateData(sd);
      }

      virtual void convertToRemote() override;

      virtual void convertToLocal() override;

      virtual Legion::WriteStateInstance writeStateInstance() override { return myWriteEnvironmentProcessRepository; };

      virtual void addAdditionalStateComponents() override;

      virtual void firstFrameAdvance() override;

      virtual void aboutToBeDeleted() override
      {
         DtDoubleBufferedStateComponent<DtEnvironmentalStateComponent>::aboutToBeDeleted();
         myCurrentFrameState.aboutToBeDeleted();
         myNextFrameState.aboutToBeDeleted();
      }

   protected:
      DtEnvironmentalStateComponentCurrentFrame myCurrentFrameState;
      DtEnvironmentalStateComponentNextFrame myNextFrameState;
      LOM::WriteEnvironmentProcessRepository myWriteEnvironmentProcessRepository;
      bool myFoundComponent;
      bool myCheckedForVrfStateComponent;
      boost::signals2::scoped_connection myVrfStateComponentChangedConnection;
   };

   typedef DtStateComponentCreator<DtEnvironmentalStateComponentImplementation> DtEnvironmentalStateComponentCreator;
}