BPNGClientLib
Library for accessing the Telemotive data logger devices
Public Member Functions | List of all members
IClientProperties Struct Referenceabstract

The IClientProperties interface replaces the deprecated ClientProperties struct. More...

#include <IClientProperties.h>

Public Member Functions

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. More...
 
virtual void WINAPI setNameOfTester (const char *name)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setMaxOutputSize (int size)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setSeparatedTimeFormat (BOOL flag)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setSeparatedTimeFormatInOfflineSet (BOOL flag)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setAlternativeLoggerName (const char *name)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setAlternativeLoggerNameActive (BOOL flag)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setConvertedFilesInSubDirsActive (BOOL flag)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setMidnightSplittingActive (BOOL flag)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setFileTimeSpansLikeSelection (BOOL flag)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setMarkerNumbersInFileNames (BOOL flag)=0
 see parameter description of setCommonProperties()
 
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 setMaxOutputSizeSortedDownload (int size)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setTraceCutterStorage (BOOL flag)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setTraceCutterFNPatternConversion (const char *pattern)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setCreateOfflineDataOnTraceCutterStorage (BOOL flag)=0
 
virtual void WINAPI setTraceCutterFNPatternOfflineData (const char *pattern)=0
 see parameter description of setCommonProperties()
 
virtual void WINAPI setTraceCutterMarkerCompact (BOOL flag)=0
 
virtual void WINAPI setPauseDataRecordingDuringDownload (BOOL flag)=0
 
virtual void WINAPI setTMASCIITimestampPrecisionToMicros (BOOL flag)=0
 
virtual const char *WINAPI getNameOfTester ()=0
 see parameter description of setCommonProperties()
 
virtual int WINAPI getMaxOutputSize ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isSeparatedTimeFormat ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isSeparatedTimeFormatInOfflineSet ()=0
 see parameter description of setCommonProperties()
 
virtual const char *WINAPI getAlternativeLoggerName ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isAlternativeLoggerNameActive ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isConvertedFilesInSubDirsActive ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isMidnightSplittingActive ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isFileTimeSpansLikeSelection ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isMarkerNumbersInFileNames ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isSubfolderWithLoggerName ()=0
 see parameter description of setCommonProperties()
 
virtual int WINAPI getMaxOfflineZipSize ()=0
 see parameter description of setCommonProperties()
 
virtual int WINAPI getMaxOutputSizeSortedDownload ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isTraceCutterStorage ()=0
 see parameter description of setCommonProperties()
 
virtual const char *WINAPI getTraceCutterFNPatternConversion ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isCreateOfflineDataOnTraceCutterStorage ()=0
 
virtual const char *WINAPI getTraceCutterFNPatternOfflineData ()=0
 see parameter description of setCommonProperties()
 
virtual BOOL WINAPI isTraceCutterMarkerCompact ()=0
 
virtual BOOL WINAPI isPauseDataRecordingDuringDownload ()=0
 
virtual BOOL WINAPI isTMASCIITimestampPrecisionToMicros ()=0
 
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. More...
 
virtual BOOL WINAPI isCANPseudoMsgTimeStampActive ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgChannelIndexTimeStamp ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgDlcTimeStamp ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgCanIDTimeStamp ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgHourBitPos ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgMinBitPos ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgSecBitPos ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgDayBitPos ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgMonthBitPos ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgYearBitPos ()=0
 see parameter description of setCANPseudoMsgTimeStampProperties()
 
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. More...
 
virtual BOOL WINAPI isCANPseudoMsgTriggerActive ()=0
 see parameter description of setCANPseudoMsgTriggerProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgChannelIndexTrigger ()=0
 see parameter description of setCANPseudoMsgTriggerProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgDlcTrigger ()=0
 see parameter description of setCANPseudoMsgTriggerProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgCanIDTrigger ()=0
 see parameter description of setCANPseudoMsgTriggerProperties()
 
virtual uint32_t WINAPI getCANPseudoMsgTriggerNumBitPos ()=0
 see parameter description of setCANPseudoMsgTriggerProperties()
 
virtual void WINAPI setMOSTPseudoMsgProperties (BOOL active, uint32_t src, uint32_t target, uint32_t fktBlockID, uint32_t fktID)=0
 Set MOST pseudo properties. More...
 
virtual BOOL WINAPI isMOSTPseudoMsgActive ()=0
 see parameter description of setMOSTPseudoMsgProperties()
 
virtual uint32_t WINAPI getMOSTPseudoMsgSourceAddr ()=0
 see parameter description of setMOSTPseudoMsgProperties()
 
virtual uint32_t WINAPI getMOSTPseudoMsgTargetAddr ()=0
 see parameter description of setMOSTPseudoMsgProperties()
 
virtual uint32_t WINAPI getMOSTPseudoMsgFktBlockID ()=0
 see parameter description of setMOSTPseudoMsgProperties()
 
virtual uint32_t WINAPI getMOSTPseudoMsgFktID ()=0
 see parameter description of setMOSTPseudoMsgProperties()
 
virtual void WINAPI setFlexRayPseudoMsgProperties (BOOL active, uint8_t channel, uint32_t slotID, uint32_t cycleCount, BOOL useFlexRayTypeDynamic)=0
 Set FlexRay pseudo properties. More...
 
virtual BOOL WINAPI isFlexRayPseudoMsgActive ()=0
 see parameter description of setFlexRayPseudoMsgProperties()
 
virtual uint8_t WINAPI getFlexRayPseudoMsgChannel ()=0
 see parameter description of setFlexRayPseudoMsgProperties()
 
virtual uint32_t WINAPI getFlexRayPseudoSlotID ()=0
 see parameter description of setFlexRayPseudoMsgProperties()
 
virtual uint32_t WINAPI getFlexRayPseudoCycleCount ()=0
 see parameter description of setFlexRayPseudoMsgProperties()
 
virtual BOOL WINAPI isFlexRayPseudoMsgDynamicType ()=0
 see parameter description of setFlexRayPseudoMsgProperties()
 
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 isSatelliteTimeForGPSFormats ()=0
 Returns whether to use the satellite time stamp in GPS formats instead of the logger time stamp.
 
virtual void WINAPI setIsochronousMost150Channels (const char *channels)=0
 Set the channel widths of the isochronous channels as comma separated string.
 
virtual const char *WINAPI getIsochronousMost150Channels ()=0
 Returns the channelLabels of the isochronous channels as comma separated string.
 
virtual void WINAPI setAnalogToCANPseudoActive (BOOL flag)=0
 Set whether to activate the analogue data to CAN pseudo message feature.
 
virtual void WINAPI addAnalogPortSettings (uint16_t analogPort, BOOL isActive, uint32_t canChannel, uint32_t canID, const char *dbcPath)=0
 Set analog port settings. More...
 
virtual void WINAPI clearAnalogPortSettings ()=0
 Clears all port settings set with the addAnalogPortSettings() function.
 
virtual void WINAPI setDigitalToCANPseudoActive (BOOL flag)=0
 Set whether to activate the digital data to CAN pseudo message feature.
 
virtual void WINAPI addDigitalPortSettings (uint16_t digitalPort, BOOL isActive, uint32_t canChannel, uint32_t canID, BOOL isExt)=0
 Set digital port settings. More...
 
virtual void WINAPI clearDigitalPortSettings ()=0
 Clears all port settings set with the addDigitalPortSettings() function.
 
virtual void WINAPI setConvertPhyStatusWithoutData (BOOL flag)=0
 
virtual BOOL WINAPI isConvertPhyStatusWithoutData ()=0
 
virtual void WINAPI setUse10GLinkSpeed (BOOL flag)=0
 
virtual BOOL WINAPI isUse10GLinkSpeed ()=0
 

Detailed Description

The IClientProperties interface replaces the deprecated ClientProperties struct.

Call IBPNGClient::getClientProperties() to get a pointer to an instance of this interface class.

Member Function Documentation

◆ addAnalogPortSettings()

virtual void WINAPI IClientProperties::addAnalogPortSettings ( uint16_t  analogPort,
BOOL  isActive,
uint32_t  canChannel,
uint32_t  canID,
const char *  dbcPath 
)
pure virtual

Set analog port settings.

Parameters
analogPortAnalogue port index
isActiveSpecifies whether the data of this port should be written to CAN pseudo messages
canChannelSpecifies the CAN channel that should be used for the pseudo messages
canIDSpecifies the CAN ID that should be used for the pseudo messages
dbcPathThe path to the DBC file that specifies the signal of the CAN ID's message that should carry the value

◆ addDigitalPortSettings()

virtual void WINAPI IClientProperties::addDigitalPortSettings ( uint16_t  digitalPort,
BOOL  isActive,
uint32_t  canChannel,
uint32_t  canID,
BOOL  isExt 
)
pure virtual

Set digital port settings.

Parameters
digitalPortDigital port index
isActiveSpecifies whether the data of this port should be written to CAN pseudo messages
canChannelSpecifies the CAN channel that should be used for the pseudo messages
canIDSpecifies the CAN ID that should be used for the pseudo messages
dbcPathThe path to the DBC file that specifies the signal of the CAN ID's message that should carry the value

◆ setCANPseudoMsgTimeStampProperties()

virtual void WINAPI IClientProperties::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 
)
pure virtual

Set CAN pseudo properties for writing time stamp messages.

Parameters
writeTimeStampMsgActive flag for writing periodical CAN pseudo messages with absolute time stamps
channelIndexCAN channel for the time stamp pseudo messages
dlcDLC for the time stamp pseudo messages
canIDCAN ID for the time stamp pseudo messages
hourBitPosBit position for the hour (0..23, 5 bit length) value in the CAN data bytes
minBitPosBit position for the minute (0..59, 6 bit length) value in the CAN data bytes
secBitPosBit position for the second (0..59, 6 bit length) value in the CAN data bytes
dayBitPosBit position for the day (1..31, 5 bit length) value in the CAN data bytes
monthBitPosBit position for the month (1..12, 4 bit length) value in the CAN data bytes
yearBitPosBit position for the year (8 bit length) value in the CAN data bytes

◆ setCANPseudoMsgTriggerProperties()

virtual void WINAPI IClientProperties::setCANPseudoMsgTriggerProperties ( BOOL  writeTriggerMessage,
uint32_t  channelIndex,
uint32_t  dlc,
uint32_t  canID,
uint32_t  triggerNumBitPos 
)
pure virtual

Set CAN pseudo properties for writing trigger messages.

Parameters
writeTriggerMessageActive flag for writing CAN pseudo messages with trigger information
channelIndexCAN channel for the trigger pseudo messages
dlcDLC for the trigger pseudo messages
canIDCAN ID for the trigger pseudo messages
triggerNumBitPosBit position for the trigger's index (16 bit length)

◆ setCommonProperties()

virtual void WINAPI IClientProperties::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 
)
pure virtual

Set Common properties.

Parameters
nameOfTesterName of tester that is written to the converted file names
maxOutputSizeMBMaximum file size for converted files. When this size is reached a new file is created.
separatedTimeFormatSpecifies the time format that should be used for converted files. Set 1 for long format (e.g. [2011-12-20]_10.15.48) or 0 for short frmat (e.g. 20111220_101548)
separatedTimeFormatInOfflineSetSpecifies the time format that should be used for offline conversion sets. Set 1 for long format (e.g. [2011-12-20]_10.15.48) or 0 for short format (e.g. 20111220_101548)
alternativeLoggerNameThe logger device's name is included in the converted files' names. An alternative logger name can be used.
useAlternativeLoggerNameSet this fied to 1 if the alternative logger name should be used in converted file names, 0 if not.
useSubDirectoriesSet to 1 if converted files should be stored in subdirectories named be their start date, set 0 if they should not.
midnightSplittingSet to 1 if converted files should be splitted at 00:00:00 of each date, set to 0 if they should not.
fileTimeSpansLikeSelectionThe file names of the converted files contain the time span of the included data. Setting this parameter to 1 will create time spans like they were specified in the IConversionSet. Setting this to 0 will create time spans according to the effectively included data.
markerNumberInFileNamesSpecifies whether the indices of the marker included in a converted file should be appended to its file name
subfolderWithLoggerNameSpecifies whether the name of the subfolder the converted files are stored in should contain the logger name or not.
maxOutputSizeMBSortedDownloadMaximum file size for sorted download trace files. When this size is reached a new file is created.
tmASCIITimestampPrecisionToMicrosIf true the TMASCII on conversion will write 6 digits on timestamp after seperator (microsecond resolution)

◆ setFlexRayPseudoMsgProperties()

virtual void WINAPI IClientProperties::setFlexRayPseudoMsgProperties ( BOOL  active,
uint8_t  channel,
uint32_t  slotID,
uint32_t  cycleCount,
BOOL  useFlexRayTypeDynamic 
)
pure virtual

Set FlexRay pseudo properties.

Parameters
activeActive flag for writing FlexRay pseudo messages for trigger
channelFlexRayChannel 0 = 1A, 1 = 1B, ....
slotIDFlexRay slot ID
cycleCountFlexRay Cycle
useFlexRayTypeDynamicFlexRay dynamic or static type

◆ setMOSTPseudoMsgProperties()

virtual void WINAPI IClientProperties::setMOSTPseudoMsgProperties ( BOOL  active,
uint32_t  src,
uint32_t  target,
uint32_t  fktBlockID,
uint32_t  fktID 
)
pure virtual

Set MOST pseudo properties.

Parameters
activeActive flag for writing MOST pseudo messages for trigger
srcSource address
targetTarget address
fktBlockIDFunction block ID
fktIDFunction ID

The documentation for this struct was generated from the following file: