cigiObjectBase.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once
 
#include "vreCigiHost/export.h"
#include "vreCigiHost/cigiData.h"
 
#include "vreUtil/baseClass.h"
 
#include <CigiTypes.h>
#include <CigiBasePacket.h>
 
#include <memory>
 
namespace makVre
{
class DtCigiSession;
 
 
class CIGIHOST_DLL DtCigiObjectBase : public DtSpSubClass<DtCigiObjectBase>
{
public:
   using Cigi = CigiBasePacket;
   using CigiData = DtCigiDataTemplate<CigiBasePacket, DtCigiObjectBase>;
   using CigiBasePtr = std::shared_ptr<DtCigiDataBase>;
 
   DtCigiObjectBase();
   virtual ~DtCigiObjectBase() override;
 
   //! @brief Get pointer to CIGI packet data managed by this object.
   CigiData* cigi();
   CigiData* const cigi() const;
 
   //! @brief Get the ID of the CigiData type.
   //! @return cigi()->GetPacketID()
   virtual Cigi_uint16 cigiType();
 
   //! @brief Get/Set reference to the CigiSession to which this object belongs.
   virtual Sptr setSession(DtCigiSession& session);
   virtual DtCigiSession& session() const;
 
   virtual bool init();
 
   //! @brief Get CIGI protocol major version number for this Session.
   virtual unsigned int sessionVersion() const;
 
   //! @brief Dirty flag indicates whether this CIGI data has changed in this frame.
   //!
   //!   Used by Publishers to determine when to write and send data to the IG.
   virtual void markDirty();
   virtual void markClean();
   virtual bool isDirty() const;
 
protected:
   virtual DtCigiDataBase* createCigi() = 0;
 
   DtCigiDataBase* cigiBase();
   DtCigiDataBase* const cigiBase() const;
 
   //! Utility function to update value from source and note
   //! if the value changed.
   template <typename VALUE_T>
   bool updateValue(VALUE_T* value, VALUE_T source)
   {
      if (*value != source)
      {
         *value = source;
         markDirty();
         return true;
      }
      return false;
   }
 
protected:
   CigiBasePtr myCigiData;
 
   DtCigiSession* mySession;
   bool myDirty;
};
 
} // namespace makVre