lgrPublisherInterface.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2016 VT MAK
** All rights reserved.
******************************************************************************/


#pragma once

#include <lgrSim/lgrSim.h>

#include <vlutil/vlTime.h>
#if DtHLA
#include <vl/region.h>
#include <lgrSim/lgrHlaAttribute.h>
#endif

class DtStateMsg;
class DtPdu;

#if DtHLA
class DtHlaObjectWithStateRep;
#endif

namespace MAKLogger
{
   class DtAbsoluteTime;
   class DtPacket;

#if DtHLA
   class DtLgrHlaSimulationManager;
#else
   class DtLgrDisSimulationManager;
#endif

   class DT_DLL_LGRSIM DtLgrPublisherInterface
   {
   public:

#if DtHLA
      DtLgrPublisherInterface(DtLgrHlaSimulationManager& simMgr,
         DtLgrHlaHandle loggerObjectId, DtLgrHlaHandle  loggerClassHandle);
#else
      DtLgrPublisherInterface(DtLgrDisSimulationManager& simMgr);
#endif

      virtual ~DtLgrPublisherInterface();

   public:

#if DtHLA
      virtual void update(const DtStateMsg& msg, const DtAbsoluteTime& updateTime,
         bool isTimeFromPast, bool isStateUpdate, double scaling, bool isStatic, bool sendFlag) = 0;
#else
      virtual void update( const DtPdu& pdu, const DtAbsoluteTime& updateTime, bool isTimeFromPast,
         bool isStateUpdate, double scaling, bool isStatic, bool sendFlag) = 0;
#endif

      virtual DtPacket* createUpdatePacket(const DtAbsoluteTime& time);

      virtual void sendUpdateAtScaleChangePoint(double oldScale, double newScale,
         bool wasStatic, bool isStatic) = 0;

      virtual void tick(double scaling, bool isStatic) = 0;

#if DtDIS

      virtual void setExerciseId(unsigned char exerciseId);

      virtual unsigned char exerciseId() const;
#endif

#if DtHLA

      virtual bool updateRegion(const DtStateMsg& msg);

      virtual void setRegion(const DtDDMRegionSet& region) = 0;

      virtual const DtDDMRegionSet& publishingRegions() const = 0;

      virtual void setStaticRegionFlag(bool enabled);

      virtual bool staticRegionFlag() const;

      virtual bool publishingToRegion( DtDDMRegionSP region ) = 0;

      virtual void setWaitingForRegionData(bool waitForData);

      virtual bool waitingForRegionData();

#if DtHLA_1516
      virtual void addUpdatedAttributes(const RTI::AttributeHandleValueMap& handleValues);
#else
      virtual void addUpdatedAttributes(const RTI::AttributeHandleValuePairSet& handleValues);
#endif

      virtual const RTI::AttributeHandleSet* updatedAttributes() const;
#endif

   protected:

#if DtDIS
      // Adjust exercise connection exercise ID with publisher's exercise ID,
      // when Logger configured to use exercise ID of 0
      virtual void adjustConnectionExerciseId();

      // Reset exercise connection exercise ID with publisher's exercise ID,
      // when Logger configured to use exercise ID of 0
      virtual void resetConnectionExerciseId();

      virtual const DtStateMsg& lastState() const = 0;

      //Adjust DtProtocolVersionToSend to match the version recorded in the Logger tape
      //when Logger is not configured to use DIS version override.
      virtual void adjustProtocolVersionToSend();

      //Reset DtProtocolVersionToSend to the default value.
      virtual void resetProtocolVersionToSend();

      virtual void setInitialDISVersion(int version);
#endif

#if DtHLA
      // HLA

      virtual DtHlaObjectWithStateRep* pubHlaObject() = 0;

      virtual void sendTheseAttrs(const RTI::AttributeHandleSet& attrs, double scale, bool isStatic) = 0;

      virtual void sendAttributes(const DtStateMsg& msg, double scaling, bool isStatic);

      virtual bool sendAllNextTick();

      virtual void setSendAllNextTick(bool yesNo = true);

#endif

   protected:

      DtTime myLastUpdateTime;
#if DtDIS
      DtLgrDisSimulationManager& mySimMgr;
      unsigned char myExConnExerciseId;
      unsigned char myExerciseId;
      int myInitialDISVersion;
      int myDefaultDISVersion;
#endif

#if DtHLA
      DtLgrHlaHandle myLoggerObjectId;
      DtLgrHlaHandle  myLoggerClassHandle;
      DtLgrHlaSimulationManager& mySimMgr;
      bool myWaitingForRegionData;
      bool myStaticRegionFlag;
      RTI::AttributeHandleSet* myUpdatedAttributes;
      bool mySendAllNextTick;
#endif
   };

}