cigiPublisherTemplate.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once
 
#include "vreCigiHost/cigiPublisherBase.h"
 
namespace makVre
{
 
//! @brief Template for creating CigiPublisher classes.
//!
//!    Handles implementation of cigi(), createCigi(), shared() and verifySharedType()
//!
//!    The final DATA_CREATOR_T type parameter is optional. Use the default DtCigiDataCreatorStub
//!    when implementing an abstract base Publisher class using an abstract base CIGI_t type.
//!    Use DtCigiDataCreator when implementing a concreate/final Publisher class (typcially versioned).
//!
//! @tparam CIGI_T Type of the CIGI packet class to be managed by this Publisher
//! @tparam SELF_T Type of the class implementing this template
//! @tparam SUPER_T Parent Publisher from which SELF_T Publisher type should be derived, default is DtCigiPublisherBase
//! @tparam DATA_CREATOR_T One of DtCigiDataCreatorStub or DtCigiDataCreator
template <class CIGI_T, class SELF_T, class SUPER_T = DtCigiPublisherBase, class DATA_CREATOR_T = DtCigiDataCreatorStub>
class DtCigiPublisherTemplate : public DtSpSubClass<SELF_T, SUPER_T>
{
public:
   using Cigi = CIGI_T;
   using CigiData = DtCigiDataTemplate<CIGI_T, SELF_T>;
 
   DtCigiPublisherTemplate() {}
   virtual ~DtCigiPublisherTemplate() override {}
 
   CigiData* cigi() { return static_cast<CigiData*>(this->cigiBase()); }
   CigiData* const cigi() const { return static_cast<CigiData*>(this->cigiBase()); }
 
   CigiData* shared() { return static_cast<CigiData*>(this->mySharedData.get()); }
   CigiData* const shared() const { return static_cast<CigiData*>(this->mySharedData.get()); }
 
protected:
   DtCigiDataBase* createCigi() override
   {
      DATA_CREATOR_T creator;
      return creator.create<DtCigiDataBase, CigiData>();
   }
 
   bool verifySharedType() override { return bool(this->cast<CigiData>(this->mySharedData)); }
};
 
} // namespace makVre