MAK Data Logger API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
lgrRecordCommandFactory.h
Go to the documentation of this file.
1 /******************************************************************************
2 ** Copyright (c) 1992-2016 VT MAK
3 ** All rights reserved.
4 ******************************************************************************/
5 
8 
9 
10 #pragma once
11 
12 #include "lgrCmds.h"
14 
15 class DtString;
16 
17 namespace MAKLogger
18 {
19  class DtMessageBuffer;
20  class DtCommandDefinition;
21 
25  {
26  private:
28 
29  public:
30 
33 
35  static const DtLgrCommandId theBaseCommandId = DtLgrTimeCommandFactory::theLastCommandId;
36 
38 
39 
41  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 1,NewFile,
42  (const DtString& filename, const DtString& description, bool overwrite,
43  bool constructFilePathAndName, bool constructMediaPipeline),
44  (const DtCommand& command,DtString& filename, DtString& description, bool& overwrite,
45  bool& constructFilePathAndName, bool& constructMediaPipeline))
46 
47 
48  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 2,CloseFile,
49  (),
50  (const DtCommand&))
51 
53  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 4,CancelRecording,
54  (),
55  (const DtCommand&))
56 
58  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 5,Record,
59  (bool multipleFiles),
60  (const DtCommand&,bool& multipleFiles))
61 
63  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 6,Pause,
64  (),
65  (const DtCommand&))
66 
68  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 7,Unpause,
69  (),
70  (const DtCommand&))
71 
73  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 8,Stop,
74  (bool closeAndOpenForPlayback),
75  (const DtCommand&,bool& closeAndOpenForPlayback))
76 
78  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 9,StopCondition,
79  (int cond,bool close),
80  (const DtCommand&,int& cond, bool& close))
81 
83  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 10,StopDuration,
84  (DtAbsoluteTime duration),
85  (const DtCommand&,DtAbsoluteTime&))
86 
88  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 11,StopSize,
89  (DtU64 size),
90  (const DtCommand&,DtU64& size))
91 
93  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 12,SetCheckpointParameters,
94  (int policy, int size, int count,DtAbsoluteTime time, bool checkpointInteractions),
95  (const DtCommand&, int& policy, int& size,int& count, DtAbsoluteTime& time,
96  bool& checkpointInteractions))
97 
99  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 13,SetPauseOnRecordAs,
100  (bool record),
101  (const DtCommand&, bool& record))
102 
104  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 14,SaveRecordedData,
105  (const DtString& filename, const DtString& description,
106  bool sinceLastSaveData, double outputDuration, DtMessageBuffer*),
107  (const DtCommand&, DtString& filename, DtString& description,
108  bool& sinceLastSaveData, double& outputDuration, DtMessageBuffer*&))
109 
112  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 15,SaveRecordedDataFinished,
113  (bool success,const DtString& message),
114  (const DtCommand&, bool& success,DtString& message))
115 
117  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 16,SetRecordToMultipleFilesSettings,
118  (double duration,const DtString& namingConvention),
119  (const DtCommand&, double& duration,DtString& namingConvention))
120 
122  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 17,RecordToMultipleFiles,
123  (const DtString& fileName, const DtString& description),
124  (const DtCommand&, DtString& fileName, DtString& description))
125 
126 
128  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 18, SetMediaRecordFromStreamConfiguration,
129  (const DtString& pipelineConfiguration),
130  (const DtCommand& command, DtString& pipelineConfiguration))
131 
133  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 19, SetMediaRecordFromStreamPipeline,
134  (const DtString& pipelineConfigurations),
135  (const DtCommand&, DtString& pipelineConfigurations))
136 
138  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 20, SetIsMediaRecordingStream,
139  (bool enabled),
140  (const DtCommand&, bool& enabled))
141 
143 
144  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 21, SetMediaRecordStreamParameters,
145  (int port),
146  (const DtCommand&, int& port))
147 
149  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 22, SetMediaRecordByDefault,
150  (bool enabled),
151  (const DtCommand&, bool& enabled))
152 
153 
155 
158  static const DtLgrCommandId theLastCommandId = theBaseCommandId + 100;
159 
161  static const DtLgrCommandId theBaseResponseId = DtLgrTimeCommandFactory::theLastResponseId;
162 
164 
165 
167  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 1,NewFileOpened,
168  (const DtString& filename),
169  (DtResponse response, DtString& filename ))
170 
172  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 2,NewFileFailed,
173  (const DtString& reason),
174  (DtResponse response, DtString& reason ))
175 
177  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 3,FileClosed,
178  (),
179  (DtResponse))
180 
182  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 10,RecordingChanged,
183  (bool recordingState),
184  (DtResponse response,bool& recordingState ))
185 
187  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 11,RecordingPausedChanged,
188  (bool recordingState),
189  (DtResponse response, bool& recordingState ))
190 
191  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 12,PauseOnRecordAsChanged,
192  (bool record),
193  (DtResponse response, bool& record))
194 
195  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 13,CheckpointPolicyChanged,
196  (int policy,int size,int count, DtAbsoluteTime time, bool checkpointInteractions),
197  (DtResponse,int& policy,int& size,int& count,DtAbsoluteTime& time,
198  bool& checkpointInteractions))
199 
200  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 14,FileEmptyChanged,
201  (),
202  (DtResponse))
203 
204  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 15,RecordToMultipleFilesSettingsChanged,
205  (double duration,const DtString& namingConvention),
206  (DtResponse, double& duration,DtString& namingConvention))
207 
209  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 16, MediaRecordFromStreamConfigurationChanged,
210  (const DtString& pipelineConfiguration),
211  (DtResponse response, DtString& pipelineConfiguration))
212 
213  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 17, MediaRecordStreamParametersChanged,
214  (int port),
215  (DtResponse response, int& port))
216 
217  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 18, MediaRecordByDefaultChanged,
218  (bool recordDefault),
219  (DtResponse response, bool& recordDefault))
220 
221  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 19, RecordingMediaStreamChanged,
222  (bool isRecordingStream),
223  (DtResponse response, bool& isRecordingStream))
224 
226 
229  static const DtLgrCommandId theLastResponseId = theBaseResponseId - 100;
230 
231  public:
232 
234  static const char* commandToString(int commandId);
235 
237  static const char* responseToString(int responseId);
238 
239  };
240 
241 }
The logger command which contains the command type and its parameters.
Definition: lgrCommand.h:109
The command type structure.
Definition: lgrCommand.h:29
#define DT_FACTORY_COMMAND_EXT(commandId, commandName, createParams, decodeParams)
Utility Macros for declaring Command in Factory.
Definition: lgrCommand.h:183
static const DtLgrCommandType theCommandType
The command type for all playback commands from this factory.
Definition: lgrRecordCommandFactory.h:32
#define DT_DLL_LGR_CMDS
Definition: lgrCmds.h:18
DtBoost::shared_ptr< const DtCommand > DtResponse
Definition: lgrCommand.h:174
Message buffer class responsible for storing a list of messages and iterating through that list...
Definition: messageBuffer.h:23
The factory responsible for creating recording commands.
Definition: lgrRecordCommandFactory.h:24
The factory class responsible for created time related commands.
Definition: lgrTimeCommandFactory.h:21
#define DT_FACTORY_RESPONSE_EXT(responseId, responseName, createParams, decodeParams)
Utility Macros for declaring Response in Factory.
Definition: lgrCommand.h:198
Contains lgrCmds library definitions.
Contains MAKLogger::DtLgrTimeCommandFactory class.
short DtLgrCommandId
Definition: lgrCommand.h:25
Absolute Time, a particular measured instance in time, could be thought of as a set of relative times...
Definition: absoluteTime.h:82

Document ID: Generated on Mon Mar 22 15:30:17 EDT 2021 from SVN revision 226440
Copyright © 2021 MAK Technologies. All Rights Reserved (www.mak.com)