MAK Data Logger API Documentation for HLA: lgrPlaybackCommandFactory.h Source File

Go to the documentation of this file.
 /******************************************************************************
 ** Copyright (c) 1992-2016 VT MAK
 ** All rights reserved.
 ******************************************************************************/
 
 
 #pragma once
 
 #include "lgrCmds.h"
 #include <lgrCmds/lgrTimeCommandFactory.h>
 
 class DtString;
 
 namespace MAKLogger
 {
 
    class DtCommandDefinition;
 
    class DT_DLL_LGR_CMDS DtLgrPlaybackCommandFactory
    {
    private:
       DtLgrPlaybackCommandFactory();
 
    public:
       static const DtLgrCommandType theCommandType;
 
    public:  
 
       static const DtLgrCommandId theBaseCommandId = DtLgrTimeCommandFactory::theLastCommandId;
 
 
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 1,OpenFile,
          (const DtString& filename, bool constructFilePathAndName, bool checkMediaFile),
          (const DtCommand& command,DtString& filename, bool& constructFilePathAndName, bool& checkMediaFile))
 
       
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 2,CloseFile,
          (),
          (DtCommand& command))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 3,SaveFile,
          (const bool reopenAfterSave),
          (const DtCommand& command, bool& reopenAfterSave))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 4,SaveFileAs,
          (const DtString& filename,const DtString& description,const bool writeDescription,
             const bool reopenAfterSave),
          (const DtCommand& command,DtString& filename,DtString& description,bool& writeDescription,
             bool& reopenAfterSave))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 5,Revert,
          (),
          (const DtCommand& command))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 6,SetBackupOnSave,
          (bool backup),
          (const DtCommand& command,bool& backup))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 10,Play,
          (),
          (DtCommand& command))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 11,Stop,
          (),
          (DtCommand& command))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 12,Restart,
          (),
          (DtCommand& command))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 13,PlayPause,
          (),
          (DtCommand& command))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 14,SetLoopAtEnd,
          (bool enable),
          (const DtCommand& command,bool& enable))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 16,SetPlayOnLoad,
          (bool play),
          (const DtCommand& command,bool& play))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 20,SetPlaybackSpeed,
          (double speed, bool skipping),
          (const DtCommand& command,double& speed, bool& skipping))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 21,SetCurrentTime,
          (DtAbsoluteTime time),
          (const DtCommand& command,DtAbsoluteTime& time))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 22,Pause,
          (),
          (DtCommand& command))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 23,Unpause,
          (),
          (DtCommand& command))      
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 24,SetStartStopTimes,
          (DtAbsoluteTime startTime, DtAbsoluteTime stopTime),
          (const DtCommand& command, DtAbsoluteTime& startTime,DtAbsoluteTime& stopTime))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 25,SkipTime,
          (DtRelativeTime time, bool skipForward),
          (const DtCommand& command,DtRelativeTime& time, bool& skipForward))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 26,SetSkippingPlaybackThreshold,
          (double skippingPlaybackThreshold),
          (const DtCommand& command, double& skippingPlaybackThreshold))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 27,RequestFileList,
          (bool listDirs),
          (const DtCommand& command, bool& listDirs))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 28,RecoverLastPacket,
          (),
          (DtCommand& command))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 29,UpdateTapeDescription,
          (const DtString& description),
          (const DtCommand& command, DtString& description))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 30,SetPacketViewInterval,
          (double packetViewInterval),
          (const DtCommand& command, double& packetViewInterval))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 31,SetSkippingPlaybackInteractions,
          (bool skipPlaybackInteractions),
          (const DtCommand& command, bool& skipPlaybackInteractions))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 32,SetFollowingInterval,
          (double followingInterval),
          (const DtCommand& command, double& followingInterval))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 33,SetFollowingExportInterval,
          (double exportInterval),
          (const DtCommand& command, double& exportInterval))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 34,SetMediaPlaybackAdjustments,
          (double speedFactor, DtRelativeTime offset),
          (const DtCommand& command, double& speedFactor, DtRelativeTime& offset))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 35,SetMediaWindowHandle,
          (void* windowHandle),
          (const DtCommand& command, void*& windowHandle))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 36, SetMediaPlayToStreamConfiguration,
       (const DtString& pipelineConfiguration),
       (const DtCommand& command, DtString& pipelineConfiguration))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 37,SetMediaPlayInWindowConfiguration,
       (const DtString& pipelineConfiguration),
       (const DtCommand& command, DtString& pipelineConfiguration))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId - 38, SetMediaPlayByDefault,
       (bool windowDefault, bool streamDefault),
       (const DtCommand& command, bool& windowDefault, bool& streamDefault))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId - 39, SetMediaPlayToStreamParameters,
       (const DtString& host, int port),
       (const DtCommand& command, DtString& host, int& port))
       
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 40, SetMediaPlayToStreamPipeline,
          (const DtString& pipelines, const DtString& mediaFile),
          (const DtCommand&, DtString& pipelines, DtString& mediaFile))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 41, SetMediaPlayInWindowPipeline,
       (const DtString& pipeline, const DtString& mediaFile),
          (const DtCommand&, DtString& pipeline, DtString& mediaFile))
 
       DT_FACTORY_COMMAND_EXT(theBaseCommandId + 42, ExposePlaybackMedia,
          (),
          (DtCommand& command))
 
 
       static const DtLgrCommandId theLastCommandId = theBaseCommandId + 100;
 
       static const DtLgrCommandId theBaseResponseId = DtLgrTimeCommandFactory::theLastResponseId;
 
 
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 1,FileOpened,
          (const DtString& filename, DtAbsoluteTime firstTime, DtAbsoluteTime lastTime),
          (DtResponse response, DtString& filename, DtAbsoluteTime& firstTime,
             DtAbsoluteTime& lastTime))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 2,FileClosed,
          (),
          (DtResponse response))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 3,FileDoesNotExist,
          (const DtString& filename),
          (DtResponse response, DtString& filename))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 4,FileIncomplete,
          (const DtString& filename, bool isIncomplete, bool hasLastPacket, bool lastPacketRecovered),
          (DtResponse response, DtString& filename, bool& isIncomplete, bool& hasLastPacket,
             bool& lastPacketRecovered))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 5,FileInvalid,
          (const DtString& filename, const DtString& reason),
          (DtResponse response, DtString& filename, DtString& reason))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 6,FileChanged,
          (),
          (DtResponse))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 7,FileSaved,
          (),
          (DtResponse))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 8, FileFormatCurrent,
          (bool current, int version),
          (DtResponse response,bool& current, int& version))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 10,PlaybackChanged,
          (bool currentlyPlaying),
          (DtResponse response, bool& currentlyPlaying))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 11,Restarted,
          (),
          (DtResponse))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 12,LoopAtEndChanged,
          (bool enabled), 
          (DtResponse response, bool& enabled))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 13,PlayOnLoadChanged,
          (bool play), 
          (DtResponse response,bool& play))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 20,PlaybackSpeedChanged,
          (double speed),
          (DtResponse response,double& speed))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 21,PausedChanged,
          (bool paused),
          (DtResponse response,bool& paused))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 22,SkippingPlaybackChanged,
          (bool skippingPlayback),
          (DtResponse response,bool& skippingPlayback))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 23,SkippingPlaybackThresholdChanged,
          (double skippingPlaybackThreshold),
          (DtResponse response, double& skippingPlaybackThreshold))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 24,JumpTimeChanged,
          (DtAbsoluteTime jumpTime),
          (DtResponse response, DtAbsoluteTime& jumpTime))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 25,FileList,
          (bool listIsDirs, const std::vector<DtString>& loggerFiles),
          (DtResponse response, bool& listIsDirs, std::vector<DtString>& loggerFiles))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 26,TapeDescriptionUpdated,
          (const DtString& tapeDescription, const bool useDescription),
          (DtResponse response, DtString& tapeDescription, bool& useDescription))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 27,PacketViewIntervalChanged,
          (double packetViewInterval),
          (DtResponse response, double& packetViewInterval))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 28,SkippingPlaybackInteractionsChanged,
          (bool skippingPlaybackInteractions),
          (DtResponse response, bool& skippingPlaybackInteractions))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 29,FileExpandingChanged,
          (bool isExpanding),
          (DtResponse response, bool& isExpanding))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 30,FollowingIntervalChanged,
          (double followingInterval),
          (const DtResponse response, double& followingInterval))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 31,FollowingExportIntervalChanged,
          (double exportInterval),
          (const DtResponse response, double& exportInterval))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 32,MediaPlaybackAdjustmentsChanged,
          (double speedFactor, DtRelativeTime offset),
          (const DtResponse response, double& speedFactor, DtRelativeTime& offset))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 33,MediaPlayToStreamConfigurationChanged,
          (const DtString& pipelineConfiguration),
          (DtResponse response, DtString& pipelineConfiguration))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 34, MediaPlayInWindowConfigurationChanged,
          (const DtString& pipelineConfiguration),
          (DtResponse response, DtString& pipelineConfiguration))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 35, MediaPlayByDefaultChanged,
          (bool windowDefault, bool streamDefault),
          (DtResponse response, bool& windowDefault, bool& streamDefault))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 36, MediaPlayToStreamParametersChanged,
          (const DtString& host, int port),
          (DtResponse response, DtString& host, int& port))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 37, MediaPlayInWindowOperationActive,
          (bool isActive),
          (DtResponse response, bool &isActive))
 
       DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 38, MediaPlayToStreamOperationStatus,
          (int status),
          (DtResponse response, int &status))
 
 
       static const DtLgrCommandId theLastResponseId = theBaseResponseId - 100;
 
    public:
       
       static const char* commandToString(int commandId);
 
       static const char* responseToString(int responseId);
 
    };
 
 }
 