BPNGClientLib
Library for accessing the Telemotive data logger devices
RdbDefines.h
Go to the documentation of this file.
1 //************************************************************
2 //
3 // RdbDefines.h
4 //
9 //*****************************************************************
10 
11 #ifndef RDBDEFINES_H
12 #define RDBDEFINES_H
13 
14 #ifdef _MSC_VER
15 
16 #define WINAPI __stdcall
17 // always compile the clientlib stuff on Windows
18 #undef ATOM_CLIENTLIB
19 #define ATOM_CLIENTLIB 1
20 
21 #else
22 
23 #define WINAPI
24 #include <atom-config.h> // for ATOM_CLIENTLIB define
25 #ifndef ATOM_CLIENTLIB
26 #define ATOM_CLIENTLIB 0
27 #endif
28 
29 #endif
30 
31 
32 // sys
33 #include <cstdlib>
34 #include <stdint.h>
35 
36 #if ATOM_CLIENTLIB
37 
40 {
41  UNKNOWN = 0,
42  STARTUP = 0x01,
43  SHUTDOWN = 0x02,
44  MARKER = 0x03,
45  INFO = 0x05,
46  SLAVE_OFFSET = 0x06,
47  SLAVE_TO_MASTER = 0x07,
48  DATA_DELETED = 0x08,
49  TIME_SET = 0x09,
50  NEW_TIME = 0x0A,
51  SUDDEN_DEATH = 0x0B,
55  TSL_SESSION_END = 0x0F,
56  CONFIG = 0x10,
57  WAKEUP = 0x11,
58  START_TESTDRIVE = 0x12,
59  STOP_TESTDRIVE = 0x13,
60  TESTDRIVE_INFO = 0x14,
61 };
62 
63 
65 struct IRdbEvent
66 {
68  virtual ~IRdbEvent() {}
69 
71  virtual RdbEventType WINAPI getType() const = 0;
72 
75  virtual uint64_t WINAPI getUniqueId() const = 0;
76 
78  virtual uint64_t WINAPI getTimeStamp() const = 0;
79 
82  virtual const char* WINAPI getTimeZone() const = 0;
83 
85  virtual int WINAPI getIndex() const = 0;
86 
90  virtual const char* WINAPI getComment() const = 0;
91 };
92 
93 
94 
97 {
99  virtual ~IRdbEventList() {}
100 
102  virtual size_t WINAPI getSize() const = 0;
103 
105  virtual const IRdbEvent* WINAPI getEvent(size_t index) const = 0;
106 };
107 
108 
110 {
112  virtual ~IRdbTraceBlock() {}
113 
114  virtual uint64_t WINAPI getUniqueId() const = 0;
115  virtual uint64_t WINAPI getStartTimeStamp() const = 0;
116  virtual uint64_t WINAPI getEndTimeStamp() const = 0;
117  virtual const char* WINAPI getTimeZone() const = 0;
118  virtual const char* WINAPI getLoggerModuleName() const = 0;
119  virtual const char* WINAPI getFilePath() const = 0;
120  virtual const char* WINAPI getFileName() const = 0;
121  virtual uint64_t WINAPI getDataFileSize() const = 0;
122  virtual uint64_t WINAPI getDataSize() const = 0;
123  virtual uint64_t WINAPI getBlockNumber() const = 0;
124  virtual const char* WINAPI getCfgBackupFile() const = 0;
125  virtual const char* WINAPI getDataColumnValue(const char *columnName) const = 0;
126  virtual const char* WINAPI getComment() const = 0;
127 };
128 
129 
131 {
133  virtual ~IRdbTraceBlockList() {}
134 
136  virtual size_t WINAPI getSize() const = 0;
137 
139  virtual const IRdbTraceBlock* WINAPI getTraceBlock(size_t index) const = 0;
140 };
141 
142 #else // ATOM_CLIENTLIB
143 
144 struct IRdbEvent {};
145 struct IRdbEventList {};
146 struct IRdbTraceBlock {};
147 struct IRdbTraceBlockList {};
148 
149 #endif // ATOM_CLIENTLIB
150 
151 #endif // RDBDEFINES_H
Interface to an RDB event.
Definition: RdbDefines.h:65
Marker set.
Definition: RdbDefines.h:44
RdbEventType
Definition: RdbDefines.h:39
configuration has been updated
Definition: RdbDefines.h:56
misc. info event for test drive data like testname, vin, map-version, reproducibility, etc.
Definition: RdbDefines.h:60
bp2 startup
Definition: RdbDefines.h:42
start an easy track test drive
Definition: RdbDefines.h:58
virtual uint64_t WINAPI getUniqueId() const =0
cascading slave to master
Definition: RdbDefines.h:47
Definition: RdbDefines.h:109
cascading slave offset
Definition: RdbDefines.h:46
bp2 shutdown
Definition: RdbDefines.h:43
no "real" shutdown was found after startup.
Definition: RdbDefines.h:51
virtual ~IRdbEventList()
DTOR.
Definition: RdbDefines.h:99
stop an easy track test drive
Definition: RdbDefines.h:59
Definition: RdbDefines.h:130
virtual uint64_t WINAPI getTimeStamp() const =0
Returns the event&#39;s time stamp in usec since 01.01.1970 UTC.
virtual int WINAPI getIndex() const =0
Returns the index of this event. Only used for marker events.
virtual const char *WINAPI getTimeZone() const =0
virtual ~IRdbTraceBlock()
DTOR.
Definition: RdbDefines.h:112
Info is set.
Definition: RdbDefines.h:45
All data and data space is deleted.
Definition: RdbDefines.h:48
virtual RdbEventType WINAPI getType() const =0
Get type of event.
new time
Definition: RdbDefines.h:50
slave is not synced with master.
Definition: RdbDefines.h:53
slave is synced with master.
Definition: RdbDefines.h:52
bp2 time was set
Definition: RdbDefines.h:49
start of a tsl synchronized session
Definition: RdbDefines.h:54
virtual ~IRdbEvent()
DTOR.
Definition: RdbDefines.h:68
end of a tsl synchronized session
Definition: RdbDefines.h:55
virtual const char *WINAPI getComment() const =0
virtual ~IRdbTraceBlockList()
DTOR.
Definition: RdbDefines.h:133
Interface to a list of rdb events.
Definition: RdbDefines.h:96
bpng wake-up source
Definition: RdbDefines.h:57