aerodromeStateComponent.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 "vrfutil/aerodromeStateData.h"
#include "legionDataStore/writeStateInstance.h"
#include <boost/signals2.hpp>

#include <vlutil/vlString.h>

namespace makVrf
{
   class DT_DLL_vrfStateData DtAerodromeStateComponent : public DtSimulatedObjectStateComponent
   {
   public:
      DEFINE_STATE_COMPONENT_TYPE(DtStateComponent::AerodromeStateComponent)

      DtAerodromeStateComponent(DtStateData* storage)
      : DtSimulatedObjectStateComponent(storage)
      {
      }

      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtString, airportCode, AirportCode)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(bool, active, Active)
      virtual DtRunwayStateData& addRunway() { throw DtUnimplementedMethod("The DtRunwayStateData addRunway() method is unimplemented"); };
      virtual void removeRunway(const DtUUID&) { throw DtUnimplementedMethod("The void removeRunway(const DtUUID&) method is unimplemented"); };
      virtual DtRunwayStateData& runway(const DtUUID&) { throw DtUnimplementedMethod("DtRunwayStateData& runway(const DtUUID&) method is unimplemented"); };
      virtual DtRunwayStateData& runway(const std::string&) { throw DtUnimplementedMethod("DtRunwayStateData& runway(const std::string&) method is unimplemented"); };
      virtual const DtRunwayStateData& runway(const DtUUID&) const { throw DtUnimplementedMethod("The const DtRunwayStateData& runway(const DtUUID&) const method is unimplemented"); };
      virtual const DtRunwayStateData& runway(const std::string&) const { throw DtUnimplementedMethod("The const DtRunwayStateData& runway(const std::string&) const method is unimplemented"); };
      virtual const DtRunwayLightStateData& runwayState(const std::string&) const { throw DtUnimplementedMethod("The const DtRunwayLightStateData& runwayState(const std::string&) const method is unimplemented"); };
      virtual const std::map<DtUUID, DtRunwayStateData>& runways() const { throw DtUnimplementedMethod("The std::map<DtUUID, DtRunwayStateData> runways() const  method is unimplemented"); };
      virtual void setRunways(const std::map<DtUUID, DtRunwayStateData>&) { throw DtUnimplementedMethod("The void setRunways(const std::map<DtUUID, DtRunwayStateData>&)  method is unimplemented"); };
      virtual std::vector<DtString> runwaysArchived() const { throw DtUnimplementedMethod("The std::vector<DtString> runwaysArchived() const  method is unimplemented"); };
      virtual void restoreRunwaysFromArchive(const std::vector<DtString>&) { throw DtUnimplementedMethod("The void restoreRunwaysFromArchive(const std::vector<DtString>&)  method is unimplemented"); };
      virtual unsigned char runwayValue(const DtString&, const DtString& runwayName) const { throw DtUnimplementedMethod("The unsigned char runwayValue(const DtString&, const DtString& runwayName) const  method is unimplemented"); };
      virtual void setRunwayValue(const DtString&, unsigned char, const DtString& runwayName) { throw DtUnimplementedMethod("The void setRunwayValue(const DtString&, unsigned char, const DtString& runwayName) const  method is unimplemented"); };
      virtual unsigned char value(const DtString&) const { throw DtUnimplementedMethod("The unsigned char value(const DtString&) const  method is unimplemented"); };
      virtual void setValue(const DtString&, unsigned char) { throw DtUnimplementedMethod("The void setValue(const DtString&, unsigned char) const  method is unimplemented"); };
      virtual void restoreFromArchive(const DtString&) { throw DtUnimplementedMethod("The void restoreFromArchive(const DtString&) const  method is unimplemented"); };
      UNDEFINED_RETURNREF_ACCESSOR(DtAerodromeStateData, frameState)
   };

   class DT_DLL_vrfStateData DtAerodromeStateComponentNextFrame : public DtAerodromeStateComponent
   {
   public:
      DtAerodromeStateComponentNextFrame( DtStateData*);
      virtual ~DtAerodromeStateComponentNextFrame() override;

      virtual const DtAerodromeStateData& frameState() const override { return myData; };
      DtAerodromeStateData& frameState() { return myData; };

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

      virtual const bool& checkForNameReservation() const override;
      virtual void setCheckForNameReservation(const bool&) override;

      virtual const bool& active() const override;
      virtual void setActive(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& airportCode() const override;
      virtual void setAirportCode(const DtString&) override;

      virtual unsigned char value(const DtString&) const override;
      virtual void setValue(const DtString&, unsigned char) override;
      virtual void restoreFromArchive(const DtString&) override;

      virtual unsigned char runwayValue(const DtString&, const DtString& runwayName) const override;
      virtual void setRunwayValue(const DtString&, unsigned char, const DtString& runwayName) override;

      virtual std::vector<DtString> runwaysArchived() const override;

      virtual const DtString& markingText() const override
      {
         return airportCode();
      }

      virtual void setMarkingText(const DtString& t) override
      {
         setAirportCode(t);
      }

      virtual const unsigned long long orbatId() const override { return 0; };
      virtual void setOrbatId(const unsigned long long&) override {};

      virtual void setUserLongLongData(const unsigned long long&) override;
      virtual const UInt64 userLongLongData() const 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;

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

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

      virtual const DtSimulationAddress simEngineAddress() const override;

      virtual DtRunwayStateData& addRunway() override;
      virtual void removeRunway(const DtUUID&) override;
      virtual DtRunwayStateData& runway(const DtUUID&) override;
      virtual DtRunwayStateData& runway(const std::string&) override;
      virtual const DtRunwayStateData& runway(const DtUUID&) const override;
      virtual const DtRunwayStateData& runway(const std::string&) const override;
      virtual const DtRunwayLightStateData& runwayState(const std::string&) const override;

      virtual const std::map<DtUUID, DtRunwayStateData>& runways() const override;
      virtual void setRunways(const std::map<DtUUID, DtRunwayStateData>&) override;

      virtual void restoreRunwaysFromArchive(const std::vector<DtString>&) override;

   protected:
      mutable DtAerodromeStateData myData;
   };

   class DT_DLL_vrfStateData DtAerodromeStateComponentCurrentFrame : public DtAerodromeStateComponent
   {
   public:
      DtAerodromeStateComponentCurrentFrame(DtStateData*);
      virtual ~DtAerodromeStateComponentCurrentFrame() override;

      virtual const DtAerodromeStateData& frameState() const override { return myData; };

      virtual const bool& isLocal() const override;
      virtual const bool& checkForNameReservation() const override;
      virtual const bool& active() const override;
      virtual const DtString& globalId() const override;
      virtual const DtUUID& uuid() const override;
      virtual const DtString& airportCode() const override;
      virtual const DtString& markingText() const override { return airportCode(); }

      virtual const UInt64 userLongLongData() const override;

      virtual const UInt32 appearanceBits() const override;
      virtual const DtEntityType entityType() const override { return DtEntityType(objectType()); };
      virtual const DtEntityType objectType() const override;
      virtual const DtEntityIdentifier& entityId() const override;
      virtual const DtSimulationAddress simEngineAddress() const override;
      virtual std::vector<DtString> runwaysArchived() const override;
      virtual unsigned char value(const DtString&) const override;
      virtual unsigned char runwayValue(const DtString&, const DtString& runwayName) const override;
      virtual const unsigned long long orbatId() const override { return 0; };

      virtual const DtForceType forceType() const override;
      virtual const DtRunwayStateData& runway(const DtUUID&) const override;
      virtual const DtRunwayStateData& runway(const std::string&) const override;
      virtual const DtRunwayLightStateData& runwayState(const std::string&) const override;
      virtual const std::map<DtUUID, DtRunwayStateData>& runways() const override;

   protected:
      friend class DtAerodromeStateComponentImplementation;
      void advanceFrame(const DtAerodromeStateData& data)
      {
         myData = data;
      }

   protected:
      DtAerodromeStateData myData;
   };

   class DT_DLL_vrfStateData DtAerodromeStateComponentImplementation : public DtDoubleBufferedStateComponent<DtAerodromeStateComponent>
   {
   public:
      DtAerodromeStateComponentImplementation(DtStateData* sd);
      virtual ~DtAerodromeStateComponentImplementation() 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 void updateDataStorage() override
      {
         if (myNextFrameState.isWritable())
         {
            myCurrentFrameState.advanceFrame(myNextFrameState.frameState());
         }

         myCurrentFrameState.emitComponentUpdated();
      }

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

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

      virtual void addAdditionalStateComponents() override;
      virtual Legion::WriteStateInstance writeStateInstance() override { return myWriteStateInstance; };

      virtual void convertToRemote() override;

      virtual void convertToLocal() override;

   protected:
      DtAerodromeStateComponentCurrentFrame myCurrentFrameState;
      DtAerodromeStateComponentNextFrame myNextFrameState;
      Legion::WriteStateInstance myWriteStateInstance;
   };

   typedef DtStateComponentCreator<DtAerodromeStateComponentImplementation> DtAerodromeStateComponentCreator;
}