DriveWorks SDK Reference
5.12.103 Release
For Test and Development only

SignalStatus.h File Reference

Detailed Description

DriveWorks API: Signal Status Library

Description: This file defines signal status types and encoder/decoder functions

Definition in file SignalStatus.h.

Go to the source code of this file.

Typedefs

typedef uint8_t dwSignalValidity
 The type of the encoded status field. More...
 

Enumerations

enum  dwSignalE2EStatus {
  DW_SIGNAL_E2E_NO_ERROR = 0 ,
  DW_SIGNAL_E2E_SEQ_ERROR = 1 ,
  DW_SIGNAL_E2E_HASH_ERROR = 2 ,
  DW_SIGNAL_E2E_NO_INFORMATION = 3 ,
  DW_SIGNAL_E2E_MAX_ENUM_VALUE = 3
}
 End-2-End related status of the signal. More...
 
enum  dwSignalStatus {
  DW_SIGNAL_STATUS_INIT = 0 ,
  DW_SIGNAL_STATUS_LAST_VALID = 1 ,
  DW_SIGNAL_STATUS_ERROR = 2 ,
  DW_SIGNAL_STATUS_OUT_OF_BOUNDS_ERROR = 3 ,
  DW_SIGNAL_STATUS_MAX_ENUM_VALUE = 3
}
 Overall status of the signal. More...
 
enum  dwSignalTimeoutStatus {
  DW_SIGNAL_TIMEOUT_NEVER_RECEIVED = 0 ,
  DW_SIGNAL_TIMEOUT_NONE = 1 ,
  DW_SIGNAL_TIMEOUT_OVERDUE = 2 ,
  DW_SIGNAL_TIMEOUT_NO_INFORMATION = 3 ,
  DW_SIGNAL_TIMEOUT_DELAYED = 4 ,
  DW_SIGNAL_TIMEOUT_MAX_ENUM_VALUE = 4
}
 Timeout related status of the signal. More...
 

Functions

DW_API_PUBLIC dwStatus dwSignal_checkSignalValidity (dwSignalValidity const validity)
 Checks whether dwSignal*Status values contains a valid signal. More...
 
DW_API_PUBLIC dwStatus dwSignal_decodeSignalValidity (dwSignalStatus *status, dwSignalTimeoutStatus *timeoutStatus, dwSignalE2EStatus *e2eStatus, dwSignalValidity const validity)
 Decode dwSignal*Status values from a dwSignalValidity value. More...
 
DW_API_PUBLIC dwStatus dwSignal_encodeSignalValidity (dwSignalValidity *validity, dwSignalStatus const status, dwSignalTimeoutStatus const timeoutStatus, dwSignalE2EStatus const e2eStatus)
 Encode dwSignal*Status values into a dwSignalValidity value. More...