laserDesignatorStateComponent.h

Go to the documentation of this file.

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

#pragma once

#include "vrfStateData/stateComponent.h"
#include "vrfStateData/doubleBufferedDataStorage.h"
#include <legionStandardOM/sets/readDesignatorRepository.hpp>
#include <legionStandardOM/sets/writeDesignatorRepository.hpp>
#include <vrfutil/rwUUID.h>
#include <matrix/vlVector.h>

namespace makVrf
{
   struct DT_DLL_vrfStateData DtLaserDesignatorStateComponentData
   {
      DtLaserDesignatorStateComponentData()
      : myDesignatedObject(DtUUID::nullUUID())
      , myDesignatorId(DtUUID::nullUUID())
      , myUserData(0)
      {
      }

      DtLaserDesignatorStateComponentData(const DtLaserDesignatorStateComponentData& orig)
      : myDesignatedObject(orig.myDesignatedObject)
      , myDesignatorId(orig.myDesignatorId)
      , myGlobalId(orig.myGlobalId)
      , myUserData(orig.myUserData)
      {
      }

      DtLaserDesignatorStateComponentData& operator=(const DtLaserDesignatorStateComponentData& rhs)
      {
         myDesignatedObject = rhs.myDesignatedObject;
         myDesignatorId = rhs.myDesignatorId;
         myGlobalId = rhs.myGlobalId;
         myUserData = rhs.myUserData;

         return *this;
      }

      DEFINE_ACCESSOR_MUTATOR(DtUUID, designatedObject, DesignatedObject)
      DEFINE_ACCESSOR_MUTATOR(DtUUID, designatorId, DesignatorId)
      DEFINE_ACCESSOR_MUTATOR(DtString, globalId, GlobalId)
      DEFINE_ACCESSOR_MUTATOR(unsigned long long, userData, UserData)

   protected:
      DtUUID myDesignatedObject;
      DtUUID myDesignatorId;
      DtString myGlobalId;
      unsigned long long myUserData;
   };

   class DT_DLL_vrfStateData DtLaserDesignatorStateComponent : public DtFrameStateInterface
   {
   public:
      DEFINE_STATE_COMPONENT_TYPE(DtStateComponent::LaserDesignatorStateComponent)

      DtLaserDesignatorStateComponent(DtStateData* storage)
      : DtFrameStateInterface(storage)
      {
      }

      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtUUID, designatedObject, DesignatedObject)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtUUID, designatorId, DesignatorId)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, designatorCode, DesignatorCode)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, drAlgorithm, DrAlgorithm)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(double, designatorPower, DesignatorPower)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(double, designatorWavelength, DesignatorWavelength)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(DtVector, designatorSpotLocation, DesignatorSpotLocation)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(DtVector, relativeSpotLocation, RelativeSpotLocation)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(DtVector, relativePosition, RelativePosition)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, codeName, CodeName)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned long long, userData, UserData)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(DtVector, spotLinearAcceleration, SpotLinearAcceleration)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtString, globalId, GlobalId)
   };

   class DT_DLL_vrfStateData DtLaserDesignatorStateComponentNextFrame : public DtLaserDesignatorStateComponent
   {
   public:
      DtLaserDesignatorStateComponentNextFrame(DtStateData* storage);
      virtual ~DtLaserDesignatorStateComponentNextFrame() override;

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

      virtual const DtUUID& designatedObject() const override;
      virtual void setDesignatedObject(const DtUUID&) override;

      virtual const DtUUID& designatorId() const override;
      virtual void setDesignatorId(const DtUUID&) override;

      virtual const unsigned int designatorCode() const override;
      virtual void setDesignatorCode(const unsigned int&) override;

      virtual const unsigned long long userData() const override;
      virtual void setUserData(const unsigned long long&) override;

      virtual const unsigned int drAlgorithm() const override;
      virtual void setDrAlgorithm(const unsigned int&) override;

      virtual const unsigned int codeName() const override;
      virtual void setCodeName(const unsigned int&) override;

      virtual const DtVector spotLinearAcceleration() const override;
      virtual void setSpotLinearAcceleration(const DtVector&) override;

      virtual const double designatorPower() const override;
      virtual void setDesignatorPower(const double&) override;

      virtual const double designatorWavelength() const override;
      virtual void setDesignatorWavelength(const double&) override;

      virtual const DtVector designatorSpotLocation() const override;
      virtual void setDesignatorSpotLocation(const DtVector&) override;

      virtual const DtVector relativeSpotLocation() const override;
      virtual void setRelativeSpotLocation(const DtVector&) override;

      virtual const DtVector relativePosition() const override;
      virtual void setRelativePosition(const DtVector&) override;

      virtual const DtString& globalId() const override;
      virtual void setGlobalId(const DtString&) override;

      virtual void makeWritable() override;

      virtual void makeReadOnly() override;
      void cleanupWriteState();

   protected:
      DtLaserDesignatorStateComponentData myData;
      LOM::WriteDesignatorRepository myWriteDesignatorRepository;
   };

   class DT_DLL_vrfStateData DtLaserDesignatorStateComponentCurrentFrame : public DtLaserDesignatorStateComponent
   {
   public:
      DtLaserDesignatorStateComponentCurrentFrame(DtStateData* storage);
      virtual ~DtLaserDesignatorStateComponentCurrentFrame() override;

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

      virtual const unsigned long long userData() const override;
      virtual const DtUUID& designatedObject() const override;
      virtual const DtUUID& designatorId() const override;
      virtual const unsigned int designatorCode() const override;
      virtual const double designatorPower() const override;
      virtual const double designatorWavelength() const override;
      virtual const DtVector designatorSpotLocation() const override;
      virtual const DtVector relativeSpotLocation() const override;
      virtual const DtVector relativePosition() const override;
      virtual const unsigned int codeName() const override;
      virtual const DtVector spotLinearAcceleration() const override;
      virtual const unsigned int drAlgorithm() const override;
      virtual const DtString& globalId() const override;

      bool readComponentValid() const;
      bool findReadComponent();

   protected:
      void handleDataUpdated();

      friend class DtLaserDesignatorStateComponentImplementation;
      void advanceFrame(const DtLaserDesignatorStateComponentData& data)
      {
         myData = data;
      }

   protected:
      DtLaserDesignatorStateComponentData myData;
      LOM::ReadDesignatorRepository myReadDesignatorRepository;
      int myCallbackHandle;
   };

   class DT_DLL_vrfStateData DtLaserDesignatorStateComponentImplementation : public DtDoubleBufferedStateComponent<DtLaserDesignatorStateComponent>
   {
   public:
      DtLaserDesignatorStateComponentImplementation(DtStateData* sd);

      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;

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

            myCurrentFrameState.advanceFrame(myNextFrameState.frameState());
         }

         myCurrentFrameState.emitComponentUpdated();
      }

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

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

      virtual void firstFrameAdvance() override;
      virtual void removeAdditionalStateComponents() override;

   protected:
      DtLaserDesignatorStateComponentCurrentFrame myCurrentFrameState;
      DtLaserDesignatorStateComponentNextFrame myNextFrameState;
      bool myFoundComponent;
   };

   typedef DtStateComponentCreator<DtLaserDesignatorStateComponentImplementation> DtLaserDesignatorStateComponentCreator;
}