BPNGClientLib
Library for accessing the Telemotive data logger devices
IClientProperties.h
Go to the documentation of this file.
1 //******************************************************************************
2 //******************************************************************************
10 //******************************************************************************
11 //******************************************************************************
12 #ifndef ICLIENTPROPERTIES_H
13 #define ICLIENTPROPERTIES_H
14 
15 
16 #include "BPNGDefines.h"
17 
19 
23 {
42  virtual void WINAPI setCommonProperties(const char* nameOfTester, int maxOutputSizeMB, BOOL separatedTimeFormat, BOOL separatedTimeFormatInOfflineSet,
43  const char* alternativeLoggerName, BOOL useAlternativeLoggerName, BOOL useSubDirectories, BOOL midnightSplitting, BOOL fileTimeSpansLikeSelection,
44  BOOL markerNumberInFileNames, BOOL subfolderWithLoggerName, int maxOfflineZipSizeMB, int maxOutputSizeMBSortedDownload,
45  BOOL traceCutterStorage, const char* traceCutterFNPatternConversion, BOOL createOfflineDataOnTraceCutterStorage, const char* traceCutterFNPatternOfflineData,
46  BOOL traceCutterMarkerCompact, BOOL pauseDataRecordingDuringDownload, BOOL tmASCIITimestampPrecisionToMicros) = 0;
47 
48 
49  virtual void WINAPI setNameOfTester(const char* name) = 0;
50  virtual void WINAPI setMaxOutputSize(int size) = 0;
51  virtual void WINAPI setSeparatedTimeFormat(BOOL flag) = 0;
52  virtual void WINAPI setSeparatedTimeFormatInOfflineSet(BOOL flag) = 0;
53  virtual void WINAPI setAlternativeLoggerName(const char* name) = 0;
54  virtual void WINAPI setAlternativeLoggerNameActive(BOOL flag) = 0;
55  virtual void WINAPI setConvertedFilesInSubDirsActive(BOOL flag) = 0;
56  virtual void WINAPI setMidnightSplittingActive(BOOL flag) = 0;
57  virtual void WINAPI setFileTimeSpansLikeSelection(BOOL flag) = 0;
58  virtual void WINAPI setMarkerNumbersInFileNames(BOOL flag) = 0;
59  virtual void WINAPI setSubfolderWithLoggerName(BOOL flag) = 0;
60  virtual void WINAPI setMaxOfflineZipSize(int size) = 0;
61  virtual void WINAPI setMaxOutputSizeSortedDownload(int size) = 0;
62  virtual void WINAPI setTraceCutterStorage(BOOL flag) = 0;
63  virtual void WINAPI setTraceCutterFNPatternConversion(const char* pattern) = 0;
64  virtual void WINAPI setCreateOfflineDataOnTraceCutterStorage(BOOL flag) = 0;
65  virtual void WINAPI setTraceCutterFNPatternOfflineData(const char* pattern) = 0;
66  virtual void WINAPI setTraceCutterMarkerCompact(BOOL flag) = 0;
67  virtual void WINAPI setPauseDataRecordingDuringDownload(BOOL flag) = 0;
68  virtual void WINAPI setTMASCIITimestampPrecisionToMicros(BOOL flag) = 0;
69 
70  virtual const char* WINAPI getNameOfTester() = 0;
71  virtual int WINAPI getMaxOutputSize() = 0;
72  virtual BOOL WINAPI isSeparatedTimeFormat() = 0;
73  virtual BOOL WINAPI isSeparatedTimeFormatInOfflineSet() = 0;
74  virtual const char* WINAPI getAlternativeLoggerName() = 0;
75  virtual BOOL WINAPI isAlternativeLoggerNameActive() = 0;
76  virtual BOOL WINAPI isConvertedFilesInSubDirsActive() = 0;
77  virtual BOOL WINAPI isMidnightSplittingActive() = 0;
78  virtual BOOL WINAPI isFileTimeSpansLikeSelection() = 0;
79  virtual BOOL WINAPI isMarkerNumbersInFileNames() = 0;
80  virtual BOOL WINAPI isSubfolderWithLoggerName() = 0;
81  virtual int WINAPI getMaxOfflineZipSize() = 0;
82  virtual int WINAPI getMaxOutputSizeSortedDownload() = 0;
83  virtual BOOL WINAPI isTraceCutterStorage() = 0;
84  virtual const char* WINAPI getTraceCutterFNPatternConversion() = 0;
85  virtual BOOL WINAPI isCreateOfflineDataOnTraceCutterStorage() = 0;
86  virtual const char* WINAPI getTraceCutterFNPatternOfflineData() = 0;
87  virtual BOOL WINAPI isTraceCutterMarkerCompact() = 0;
88  virtual BOOL WINAPI isPauseDataRecordingDuringDownload() = 0;
89  virtual BOOL WINAPI isTMASCIITimestampPrecisionToMicros() = 0;
90 
104  virtual void WINAPI setCANPseudoMsgTimeStampProperties(BOOL writeTimeStampMsg, uint32_t channelIndex, uint32_t dlc, uint32_t canID,
105  uint32_t hourBitPos, uint32_t minBitPos, uint32_t secBitPos, uint32_t dayBitPos, uint32_t monthBitPos, uint32_t yearBitPos) = 0;
106 
107  virtual BOOL WINAPI isCANPseudoMsgTimeStampActive() = 0;
108  virtual uint32_t WINAPI getCANPseudoMsgChannelIndexTimeStamp() = 0;
109  virtual uint32_t WINAPI getCANPseudoMsgDlcTimeStamp() = 0;
110  virtual uint32_t WINAPI getCANPseudoMsgCanIDTimeStamp() = 0;
111  virtual uint32_t WINAPI getCANPseudoMsgHourBitPos() = 0;
112  virtual uint32_t WINAPI getCANPseudoMsgMinBitPos() = 0;
113  virtual uint32_t WINAPI getCANPseudoMsgSecBitPos() = 0;
114  virtual uint32_t WINAPI getCANPseudoMsgDayBitPos() = 0;
115  virtual uint32_t WINAPI getCANPseudoMsgMonthBitPos() = 0;
116  virtual uint32_t WINAPI getCANPseudoMsgYearBitPos() = 0;
117 
126  virtual void WINAPI setCANPseudoMsgTriggerProperties(BOOL writeTriggerMessage, uint32_t channelIndex, uint32_t dlc, uint32_t canID, uint32_t triggerNumBitPos) = 0;
127  virtual BOOL WINAPI isCANPseudoMsgTriggerActive() = 0;
128  virtual uint32_t WINAPI getCANPseudoMsgChannelIndexTrigger() = 0;
129  virtual uint32_t WINAPI getCANPseudoMsgDlcTrigger() = 0;
130  virtual uint32_t WINAPI getCANPseudoMsgCanIDTrigger() = 0;
131  virtual uint32_t WINAPI getCANPseudoMsgTriggerNumBitPos() = 0;
132 
141  virtual void WINAPI setMOSTPseudoMsgProperties(BOOL active, uint32_t src, uint32_t target, uint32_t fktBlockID, uint32_t fktID) = 0;
142  virtual BOOL WINAPI isMOSTPseudoMsgActive() = 0;
143  virtual uint32_t WINAPI getMOSTPseudoMsgSourceAddr() = 0;
144  virtual uint32_t WINAPI getMOSTPseudoMsgTargetAddr() = 0;
145  virtual uint32_t WINAPI getMOSTPseudoMsgFktBlockID() = 0;
146  virtual uint32_t WINAPI getMOSTPseudoMsgFktID() = 0;
147 
156  virtual void WINAPI setFlexRayPseudoMsgProperties(BOOL active, uint8_t channel, uint32_t slotID, uint32_t cycleCount, BOOL useFlexRayTypeDynamic) = 0;
157  virtual BOOL WINAPI isFlexRayPseudoMsgActive() = 0;
158  virtual uint8_t WINAPI getFlexRayPseudoMsgChannel() = 0;
159  virtual uint32_t WINAPI getFlexRayPseudoSlotID() = 0;
160  virtual uint32_t WINAPI getFlexRayPseudoCycleCount() = 0;
161  virtual BOOL WINAPI isFlexRayPseudoMsgDynamicType() = 0;
162 
164  virtual void WINAPI useSatelliteTimeForGPSFormats(BOOL flag) = 0;
166  virtual BOOL WINAPI isSatelliteTimeForGPSFormats() = 0;
168  virtual void WINAPI setIsochronousMost150Channels(const char* channels) = 0;
170  virtual const char* WINAPI getIsochronousMost150Channels() = 0;
171 
173  virtual void WINAPI setAnalogToCANPseudoActive(BOOL flag) = 0;
174 
183  virtual void WINAPI addAnalogPortSettings(uint16_t analogPort, BOOL isActive, uint32_t canChannel, uint32_t canID, const char* dbcPath) = 0;
185  virtual void WINAPI clearAnalogPortSettings() = 0;
186 
188  virtual void WINAPI setDigitalToCANPseudoActive(BOOL flag) = 0;
189 
198  virtual void WINAPI addDigitalPortSettings(uint16_t digitalPort, BOOL isActive, uint32_t canChannel, uint32_t canID, BOOL isExt) = 0;
200  virtual void WINAPI clearDigitalPortSettings() = 0;
201 
202  virtual void WINAPI setConvertPhyStatusWithoutData(BOOL flag) = 0;
203  virtual BOOL WINAPI isConvertPhyStatusWithoutData() = 0;
204  virtual void WINAPI setUse10GLinkSpeed(BOOL flag) = 0;
205  virtual BOOL WINAPI isUse10GLinkSpeed() = 0;
206 };
207 
208 #endif // ICLIENTPROPERTIES_H
virtual void WINAPI setAnalogToCANPseudoActive(BOOL flag)=0
Set whether to activate the analogue data to CAN pseudo message feature.
virtual void WINAPI useSatelliteTimeForGPSFormats(BOOL flag)=0
Set whether to use the satellite time stamp in GPS formats instead of the logger time stamp...
virtual BOOL WINAPI isAlternativeLoggerNameActive()=0
see parameter description of setCommonProperties()
virtual void WINAPI setMOSTPseudoMsgProperties(BOOL active, uint32_t src, uint32_t target, uint32_t fktBlockID, uint32_t fktID)=0
Set MOST pseudo properties.
The IClientProperties interface replaces the deprecated ClientProperties struct.
Definition: IClientProperties.h:22
virtual void WINAPI setMarkerNumbersInFileNames(BOOL flag)=0
see parameter description of setCommonProperties()
virtual const char *WINAPI getNameOfTester()=0
see parameter description of setCommonProperties()
virtual int WINAPI getMaxOutputSize()=0
see parameter description of setCommonProperties()
virtual uint32_t WINAPI getCANPseudoMsgTriggerNumBitPos()=0
see parameter description of setCANPseudoMsgTriggerProperties()
virtual uint32_t WINAPI getCANPseudoMsgSecBitPos()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual void WINAPI setSeparatedTimeFormat(BOOL flag)=0
see parameter description of setCommonProperties()
virtual const char *WINAPI getTraceCutterFNPatternConversion()=0
see parameter description of setCommonProperties()
virtual uint32_t WINAPI getMOSTPseudoMsgSourceAddr()=0
see parameter description of setMOSTPseudoMsgProperties()
virtual const char *WINAPI getTraceCutterFNPatternOfflineData()=0
see parameter description of setCommonProperties()
virtual void WINAPI setCommonProperties(const char *nameOfTester, int maxOutputSizeMB, BOOL separatedTimeFormat, BOOL separatedTimeFormatInOfflineSet, const char *alternativeLoggerName, BOOL useAlternativeLoggerName, BOOL useSubDirectories, BOOL midnightSplitting, BOOL fileTimeSpansLikeSelection, BOOL markerNumberInFileNames, BOOL subfolderWithLoggerName, int maxOfflineZipSizeMB, int maxOutputSizeMBSortedDownload, BOOL traceCutterStorage, const char *traceCutterFNPatternConversion, BOOL createOfflineDataOnTraceCutterStorage, const char *traceCutterFNPatternOfflineData, BOOL traceCutterMarkerCompact, BOOL pauseDataRecordingDuringDownload, BOOL tmASCIITimestampPrecisionToMicros)=0
Set Common properties.
virtual void WINAPI setMaxOutputSizeSortedDownload(int size)=0
see parameter description of setCommonProperties()
virtual BOOL WINAPI isTraceCutterStorage()=0
see parameter description of setCommonProperties()
virtual void WINAPI setFlexRayPseudoMsgProperties(BOOL active, uint8_t channel, uint32_t slotID, uint32_t cycleCount, BOOL useFlexRayTypeDynamic)=0
Set FlexRay pseudo properties.
virtual BOOL WINAPI isCANPseudoMsgTimeStampActive()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual uint32_t WINAPI getCANPseudoMsgMinBitPos()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual uint32_t WINAPI getMOSTPseudoMsgTargetAddr()=0
see parameter description of setMOSTPseudoMsgProperties()
virtual void WINAPI setMaxOutputSize(int size)=0
see parameter description of setCommonProperties()
virtual uint32_t WINAPI getCANPseudoMsgMonthBitPos()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual BOOL WINAPI isFlexRayPseudoMsgActive()=0
see parameter description of setFlexRayPseudoMsgProperties()
virtual void WINAPI setNameOfTester(const char *name)=0
see parameter description of setCommonProperties()
virtual void WINAPI setFileTimeSpansLikeSelection(BOOL flag)=0
see parameter description of setCommonProperties()
virtual void WINAPI setConvertedFilesInSubDirsActive(BOOL flag)=0
see parameter description of setCommonProperties()
virtual const char *WINAPI getIsochronousMost150Channels()=0
Returns the channelLabels of the isochronous channels as comma separated string.
virtual uint32_t WINAPI getCANPseudoMsgHourBitPos()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual void WINAPI setTraceCutterFNPatternConversion(const char *pattern)=0
see parameter description of setCommonProperties()
virtual void WINAPI setDigitalToCANPseudoActive(BOOL flag)=0
Set whether to activate the digital data to CAN pseudo message feature.
Defines for Telemotive Client Library.
virtual void WINAPI setAlternativeLoggerName(const char *name)=0
see parameter description of setCommonProperties()
virtual uint32_t WINAPI getCANPseudoMsgDlcTrigger()=0
see parameter description of setCANPseudoMsgTriggerProperties()
virtual BOOL WINAPI isMarkerNumbersInFileNames()=0
see parameter description of setCommonProperties()
virtual uint32_t WINAPI getCANPseudoMsgDayBitPos()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual uint32_t WINAPI getFlexRayPseudoCycleCount()=0
see parameter description of setFlexRayPseudoMsgProperties()
virtual BOOL WINAPI isMOSTPseudoMsgActive()=0
see parameter description of setMOSTPseudoMsgProperties()
virtual uint32_t WINAPI getMOSTPseudoMsgFktID()=0
see parameter description of setMOSTPseudoMsgProperties()
virtual void WINAPI addAnalogPortSettings(uint16_t analogPort, BOOL isActive, uint32_t canChannel, uint32_t canID, const char *dbcPath)=0
Set analog port settings.
virtual uint32_t WINAPI getCANPseudoMsgCanIDTimeStamp()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual int WINAPI getMaxOutputSizeSortedDownload()=0
see parameter description of setCommonProperties()
virtual void WINAPI setTraceCutterFNPatternOfflineData(const char *pattern)=0
see parameter description of setCommonProperties()
virtual BOOL WINAPI isMidnightSplittingActive()=0
see parameter description of setCommonProperties()
virtual BOOL WINAPI isSeparatedTimeFormat()=0
see parameter description of setCommonProperties()
virtual BOOL WINAPI isSatelliteTimeForGPSFormats()=0
Returns whether to use the satellite time stamp in GPS formats instead of the logger time stamp...
virtual void WINAPI clearDigitalPortSettings()=0
Clears all port settings set with the addDigitalPortSettings() function.
virtual uint32_t WINAPI getFlexRayPseudoSlotID()=0
see parameter description of setFlexRayPseudoMsgProperties()
virtual BOOL WINAPI isFlexRayPseudoMsgDynamicType()=0
see parameter description of setFlexRayPseudoMsgProperties()
virtual void WINAPI addDigitalPortSettings(uint16_t digitalPort, BOOL isActive, uint32_t canChannel, uint32_t canID, BOOL isExt)=0
Set digital port settings.
virtual uint32_t WINAPI getCANPseudoMsgYearBitPos()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual void WINAPI setIsochronousMost150Channels(const char *channels)=0
Set the channel widths of the isochronous channels as comma separated string.
virtual BOOL WINAPI isSubfolderWithLoggerName()=0
see parameter description of setCommonProperties()
virtual void WINAPI setMidnightSplittingActive(BOOL flag)=0
see parameter description of setCommonProperties()
virtual const char *WINAPI getAlternativeLoggerName()=0
see parameter description of setCommonProperties()
virtual void WINAPI setTraceCutterStorage(BOOL flag)=0
see parameter description of setCommonProperties()
virtual void WINAPI setCANPseudoMsgTimeStampProperties(BOOL writeTimeStampMsg, uint32_t channelIndex, uint32_t dlc, uint32_t canID, uint32_t hourBitPos, uint32_t minBitPos, uint32_t secBitPos, uint32_t dayBitPos, uint32_t monthBitPos, uint32_t yearBitPos)=0
Set CAN pseudo properties for writing time stamp messages.
virtual BOOL WINAPI isCANPseudoMsgTriggerActive()=0
see parameter description of setCANPseudoMsgTriggerProperties()
virtual uint32_t WINAPI getCANPseudoMsgChannelIndexTimeStamp()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual uint32_t WINAPI getCANPseudoMsgDlcTimeStamp()=0
see parameter description of setCANPseudoMsgTimeStampProperties()
virtual void WINAPI clearAnalogPortSettings()=0
Clears all port settings set with the addAnalogPortSettings() function.
virtual uint8_t WINAPI getFlexRayPseudoMsgChannel()=0
see parameter description of setFlexRayPseudoMsgProperties()
virtual void WINAPI setCANPseudoMsgTriggerProperties(BOOL writeTriggerMessage, uint32_t channelIndex, uint32_t dlc, uint32_t canID, uint32_t triggerNumBitPos)=0
Set CAN pseudo properties for writing trigger messages.
virtual uint32_t WINAPI getCANPseudoMsgCanIDTrigger()=0
see parameter description of setCANPseudoMsgTriggerProperties()
virtual void WINAPI setSubfolderWithLoggerName(BOOL flag)=0
see parameter description of setCommonProperties()
virtual void WINAPI setMaxOfflineZipSize(int size)=0
see parameter description of setCommonProperties()
virtual void WINAPI setAlternativeLoggerNameActive(BOOL flag)=0
see parameter description of setCommonProperties()
virtual uint32_t WINAPI getCANPseudoMsgChannelIndexTrigger()=0
see parameter description of setCANPseudoMsgTriggerProperties()
virtual int WINAPI getMaxOfflineZipSize()=0
see parameter description of setCommonProperties()
virtual void WINAPI setSeparatedTimeFormatInOfflineSet(BOOL flag)=0
see parameter description of setCommonProperties()
virtual BOOL WINAPI isFileTimeSpansLikeSelection()=0
see parameter description of setCommonProperties()
virtual BOOL WINAPI isSeparatedTimeFormatInOfflineSet()=0
see parameter description of setCommonProperties()
virtual uint32_t WINAPI getMOSTPseudoMsgFktBlockID()=0
see parameter description of setMOSTPseudoMsgProperties()
virtual BOOL WINAPI isConvertedFilesInSubDirsActive()=0
see parameter description of setCommonProperties()