cigiData.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once
 
//! @file cigiData.h
//!
//! CigiData classes are used by CigiObjectBase classes to manage their CIGI
//! packet class instances.
 
#include "vreCigiHost/export.h"
 
#include "vreUtil/baseClass.h"
 
namespace makVre
{
class DtCigiObjectBase;
 
 
//! @brief Base CigiData class used by DtCigiDataTemplate.
//!
//! This base class does not itself contain any CIGI packet type.
class CIGIHOST_DLL DtCigiDataBase : public DtSpSubClass<DtCigiDataBase>
{
public:
   DtCigiDataBase()
      : myFrame(0)
   {
   }
   virtual ~DtCigiDataBase() override {}
 
   virtual unsigned int frame() const;
   virtual void setFrame(unsigned int frame);
 
   friend DtCigiObjectBase;
 
protected:
   unsigned int myFrame;
};
 
//! @brief Template used to compose a CigiData class for a specific CIGI type.
//!
//!   DtCigiDataTemplate does not generally need to be used directly by developers
//!   writing CigiPublisher-derived classes, as this is handled automatically
//!   by DtCigiPublisherTemplate and DtCigiListenerTemplate.
//!
//! @tparam CIGI_T should be a specific CIGI packet class type from the CIGI SDK.
//! @tparam FRIEND_T should be the CigiPublisher or CigiListener-derived class which
//! will manage this CigiData object.
template <class CIGI_T, class FRIEND_T>
class DtCigiDataTemplate : public DtSpSubClass<DtCigiDataTemplate<CIGI_T, FRIEND_T>, DtCigiDataBase>, public CIGI_T
{
public:
   DtCigiDataTemplate() {}
   virtual ~DtCigiDataTemplate() override {}
 
   friend FRIEND_T;
};
 
//! @brief Stub base class used as default DATA_CREATOR_T in
//! DtCigiPublisherTemplate and DtCigiListenerTemplate.
//!
//!   This base CigiDataCreator does not instantiate a CigiData object.
//!   This is needed to allow the declaration of Publisher and Listener
//!   base classes which use CigiData objects of base CIGI types which
//!   are pure-virutal and cannot be instantiated.
//!
//!   Example: DtCigiEntityPublisherBase, which uses a CIGI type of
//!   CigiBaseEntityCtrl, which is a pure-virtual abstract class.
class CIGIHOST_DLL DtCigiDataCreatorStub{public: DtCigiDataCreatorStub(){} virtual ~DtCigiDataCreatorStub(){}
 
                                         template <class BASE_T, class CREATE_T>
                                         BASE_T *
                                         create(){return nullptr;
} // namespace makVre
}
;
 
//! @brief CigiDataCreator class used by concrete Publisher and
//! Listener classes for which their CigiData CIGI types can be
//! instantiated.
//!
//!   DtCigiDataCreator must be used as the final type argument to a
//!   Publisher or Listener template to override the default Stub.
class CIGIHOST_DLL DtCigiDataCreator : public DtCigiDataCreatorStub
{
public:
   DtCigiDataCreator() {}
   virtual ~DtCigiDataCreator() override {}
 
   template <class BASE_T, class CREATE_T>
   BASE_T* create()
   {
      static DtCreator<BASE_T, CREATE_T> creator;
      return creator.create();
   }
};
 
} // namespace makVre