MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
lgrEditorCommandFactory.h
Go to the documentation of this file.
1 /******************************************************************************
2 ** Copyright (c) 1992-2024 MAK Technologies, Inc
3 ** All rights reserved.
4 ******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "lgrCmds.h"
12 #include <lgrCmds/lgrCommand.h>
14 
15 #include <memory>
16 
17 class DtString;
18 
19 namespace MAKLogger
20 {
21 
22  class DtAbsoluteTime;
23  class DtCommandDefinition;
24  class DtRelativeTime;
25 
29  {
30  private:
32 
33  public:
34 
37 
39  static const DtLgrCommandId theBaseCommandId = DtLgrTimeCommandFactory::theLastCommandId;
40 
42 
43 
44  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 1,ExportFile,
45  (const DtString& fileFormat, const DtString& filename, bool checkpoint,bool openAfterExport),
46  (const DtCommand& command,DtString& fileFormat, DtString& filename, bool& checkpoint,
47  bool& openAfterExport))
48 
49  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 2,ExportSection,
50  (const DtString& fileFormat, const DtString& filename, const DtAbsoluteTime& start,
51  const DtAbsoluteTime& end, const DtRelativeTime& offset, bool checkpoint,
52  bool openAfterExport),
53  (const DtCommand& command, DtString& fileFormat, DtString& filename, DtAbsoluteTime& start,
54  DtAbsoluteTime& end,DtRelativeTime& offset, bool& checkpoint, bool& openAfterExport))
55 
56  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 3,ClearSection,
57  (const DtAbsoluteTime& start, const DtAbsoluteTime& end),
58  (const DtCommand& command,DtAbsoluteTime& start, DtAbsoluteTime& end))
59 
60  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 4,CutSection,
61  (const DtAbsoluteTime& start, const DtAbsoluteTime& end),
62  (const DtCommand& command,DtAbsoluteTime& start, DtAbsoluteTime& end))
63 
64  // Pointer is a DtLgrPacketPrinter
65  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 5,AddExportType,
66  (const DtString& fileFormat, const DtString& fileFilter, bool offsetData, bool generateData,
67  int exportType, void* printer),
68  (const DtCommand& command,DtString& fileFormat,DtString& fileFilter, bool& offsetData,
69  bool& generateData, int& exportType, void*& printer))
70 
71  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 6,MergeInFile,
72  (const DtString& filename, const DtRelativeTime& offset),
73  (const DtCommand& command,DtString& filename,DtRelativeTime& offset))
74 
75  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 7,AppendFileToEnd,
76  (const DtString& filename),
77  (const DtCommand& command, DtString& filename))
78 
79  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 8,PrefixFileToStart,
80  (const DtString& filename),
81  (const DtCommand& command, DtString& filename))
82 
83  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 9,TrimStart,
84  (),
85  (const DtCommand& command))
86 
87  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 10,OffsetTime,
88  (const DtRelativeTime& offset),
89  (const DtCommand& command,DtRelativeTime& offset))
90 
91  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 11,ConvertFile,
92  (),
93  (const DtCommand& command))
94 
95  DT_FACTORY_COMMAND_EXT(theBaseCommandId + 12,SetRecheckpointOnExport,
96  (bool recheckpointOnExport),
97  (const DtCommand& command, bool& recheckpointOnExport))
98 
101  static const DtLgrCommandId Last_Command = theBaseCommandId + 100;
102 
104 
107  static const DtLgrCommandId theLastCommandId = theBaseCommandId + 100;
108 
110  static const DtLgrCommandId theBaseResponseId = DtLgrTimeCommandFactory::theLastResponseId;
111 
113 
114 
115  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 1,ExportTypeAdded,
116  (const DtString& fileFormat, const DtString& fileFilter, bool offsetData, bool generateData,
117  int exportType),
118  (DtResponse response, DtString& fileFormat,DtString& fileFilter, bool& offsetData,
119  bool& generateData, int& exportType))
120 
121  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 2,FileDataMoved,
122  (const DtAbsoluteTime& start, const DtAbsoluteTime& end, const DtRelativeTime& offset),
123  (DtResponse, DtAbsoluteTime& start, DtAbsoluteTime& end, DtRelativeTime& offset))
124 
125  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 3,FileDataDeleted,
126  (const DtAbsoluteTime& start, const DtAbsoluteTime& end),
127  (DtResponse, DtAbsoluteTime& start, DtAbsoluteTime& end))
128 
129  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 4,FileDataAdded,
130  (const DtAbsoluteTime& start, const DtAbsoluteTime& end, const DtString& source),
131  (DtResponse, DtAbsoluteTime& start, DtAbsoluteTime& end, DtString& source))
132 
133  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 5,ExportCompleted,
134  (const DtString& fileFormat, const DtString& filename,bool completed),
135  (DtResponse, DtString& fileFormat, DtString& filename,bool& completed))
136 
137  DT_FACTORY_RESPONSE_EXT(theBaseResponseId - 6,RecheckpointOnExportChanged,
138  (bool recheckpointOnExport),
139  (DtResponse, bool& recheckpointOnExport))
140 
142 
145  static const DtLgrCommandId theLastResponseId = theBaseResponseId - 100;
146 
148  static const char* commandToString(int commandId);
149 
151  static const char* responseToString(int responseId);
152 
153 
154  };
155 }
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
#define DT_DLL_LGR_CMDS
Definition: lgrCmds.h:18
Relative Time, an elapsed duration of time, no implied measurement, could be seconds/cycles or ticks ...
Definition: absoluteTime.h:28
DtBoost::shared_ptr< const DtCommand > DtResponse
Definition: lgrCommand.h:174
static const DtLgrCommandType theCommandType
The command type for all playback commands from this factory.
Definition: lgrEditorCommandFactory.h:36
Contains MAKLogger::DtLgrCommandType and MAKLogger::DtCommand classes.
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.
class DT_DLL_LGRUTIL DtAbsoluteTime
Definition: absoluteTime.h:22
The factory which creates logger editor commands.
Definition: lgrEditorCommandFactory.h:28
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 Fri May 31 15:45:35 EDT 2024 from SVN revision 266500
Copyright © 2024 MAK Technologies. All Rights Reserved (www.mak.com)