lgrPlaybackDriver.h

Go to the documentation of this file.

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


#ifndef lgrPlaybackDriver_H_
#define lgrPlaybackDriver_H_

#include <lgrCore/lgrDriver.h>
#include <lgrCore/lgrClock.h>
#include <lgrUtil/virtualConstructor.h>

#include <vlutil/vlString.h>
#include <deque>

namespace MAKLogger
{
   class DtLgrFileInput;
   class DtMessagePipeline;
   class DtLgrSystemDriver;
   class DtLgrPlaybackCommandFactory;
   class DtLgrPlaybackInterface;
   class DtLgrEntityTracker;

   class DT_DLL_LGRCORE DtLgrPlaybackDriver : public DtLgrCommandHandler
   {
   public:

      typedef DtLgrPlaybackCommandFactory Factory;
      typedef DtLgrPlaybackInterface Interface;

      DT_VIRTUAL_CTR(DtLgrPlaybackDriver,(DtLgrSystemDriver&))
      virtual ~DtLgrPlaybackDriver();

      virtual void tick();

      virtual bool getPipeline();
      virtual bool hasPipeline() const;
      virtual bool releasePipeline();

      virtual void setUnsavedFile(const DtString& filename, bool selectAll);

      virtual void openVirtualFile(const DtString& actualFileName, const DtString& desiredName);

      virtual void configurePipeline();

      virtual bool isFileSaved() const;

      virtual bool isFileOpen() const;

      virtual bool isPlaying() const;

      virtual bool isStopped() const;

      virtual bool isPaused() const;

      virtual bool isFileIncomplete() const;

      virtual double playbackSpeed() const;

      virtual bool skippingPlayback() const;

      virtual double skippingPlaybackThreshold() const;

      virtual bool skippingPlaybackInteractions() const;

      virtual DtAbsoluteTime currentTime() const;

      virtual DtAbsoluteTime startTime() const;

      virtual DtAbsoluteTime stopTime() const;

      virtual DtAbsoluteTime firstMessageTime() const;

      virtual DtAbsoluteTime lastTime() const;

      virtual const DtString& currentFilename() const;

      virtual const DtString& savedFilename() const;

      virtual bool loopAtEnd() const;

      virtual bool playOnLoad() const;

      virtual bool fileFormatCurrent() const;

      virtual int fileVersion() const;

      virtual bool backupOnSave() const;

      virtual DtLgrEntityTracker* entityTracker() const;

      virtual void addTemporaryTrackedEntity(const DtString& name);

      virtual double packetViewInterval() const;

      virtual double followingInterval() const;

      virtual double followingExportInterval() const;


   protected:

      bool prepareDriverForOpen();


      virtual void tickStopPlayback();
      virtual void tickNormalPlayback();
      virtual void tickPausePlayback();
      virtual void tickSkippingPlayback();
      virtual void tickExtendedStopPlayback();

      virtual bool doSwapInFile(const DtString& filename, bool selectAll);

      virtual bool doPlay();
      virtual bool doStop();
      virtual bool doPause();
      virtual bool doUnpause();
      virtual bool doPlaybackSpeedChange(double speed);
      virtual void doTimeJump(const DtAbsoluteTime& time);
      virtual void doSkippingPlay(const DtAbsoluteTime& time);
      virtual bool doRecoverLastPacket();


      DtResponse openFile(const DtCommand& command);

      virtual bool doOpenFile( DtString filename );

      void sendFileInputChangedResponses(const DtString& filename);

      DtResponse closeFile(const DtCommand& command);

      DtResponse saveFile(const DtCommand& command);

      DtResponse saveFileAs(const DtCommand& command);

      DtResponse revertFile(const DtCommand& command);

      DtResponse play(const DtCommand& command);

      DtResponse playPause(const DtCommand& command);

      DtResponse stop(const DtCommand& command);

      DtResponse restart(const DtCommand& command);

      DtResponse setStartStopTimes(const DtCommand& command);

      DtResponse setPlaybackSpeed(const DtCommand& command);

      DtResponse setCurrentTime(const DtCommand& command);

      DtResponse skipTime(const DtCommand& command);

      DtResponse pause(const DtCommand& command);

      DtResponse unpause(const DtCommand& command);

      DtResponse setLoopAtEnd(const DtCommand& command);

      DtResponse setPlayOnLoad(const DtCommand& command);

      DtResponse setBackupOnSave(const DtCommand& command);

      DtResponse setSkippingPlaybackThreshold(const DtCommand& command);

      DtResponse setSkippingPlaybackInteractions(const DtCommand& command);

      DtResponse setPacketViewInterval(const DtCommand& command);

      DtResponse setFollowingInterval(const DtCommand& command);

      DtResponse setFollowingExportInterval(const DtCommand& command);

      DtResponse requestFileList(const DtCommand& command);

      DtResponse recoverLastPacket(const DtCommand& command);

      DtResponse updateDescription( const DtCommand& command );

      virtual bool writeDescriptionToFile(const DtString& filename,
         const DtString& description, const bool writeDesc);

      virtual bool openFileInput(const DtString& filename, DtString& failureReason);

      virtual void closeFileInput(bool clearHistory);

      virtual void setFileHistoryCount(int count);

      virtual void addFileToHistory(const DtString& filename);

      virtual void clearFileHistory();
   protected:

      static const unsigned short theDomain   = DtLgrCommandType::Domain_Player;
      static const unsigned short theProtocol = DtLgrCommandType::Protocol_None;

      std::deque<DtString> myFileStack;
      //DtString myUnsavedFileName;
      DtString mySavedFileName;
      //bool myFileSavedFlag;

      DtLgrFileInput* myFileInput;
      DtLgrSystemDriver* myDriver;
      DtMessagePipeline* myPipeline;

      //Playback Parameters
      bool myPausedFlag;
      bool myLoopAtEnd;
      bool myPlayOnLoadFlag;
      int mySendPlayCommandAfterTick;
      double myTimeScale;
      DtLgrTimeSteppedClock* myPlaybackClock;
      DtAbsoluteTime myStartTime;
      DtAbsoluteTime myStopTime;
      DtAbsoluteTime myCurrentTime;
      bool myPlayingFlag;
      bool myBackupFlag;
      bool mySkippingPlayback;
      double mySkippingPlaybackThreshold;
      bool mySkippingPlaybackInteractions;
      DtAbsoluteTime myNextSkipTime;
      bool myTimeHasExtended;
      DtTime myExtendedStopTimeout;
      double myPacketViewInterval;
      double myFollowingInterval;
      double myFollowingExportInterval;

      // Description
      DtString myDescription;
      bool myUpdateDescription;


      unsigned int myFileHistoryCount;
      static const int theDefaultFileHistoryCount = 1;
   };

}

#endif