| DWDataReader 5.0.4 Reading data from Dewesoft data files

Loading...
Searching...
No Matches
Classes | Macros | Typedefs | Enumerations
DWDataReaderLibTypes.h File Reference
`#include "DWDataReaderLibDef.h"`
`#include <inttypes.h>`

Go to the source code of this file.

## Classes
struct | DWFileInfo
| Represents metadata about a data file. More...
struct | DWMeasurementInfo
| Structure with information about the current measurement. More...
struct | DWChannel
| Structure represents a Dewesoft channel. More...
struct | DWComplex
| Represents a complex number with real and imaginary components. More...
struct | DWEvent
| Represents an event in datafile. More...
struct | DWReducedValue
| Represents a set of agregated data for samples over a specific time interval. More...
struct | DWArrayInfo
| Represents information about an axis on and array channel. More...
struct | DWCustomProp
| Represents a custom property associated with a channel. More...
struct | DWBinarySample
| Represents a binary sample. More...

## Macros
#define | __int64 int64_t

## Typedefs
typedef void * | READER_HANDLE

## Enumerations
enum | DWStatus { DWSTAT_OK = 0 , DWSTAT_ERROR = 1 , DWSTAT_ERROR_FILE_CANNOT_OPEN = 2 , DWSTAT_ERROR_FILE_ALREADY_IN_USE = 3 , DWSTAT_ERROR_FILE_CORRUPT = 4 , DWSTAT_ERROR_NO_MEMORY_ALLOC = 5 , DWSTAT_ERROR_CREATE_DEST_FILE = 6 , DWSTAT_ERROR_EXTRACTING_FILE = 7 , DWSTAT_ERROR_CANNOT_OPEN_EXTRACTED_FILE = 8 , DWSTAT_ERROR_INVALID_IB_LEVEL = 9 , DWSTAT_ERROR_CAN_NOT_SUPPORTED = 10 , DWSTAT_ERROR_INVALID_READER = 11 , DWSTAT_ERROR_INVALID_INDEX = 12 , DWSTAT_ERROR_INSUFFICENT_BUFFER = 13 }
| Status codes returned from library function calls. More...
enum | DWChannelProps { DW_DATA_TYPE = 0 , DW_DATA_TYPE_LEN_BYTES = 1 , DW_CH_INDEX = 2 , DW_CH_INDEX_LEN = 3 , DW_CH_TYPE = 4 , DW_CH_SCALE = 5 , DW_CH_OFFSET = 6 , DW_CH_XML = 7 , DW_CH_XML_LEN = 8 , DW_CH_XMLPROPS = 9 , DW_CH_XMLPROPS_LEN = 10 , DW_CH_CUSTOMPROPS = 11 , DW_CH_CUSTOMPROPS_COUNT = 12 , DW_CH_LONGNAME = 13 , DW_CH_LONGNAME_LEN = 14 }
| Specifies the properties that can be retrieved for a channel. More...
enum | DWChannelType { DW_CH_TYPE_SYNC = 0 , DW_CH_TYPE_ASYNC = 1 , DW_CH_TYPE_SV = 2 }
| Specifies the type of channel. More...
enum | DWCustomPropValueType { DW_CUSTOM_PROP_VAL_TYPE_EMPTY = 0 , DW_CUSTOM_PROP_VAL_TYPE_INT64 = 1 , DW_CUSTOM_PROP_VAL_TYPE_DOUBLE = 2 , DW_CUSTOM_PROP_VAL_TYPE_STRING = 3 }
| Specifies the type of custom property value. More...
enum | DWEventType { etStart = 1 , etStop = 2 , etTrigger = 3 , etVStart = 11 , etVStop = 12 , etKeyboard = 20 , etNotice = 21 , etVoice = 22 , etPicture = 23 , etModule = 24 , etAlarm = 25 , etCursorInfo = 26 , etAlarmLevel = 27 }
| Specifies the type of event. More...
enum | DWStoringType { ST_ALWAYS_FAST = 0 , ST_ALWAYS_SLOW = 1 , ST_FAST_ON_TRIGGER = 2 , ST_FAST_ON_TRIGGER_SLOW_OTH = 3 }
| Specifies the type data storing mode. More...
enum | DWDataType { dtByte = 0 , dtShortInt = 1 , dtSmallInt = 2 , dtWord = 3 , dtInteger = 4 , dtSingle = 5 , dtInt64 = 6 , dtDouble = 7 , dtLongword = 8 , dtComplexSingle = 9 , dtComplexDouble = 10 , dtText = 11 , dtBinary = 12 , dtCANPortData = 13 , dtCANFDPortData = 14 , dtBytes8 = 15 , dtBytes16 = 16 , dtBytes32 = 17 , dtBytes64 = 18 }
| Specifies the channel data type. More...

## Detailed Description

Enums, structs and constants exposed from DWDataReader library.

## Typedef Documentation

## ◆ READER_HANDLE

typedef void* READER_HANDLE

Handle to the data reader object

## Enumeration Type Documentation

## ◆ DWChannelProps

enum DWChannelProps

Specifies the properties that can be retrieved for a channel.

This enumeration is used in function DWGetChannelProps to specify which property of a channel should be retrieved. Each enumerator corresponds to a different aspect of a channel property.

Enumerator
DW_DATA_TYPE | Data type
DW_DATA_TYPE_LEN_BYTES | Length of data type in bytes
DW_CH_INDEX | Channel index
DW_CH_INDEX_LEN | Length of channel index
DW_CH_TYPE | Type
DW_CH_SCALE | Scale
DW_CH_OFFSET | Offset
DW_CH_XML | XML structure of channel
DW_CH_XML_LEN | Length of XML structure
DW_CH_XMLPROPS | XML structure properties
DW_CH_XMLPROPS_LEN | Length of XML structure properties
DW_CH_CUSTOMPROPS | XML structure custom properties
DW_CH_CUSTOMPROPS_COUNT | Length of XML structure custom properties
DW_CH_LONGNAME | Long name of channel
DW_CH_LONGNAME_LEN | Length of long name of channel

## ◆ DWChannelType

enum DWChannelType

Specifies the type of channel.

Enumerator
DW_CH_TYPE_SYNC | Synchronous channel
DW_CH_TYPE_ASYNC | Asynchronous channel
DW_CH_TYPE_SV | Single value channel

## ◆ DWCustomPropValueType

enum DWCustomPropValueType

Specifies the type of custom property value.

This enumeration defines the possible types of custom property values that can be associated with a channel. Each enumerator corresponds to a different data type.

Enumerator
DW_CUSTOM_PROP_VAL_TYPE_EMPTY | No value
DW_CUSTOM_PROP_VAL_TYPE_INT64 | 64-bit integer value
DW_CUSTOM_PROP_VAL_TYPE_DOUBLE | Double precision floating-point value
DW_CUSTOM_PROP_VAL_TYPE_STRING | String value

## ◆ DWDataType

enum DWDataType

Specifies the channel data type.

Enumerator
dtByte | Byte data type
dtShortInt | Short integer data type
dtSmallInt | Small integer data type
dtWord | Word data type
dtInteger | Integer data type
dtSingle | Single precision floating point data type
dtInt64 | 64-bit integer data type
dtDouble | Double precision floating point data type
dtLongword | Long word data type
dtComplexSingle | Complex single precision data type
dtComplexDouble | Complex double precision data type
dtText | Text data type
dtBinary | Binary data type
dtCANPortData | CAN port data type
dtCANFDPortData | CAN FD port data type
dtBytes8 | 8 bytes data type
dtBytes16 | 16 bytes data type
dtBytes32 | 32 bytes data type
dtBytes64 | 64 bytes data type

## ◆ DWEventType

enum DWEventType

Specifies the type of event.

Enumerator
etStart | Recording start
etStop | Recording stop
etTrigger | Trigger event
etVStart | Video recording start
etVStop | Video recording stop
etKeyboard | Keyboard input
etNotice | System notice
etVoice | Voice annotation
etPicture | Picture capture
etModule | Module event
etAlarm | Alarm notification
etCursorInfo | Cursor information
etAlarmLevel | Alarm level change

## ◆ DWStatus

enum DWStatus

Status codes returned from library function calls.

This enumeration defines the possible status codes that can be returned by library functions, indicating success or various error conditions.

Enumerator
DWSTAT_OK | Operation completed successfully
DWSTAT_ERROR | Generic error occurred in the DLL
DWSTAT_ERROR_FILE_CANNOT_OPEN | Unable to open the specified file
DWSTAT_ERROR_FILE_ALREADY_IN_USE | File is already in use by another process
DWSTAT_ERROR_FILE_CORRUPT | File is corrupted or has invalid format
DWSTAT_ERROR_NO_MEMORY_ALLOC | Memory allocation failed
DWSTAT_ERROR_CREATE_DEST_FILE | Failed to create destination file (d7z files only)
DWSTAT_ERROR_EXTRACTING_FILE | Error occurred while extracting data (d7z files only)
DWSTAT_ERROR_CANNOT_OPEN_EXTRACTED_FILE | Unable to open extracted file (d7z files only)
DWSTAT_ERROR_INVALID_IB_LEVEL | Invalid IB level specified
DWSTAT_ERROR_CAN_NOT_SUPPORTED | Feature or operation not supported on CAN channel
DWSTAT_ERROR_INVALID_READER | Invalid reader handle
DWSTAT_ERROR_INVALID_INDEX | Invalid index specified
DWSTAT_ERROR_INSUFFICENT_BUFFER | Insufficient buffer size provided

## ◆ DWStoringType

enum DWStoringType

Specifies the type data storing mode.

Enumerator
ST_ALWAYS_FAST | Always fast storing
ST_ALWAYS_SLOW | Always slow storing
ST_FAST_ON_TRIGGER | Fast on trigger storing
ST_FAST_ON_TRIGGER_SLOW_OTH | Fast on trigger slow otherwise storing