MAK Data Logger API Documentation for HLA
lgrPlaybackCommandFactory.h
Go to the documentation of this file.
1 /******************************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 ******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "lgrCmds.h"
12 #include "lgrCommand.h"
13 
14 class DtString;
15 
16 namespace MAKLogger
17 {
18 
19  class DtCommandDefinition;
20 
24  {
25  private:
27 
28  public:
31 
32  protected:
34  static const DtLgrCommandId Command_FullState = 3;
35 
36  public:
37 
41 
43  DT_FACTORY_COMMAND_EXT(1,OpenFile,(const DtString& filename, bool constructFilePathAndName),
44  (const DtCommand& command,DtString& filename, bool& constructFilePathAndName))
45 
46 
47 
48  DT_FACTORY_COMMAND_EXT(2,CloseFile,(),(DtCommand& command))
49 
52  DT_FACTORY_COMMAND_EXT(3,SaveFile,(const bool reopenAfterSave),
53  (const DtCommand& command, bool& reopenAfterSave))
54 
56  DT_FACTORY_COMMAND_EXT(4,SaveFileAs,(const DtString& filename,
57  const DtString& description, const bool writeDescription,
58  const bool reopenAfterSave),
59  (const DtCommand& command,DtString& filename,DtString& description,
60  bool& writeDescription, bool& reopenAfterSave))
61 
64  DT_FACTORY_COMMAND_EXT(5,Revert,(),(const DtCommand& command))
65 
67  DT_FACTORY_COMMAND_EXT(6,SetBackupOnSave,(bool backup),
68  (const DtCommand& command,bool& backup))
69 
72  DT_FACTORY_COMMAND_EXT(10,Play,(),(DtCommand& command))
73 
76  DT_FACTORY_COMMAND_EXT(11,Stop,(),(DtCommand& command))
77 
80  DT_FACTORY_COMMAND_EXT(12,Restart,(),(DtCommand& command))
81 
84  DT_FACTORY_COMMAND_EXT(13,PlayPause,(),(DtCommand& command))
85 
87  DT_FACTORY_COMMAND_EXT(14,SetLoopAtEnd,(bool enable),
88  (const DtCommand& command,bool& enable))
89 
91  DT_FACTORY_COMMAND_EXT(16,SetPlayOnLoad,(bool play),
92  (const DtCommand& command,bool& play))
93 
95  DT_FACTORY_COMMAND_EXT(20,SetPlaybackSpeed,(double speed, bool skipping),
96  (const DtCommand& command,double& speed, bool& skipping))
97 
99  DT_FACTORY_COMMAND_EXT(21,SetCurrentTime,(DtAbsoluteTime time),
100  (const DtCommand& command,DtAbsoluteTime& time))
101 
104  DT_FACTORY_COMMAND_EXT(22,Pause,(),(DtCommand& command))
105 
108  DT_FACTORY_COMMAND_EXT(23,Unpause,(),(DtCommand& command))
109 
111  DT_FACTORY_COMMAND_EXT(24,SetStartStopTimes,(DtAbsoluteTime startTime,
112  DtAbsoluteTime stopTime),(const DtCommand& command,
113  DtAbsoluteTime& startTime,DtAbsoluteTime& stopTime))
114 
116  DT_FACTORY_COMMAND_EXT(25,SkipTime,(DtRelativeTime time, bool skipForward),
117  (const DtCommand& command,DtRelativeTime& time, bool& skipForward))
118 
120  DT_FACTORY_COMMAND_EXT(26,SetSkippingPlaybackThreshold,(double skippingPlaybackThreshold),
121  (const DtCommand& command, double& skippingPlaybackThreshold))
122 
125  DT_FACTORY_COMMAND_EXT(27,RequestFileList,(bool listDirs),
126  (const DtCommand& command, bool& listDirs))
127 
130  DT_FACTORY_COMMAND_EXT(28,RecoverLastPacket,(),(DtCommand& command))
131 
133  DT_FACTORY_COMMAND_EXT(29,UpdateTapeDescription,(const DtString& description),
134  (const DtCommand& command, DtString& description))
135 
136 
140 
142  DT_FACTORY_RESPONSE_EXT(-1,FileOpened,
143  (const DtString& filename, DtAbsoluteTime firstTime,
144  DtAbsoluteTime lastTime),
145  (DtResponse response, DtString& filename,DtAbsoluteTime& firstTime,
146  DtAbsoluteTime& lastTime))
147 
149  DT_FACTORY_RESPONSE_EXT(-2,FileClosed,
150  (),
151  (DtResponse response))
152 
153  DT_FACTORY_RESPONSE_EXT(-3,FileDoesNotExist,
154  (const DtString& filename),
155  (DtResponse response, DtString& filename))
156 
157  DT_FACTORY_RESPONSE_EXT(-4,FileIncomplete,
158  (const DtString& filename, bool isIncomplete, bool hasLastPacket, bool lastPacketRecovered),
159  (DtResponse response, DtString& filename, bool& isIncomplete, bool& hasLastPacket, bool& lastPacketRecovered))
160 
161  DT_FACTORY_RESPONSE_EXT(-5,FileInvalid,
162  (const DtString& filename, const DtString& reason),
163  (DtResponse response, DtString& filename, DtString& reason))
164 
165  DT_FACTORY_RESPONSE_EXT(-6,FileChanged,
166  (),
167  (DtResponse))
168 
169  DT_FACTORY_RESPONSE_EXT(-7,FileSaved,
170  (),
171  (DtResponse))
172 
173  DT_FACTORY_RESPONSE_EXT(-8, FileFormatCurrent,
174  (bool current, int version),
175  (DtResponse response,bool& current, int& version))
176 
177  DT_FACTORY_RESPONSE_EXT(-10,PlaybackChanged,
178  (bool currentlyPlaying),
179  (DtResponse response, bool& currentlyPlaying))
180 
181  DT_FACTORY_RESPONSE_EXT(-11,Restarted,(),(DtResponse))
182 
183  DT_FACTORY_RESPONSE_EXT(-12,LoopAtEndChanged,
184  (bool enabled),
185  (DtResponse response, bool& enabled))
186 
187  DT_FACTORY_RESPONSE_EXT(-13,PlayOnLoadChanged,
188  (bool play),
189  (DtResponse response,bool& play))
190 
191  DT_FACTORY_RESPONSE_EXT(-20,PlaybackSpeedChanged,
192  (double speed),
193  (DtResponse response,double& speed))
194 
195  DT_FACTORY_RESPONSE_EXT(-21,PausedChanged,
196  (bool paused),
197  (DtResponse response,bool& paused))
198 
199  DT_FACTORY_RESPONSE_EXT(-22,SkippingPlaybackChanged,
200  (bool skippingPlayback),
201  (DtResponse response,bool& skippingPlayback))
202 
203  DT_FACTORY_RESPONSE_EXT(-23,SkippingPlaybackThresholdChanged,
204  (double skippingPlaybackThreshold),
205  (DtResponse response, double& skippingPlaybackThreshold))
206 
207  DT_FACTORY_RESPONSE_EXT(-24,JumpTimeChanged,
208  (DtAbsoluteTime jumpTime),
209  (DtResponse response, DtAbsoluteTime& jumpTime))
210 
211  DT_FACTORY_RESPONSE_EXT(-25,FileList,
212  (bool listIsDirs, const std::vector<DtString>& loggerFiles),
213  (DtResponse response, bool& listIsDirs, std::vector<DtString>& loggerFiles))
214 
215  DT_FACTORY_RESPONSE_EXT(-26,TapeDescriptionUpdated,
216  (const DtString& tapeDescription, const bool useDescription),
217  (DtResponse response, DtString& tapeDescription, bool& useDescription))
218 
219  public:
220 
222  static const char* commandToString(int commandId);
223 
225  static const char* responseToString(int responseId);
226 
227  };
228 
229 }
230 

Document ID: Generated on Mon Jan 19 08:20:14 EST 2015 from SVN revision 149581
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)