cigiTimePublisherV4.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once
 
//! \file cigiTimePublisherV4.h
//! \brief Declares DtCigiTimePublisherV4, the CIGI 4 concrete time publisher.
 
// Declare concrete CIGI version 4 version of TimePublisher. This class should be
// registered as the class to instantiate for version 4 of a DtCigiTimePublisher,
// by calling "DtCigiTimePublisher::registerCreatorVersion<DtCigiTimePublisherV4(4)"
// during plugin initialization. This class will then be instantiated whenever a
// new DtCigiTimePublisher is created in a CigiSession running CIGI version 4.
//
// This class uses the same DtCigiPublisher template, but this time the CIGI
// packet type is a concrete versioned class. The CIGI packet type of a derived
// Publisher subclass must be itself derived from the CIGI packet type of the
// Publisher superclass. In this case CigiCelestialCtrlV4 is used, which is
// a subclass of CigiBaseEnvCtrl.
//
// The superclass this time is the abstract unversioned DtCigiTimePublisher.
//
// As this is a concrete class that will be instantiated, an additional type
// argument "DtCigiDataCreator" must be supplied to the DtCigiPublisher template.
// This argument is left off for pure virtual base classes that cannot or should
// not be instantiated.
 
#include "cigiTimePublisher.h"
 
#include <CigiCelestialCtrlV4.h>
 
namespace makVre
{
 
//! \brief Concrete time publisher for CIGI version 4 celestial control packets.
//!
//! This class binds DtCigiTimePublisher to the CigiCelestialCtrlV4 packet type
//! and enables factory-based creation via DtCigiDataCreator. All simulation-time
//! publishing logic remains in the unversioned base class, so this type mainly
//! specifies the concrete packet used when a CIGI 4 session is active.
class DtCigiTimePublisherV4
   : public DtCigiPublisherTemplate<CigiCelestialCtrlV4, DtCigiTimePublisherV4, DtCigiTimePublisher, DtCigiDataCreator>
{
public:
   //! \brief Constructs a concrete CIGI 4 time publisher.
   DtCigiTimePublisherV4() {}
 
   //! \brief Destroys the CIGI 4 time publisher instance.
   virtual ~DtCigiTimePublisherV4() {}
 
   // Additinal override functions may be added as needed here to handle any
   // manipulation of the CIGI packet data which requires the V4 API and cannot
   // be done through the CigiBaseEnvCtrl interface in the DtCigiTimePublisher
   // class. In this case, all necessary CIGI data members are present in the
   // CigiBaseEnvCtrl class, so no derived functions are required here. This
   // class exists only to instantiate the concrete CIGI packet data class
   // CigiCelestialCtrlV4 and thereby use the V4 packet writing function.
};
 
} // namespace makVre