stateComponentImplementationTemplate.h

Go to the documentation of this file.

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

#pragma once

#include "vrfStateData/stateComponent.h"
#include "vrfStateData/doubleBufferedDataStorage.h"
#include <vrfExtObjects/vrfWeatherStateEnums.h>
#include <tbb/spin_rw_mutex.h>

#define SCOPED_WRITE_LOCK_BEGIN \
   tbb::spin_rw_mutex::scoped_lock* lock = nullptr; \
   if (myIsRemoteComponent) { lock = new tbb::spin_rw_mutex::scoped_lock(myMutex, true); }
#define SCOPED_READ_LOCK_BEGIN \
   tbb::spin_rw_mutex::scoped_lock* lock = nullptr; \
   if (myIsRemoteComponent) { lock = new tbb::spin_rw_mutex::scoped_lock(myMutex, false); }
#define SCOPED_LOCK_END delete lock;

#define DEFINE_FIELD(MemberType, Member) \
protected: \
      MemberType my##Member{};

#define ACCESSOR_MUTATOR_MEMBER(MemberType, Accessor, MutatorAndMember) \
public: \
   DEFINE_REF_ACCESSORS(MemberType, Accessor, MutatorAndMember); \
   DEFINE_MUTATOR(MemberType, MutatorAndMember); \
   DEFINE_FIELD(MemberType, MutatorAndMember)

#define FRAME_ACCESSOR(MemberType, Accessor) \
      const MemberType Accessor() const override { return frameState().Accessor(); };  
#define FRAME_ACCESSOR_BY_REF(MemberType, Accessor) \
      const MemberType& Accessor() const override { return frameState().Accessor(); };  
#define FRAME_MUTATOR(MemberType, MutatorAndMember) \
      void set##MutatorAndMember(const MemberType& v) override { frameState().set##MutatorAndMember(v); }; 

#define FRAME_ACCESSOR_WITHLOCK(MemberType, Accessor) \
      const MemberType Accessor() const override { SCOPED_READ_LOCK_BEGIN MemberType mt =  frameState().Accessor(); SCOPED_LOCK_END return mt; };  
#define FRAME_ACCESSOR_BY_REF_WITHLOCK(MemberType, Accessor) \
      const MemberType& Accessor() const override { SCOPED_READ_LOCK_BEGIN const MemberType& mt = frameState().Accessor();  SCOPED_LOCK_END return mt; };  

#define NEXT_FRAME_MUTATOR(MemberType, MutatorAndMember, Accessor) \
      void set##MutatorAndMember(const MemberType& v) override { if (frameState().Accessor() != v) { markModified(); frameState().set##MutatorAndMember(v); } }; 

#define NEXT_FRAME_MUTATOR_WITHLOCK(MemberType, MutatorAndMember, Accessor) \
      void set##MutatorAndMember(const MemberType& v) override { if (frameState().Accessor() != v) { SCOPED_WRITE_LOCK_BEGIN markModified(); frameState().set##MutatorAndMember(v); SCOPED_LOCK_END } }; 

#define NEXTFRAME_ACCESSOR_MUTATOR(MemberType, Accessor, MutatorAndMember) \
   public: \
      FRAME_ACCESSOR(MemberType, Accessor)  \
      NEXT_FRAME_MUTATOR(MemberType, MutatorAndMember, Accessor)
#define NEXTFRAME_ACCESSOR_MUTATOR_WITHLOCK(MemberType, Accessor, MutatorAndMember) \
   public: \
      FRAME_ACCESSOR_WITHLOCK(MemberType, Accessor)  \
      NEXT_FRAME_MUTATOR_WITHLOCK(MemberType, MutatorAndMember, Accessor)
#define NEXTFRAME_ACCESSOR_BY_REF_MUTATOR(MemberType, Accessor, MutatorAndMember) \
   public: \
      FRAME_ACCESSOR_BY_REF(MemberType, Accessor)  \
      NEXT_FRAME_MUTATOR(MemberType, MutatorAndMember, Accessor)
#define CURRENTFRAME_ACCESSOR(MemberType, Accessor, MutatorAndMember) \
      FRAME_ACCESSOR(MemberType, Accessor)  

#define CURRENTFRAME_ACCESSOR_BY_REF(MemberType, Accessor, MutatorAndMember) \
      FRAME_ACCESSOR_BY_REF(MemberType, Accessor)  

template < typename T_BaseComponent, typename V_Data>
class DT_DLL_vrfStateData DtStateComponentNextFrameTemplate : public T_BaseComponent
{
public:
   DtStateComponentNextFrameTemplate(makVrf::DtStateData* sd)
   : T_BaseComponent(sd)
   {
   };

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


protected:
   V_Data myData;
};

template < typename T_BaseComponent, typename U_CurrentFrame, typename V_NextFrame >
class DT_DLL_vrfStateData DtStateComponentImplementationTemplate 
   : public makVrf::DtDoubleBufferedStateComponent<T_BaseComponent>
{
   typedef makVrf::DtDoubleBufferedStateComponent<T_BaseComponent> ParentType;
public:
   DtStateComponentImplementationTemplate(makVrf::DtStateData* sd)
   : ParentType(sd)
   , myCurrentFrameState(sd)
   , myNextFrameState(sd)
   {
   }

   bool isDoubleBuffered() { return true; };
   virtual const makVrf::DtFrameStateInterface* currentFrameState() const override { return &myCurrentFrameState; }
   virtual makVrf::DtFrameStateInterface* nextFrameState() override { return &myNextFrameState; };
   virtual const makVrf::DtFrameStateInterface* nextFrameState() const override { return &myNextFrameState; };
   virtual void setIsRemoteComponent(bool b) override { myCurrentFrameState.setIsRemoteComponent(b); myNextFrameState.setIsRemoteComponent(b);
      makVrf::DtDoubleBufferedStateComponent<T_BaseComponent>::setIsRemoteComponent(b); };

   virtual void updateDataStorage() override
   {
      if (myNextFrameState.isWritable())
      {
         myCurrentFrameState.advanceFrame(myNextFrameState.frameState());
      }

      myCurrentFrameState.emitComponentUpdated();
   }

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

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

protected:
   U_CurrentFrame myCurrentFrameState;
   V_NextFrame myNextFrameState;
};

template < typename T_BaseComponent, typename V_NextFrame, typename W_Data >
class DT_DLL_vrfStateData DtStateComponentCurrentFrameTemplate : public T_BaseComponent
{
public:
   DtStateComponentCurrentFrameTemplate(makVrf::DtStateData* sd)
   : T_BaseComponent(sd)
   {
   };

   virtual ~DtStateComponentCurrentFrameTemplate()
   {
   };

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

protected:
 
   template<typename, typename, typename> friend class DtStateComponentImplementationTemplate;
   void advanceFrame(const W_Data& data)
   {
      myData = data;
   }

protected:
   W_Data myData;
};