exerciseClock.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1999 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include "vrfMsgTransport/vrfMsgTransportDefines.h"
#include "vrfutil/simClock.h"
#include "vrfutil/fastForwardSettings.h"
#include <readerWriter/noArgumentCallbackList.h>

#include "vlutil/vlTimeStampType.h"

class DtString;
struct DtCommunicationManagerPerformanceTimerInformation;

typedef DtRwReal DtRwTime;

class DT_DLL_vrfMsgTransport DtExerciseClock : public DtSimClock
{
public:

   DtExerciseClock(); 

   DtExerciseClock(const DtExerciseClock& orig);

   DtExerciseClock& operator=(const DtExerciseClock& orig);


   virtual ~DtExerciseClock() override;

   virtual void init() override;

   virtual void reset();
      
   virtual void tick(DtCommunicationManagerPerformanceTimerInformation* performanceTimerInformation = nullptr);

   virtual void pause();

   virtual void resume();

   virtual bool isPaused() const;

   virtual void setFixedFrameMode(DtTime dT);
   virtual bool isFixedFrameMode() const;

   virtual void setRunToCompleteFrameMode();
   virtual bool isRunToCompleteFrameMode() const;

   virtual void setHybridFrameMode(DtTime dT);
   virtual bool isHybridFrameMode() const;

   virtual void setFixedFrameRate(DtTime dT);

   virtual DtTime fixedFrameRate() const;

   virtual void setTimeMultiplier(DtFloat64 timeMultiplier);

   virtual DtFloat64 timeMultiplier() const;

   virtual void setFastForwardSettings(const DtFastForwardSettings& settings);

   virtual DtString &elapsedSimTimeString(DtString &strBuffer) const;

   virtual void setExerciseStartTime(DtTime time);

   virtual DtTime exerciseStartTime() const;

   virtual DtString &exerciseStartTimeString(DtString &strBuffer) const;

   virtual DtTime exerciseTime() const;

   virtual DtString &exerciseTimeString(DtString &strBuffer) const;

   virtual void setExerciseConnectionClockTime(double);

   virtual void set_dT(DtTime dT); 

   virtual DtTime dT() const;

   virtual void setTimeStampType(DtTimeStampType);
   DtTimeStampType timeStampType() const { return myTimeStampType; };

   virtual double simTimeScale() const;

   virtual void addTimeMultiplierUpdateCallback(
      DtCallbackList<DtFloat64>::DtCallbackFunctionType, void* usr);

   virtual void removeTimeMultiplierUpdateCallback(
      DtCallbackList<DtFloat64>::DtCallbackFunctionType fcn, void* usr);

protected:

   enum FrameMode { FmRunToComplete, FmFixed, FmHybrid } myFrameMode;

   bool             myFirstFrame;
   bool             myPaused;
   DtTime                myLastRealTime;
   DtTime                my_dT;
   DtFloat64             myTimeMultiplier;
   DtTime                myFixedFrameRate;
   DtTime                myExerciseStartTime;
   double                mySimTimeScale;
   DtTime                myLastSetSimTime;
   int myFrameSinceOverrunPrintCount;
   int myFrameOverrunCount;
   double myMaxOverrunTime;
   DtTimeStampType myTimeStampType;
   double myExerciseConnectionClockTime;

   bool myUsingFastForwardFrameSettings;
   FrameMode myDefaultFrameMode;
   DtTime myDefaultFixedFrameRate;

   DtFastForwardSettings myFastForwardSettings;

   DtCallbackList<DtFloat64> myTimeMultiplierUpdateCallbacks;
};

inline bool DtExerciseClock::isPaused() const
{
   return myPaused;
}