ara::diag Namespace Reference

ARA diagnostic management. More...

Namespaces
namespace	debouncing
	Namespace of debouncing mechanism components.
namespace	routing
	UDS services routing namespace.

Classes
class	CancellationHandler
	A wrapper class around a conversation cancellation handler callback. More...
class	Condition
	A class that represents an enable condition for processing an event by DM. More...
class	Conversation
	A wrapper around the communication between a diagnostic client and a diagnostic server. More...
struct	ConversationIdentifierType
	Type to identify a conversation. More...
struct	CounterBased
	Contour-based debouncing parameters. More...
struct	DataIdentifierReentrancyType
	Reentrancy type of a data ID IO. More...
class	DiagErrorDomain
	Diagnostic Management error domain. More...
class	DownloadService
	A class to request diagnostic data transfer from a client to the server. More...
class	DTCInformation
	A class to process Diagnostic Trouble Code (DTC) information. More...
class	EcuResetRequest
	ECU reset request handling service. More...
class	Event
	Diagnostic event class that represents a fault path of a system. More...
struct	EventStatusByte
	Byte that specifies an event status. More...
class	GenericRoutine
	A service to execute a specific sequence of instructions (routine) and obtain the result. More...
class	GenericUDSService
	An abstract class to handle generic UDS messages. More...
class	MetaInfo
	Diagnostic metainfo in different context. More...
class	Monitor
	A class to monitor the correct functionality of a system part. More...
class	OperationCycle
	A class for handling a monitoring operation cycle. More...
struct	OperationOutput
	Positive response of a handled UDS request. More...
class	SecurityAccess
	A class to evaluate the security access to the data among diagnostic services. More...
struct	SecurityLevel
	A data model that contains the status of a security level. More...
struct	TimeBased
	Time-based debouncing parameters. More...
struct	UdsDtcStatusByteType
	Byte that specifies an UDS DTC status. More...
class	UploadService
	A class to request diagnostic data transfer from the server to a client. More...

Enumerations
enum class	ConditionType { kConditionFalse = 0x00 , kConditionTrue = 0x01 }
	Condition status type. More...
enum class	ActivityStatusType : uint8_t { kActive = 0x00 , kInactive = 0x01 }
	Conversation enable status. More...
enum class	SessionControlType : uint8_t { kDefaultSession = 0x01 , kProgrammingSession = 0x02 , kExtendedDiagnosticSession = 0x03 , kSafetySystemDiagnosticSession = 0x04 }
	Diagnostic session control type. More...
enum class	SecurityLevelType : uint8_t { kLocked = 0x00 }
	UDS security level access status. More...
enum class	DiagErrc : ara::core::ErrorDomain::CodeType {   kAlreadyOffered = 101 , kConfigurationMismatch = 102 , kDebouncingConfigurationInconsistent = 103 , kReportIgnored = 104 ,   kInvalidArgument = 105 , kNotOffered = 106 , kGenericError = 107 , kNoSuchDTC = 108 ,   kBusy = 109 , kFailed = 110 , kMemoryError = 111 , kWrongDtc = 112 ,   kRejected = 113 , kResetTypeNotSupported = 114 , kRequestFailed = 115 }
	Diagnostic Management interal error type. More...
enum class	ControlDtcStatusType : uint8_t { kDTCSettingOn = 0x00 , kDTCSettingOff = 0x01 }
	UDS Diagnostic Trouble Code (DTC) status byte updating state. More...
enum class	UdsDtcStatusBitType : uint8_t {   kTestFailed = 0x01 , kTestFailedThisOperationCycle = 0x02 , kPendingDTC = 0x04 , kConfirmedDTC = 0x08 ,   kTestNotCompletedSinceLastClear = 0x10 , kTestFailedSinceLastClear = 0x20 , kTestNotCompletedThisOperationCycle = 0x40 , kWarningIndicatorRequested = 0x80 }
	Specific bit flag of the UDS DTC status byte. More...
enum class	ResetRequestType : uint32_t { kSoftReset = 1 , kHardReset = 2 , kKeyOffOnReset = 3 , kCustomReset = 4 }
	ECU reset request type. More...
enum class	DTCFormatType : uint8_t { kDTCFormatOBD = 0 , kDTCFormatUDS = 1 , kDTCFormatJ1939 = 2 }
	Diagnostic Trouble Code (DTC) number format. More...
enum class	EventStatusBit : uint8_t { kTestFailed , kTestFailedThisOperationCycle , kTestNotCompletedThisOperationCycle }
	Specific bit of the event status byte. More...
enum class	DebouncingState : uint8_t {   kNeutral = 0x00 , kTemporarilyDefective = 0x01 , kFinallyDefective = 0x02 , kTemporarilyHealed = 0x04 ,   kFinallyHealed = 0x08 }
	Debouncing state of an event. More...
enum class	Context : uint32_t { kDiagnosticCommunication , kFaultMemory , kDoIP }
	Diagnostic metainfo context. More...
enum class	InitMonitorReason : uint32_t { kClear = 0x00 , kRestart = 0x01 , kReenabled = 0x02 , kDisabled = 0x03 }
	Monitoring re-initialization reason. More...
enum class	MonitorAction : uint32_t {   kPassed = 0x00 , kFailed = 0x01 , kPrepassed = 0x02 , kPrefailed = 0x03 ,   kFdcThresholdReached = 0x04 , kResetTestFailed = 0x05 , kFreezeDebouncing = 0x06 , kResetDebouncing = 0x07 }
	Diagnostic monitor action type reported by an adpative application. More...
enum class	ReentrancyType : int8_t { kFully = 0x00 , kNot = 0x01 }
	Reentrancy type of an instance. More...
enum class	KeyCompareResultType { kKeyValid = 0x00 , kKeyInvalid = 0x01 }
	Security key comparison result. More...

Detailed Description

ARA diagnostic management.

Enumeration Type Documentation

ActivityStatusType

enum class ara::diag::ActivityStatusType : uint8_t

strong

Conversation enable status.

Enumerator
kActive	Active conversation due to a request processing or a non-default session.
kInactive	Inactive conversation.

ConditionType

enum class ara::diag::ConditionType

strong

Condition status type.

Enumerator
kConditionFalse	Disabled condition.
kConditionTrue	Enabled condition.

Context

enum class ara::diag::Context : uint32_t

strong

Diagnostic metainfo context.

Enumerator
kDiagnosticCommunication	For service request in classic platform Diagnostic Communication Manager (DCM)
kFaultMemory	For Data IDentifier (DID) according to ISO 14229-1 in diagnostic snapshots.
kDoIP	For reading Vehicle Identifier Number (VIN) according to ISO 3779.

ControlDtcStatusType

enum class ara::diag::ControlDtcStatusType : uint8_t

strong

UDS Diagnostic Trouble Code (DTC) status byte updating state.

Enumerator
kDTCSettingOn	Enabled USD DTC status byte update.
kDTCSettingOff	Disable USD DTC status byte update.

DebouncingState

enum class ara::diag::DebouncingState : uint8_t

strong

Debouncing state of an event.

Enumerator
kNeutral	Zero Fault Detection Counter (FDC)
kTemporarilyDefective	FDC greater than zero and less than 127.
kFinallyDefective	FDC equal to 127.
kTemporarilyHealed	FDC less than zero and greater than -128.
kFinallyHealed	FDC equal to -128.

DiagErrc

enum class ara::diag::DiagErrc : ara::core::ErrorDomain::CodeType

strong

Diagnostic Management interal error type.

Enumerator
kConfigurationMismatch	!< Already offered service
kDebouncingConfigurationInconsistent	!< Configuration misalignment with DEXT
kReportIgnored	!< Invalid monitor debouncing configuration
kInvalidArgument	!< Disabled control DTC setting
kNotOffered	!< Invalid passed argument from caller
kGenericError	!< Request from a not offered service
kNoSuchDTC	!< General error occurrance
kBusy	!< Invalid DTC number
kFailed	!< Busy interface call
kMemoryError	!< Failed process
kWrongDtc	!< Memory error occurrance
kRejected	!< Incorrect passed DTC number
kResetTypeNotSupported	!< Request rejection
kRequestFailed	!< Unsupported reset type by the Diagnostic Address instance

DTCFormatType

enum class ara::diag::DTCFormatType : uint8_t

strong

Diagnostic Trouble Code (DTC) number format.

Enumerator
kDTCFormatOBD	ISO 15031-6 format.
kDTCFormatUDS	ISO 14229-1 format.
kDTCFormatJ1939	SAE J1939-73 format.

EventStatusBit

enum class ara::diag::EventStatusBit : uint8_t

strong

Specific bit of the event status byte.

See also

EventStatusByte

Enumerator
kTestFailed	Bit 0: Failed test.
kTestFailedThisOperationCycle	Bit 1: Failed test during the current operation cycle.
kTestNotCompletedThisOperationCycle	Bit 6: Incomplete test during the current operation cyle.

InitMonitorReason

enum class ara::diag::InitMonitorReason : uint32_t

strong

Monitoring re-initialization reason.

Enumerator
kClear	Event was cleared.
kRestart	Operation cycle of the event was restarted.
kReenabled	Enable conditions (if set) are fullfilled.
kDisabled	Enable conditions (if set) are no longer fullfilled.

KeyCompareResultType

enum class ara::diag::KeyCompareResultType

strong

Security key comparison result.

Enumerator
kKeyValid	Valid security key.
kKeyInvalid	Invalid security key.

MonitorAction

enum class ara::diag::MonitorAction : uint32_t

strong

Diagnostic monitor action type reported by an adpative application.

Enumerator
kPassed	Monitoring passed.
kFailed	Monitoring failed.
kPrepassed	Monitoring pre-passed.
kPrefailed	Monitoring pre-failed.
kFdcThresholdReached	Fault Detection Counter (FDC) threshold has been reached.
kResetTestFailed	Reset TestFailed bit in UDS DTC status.
kFreezeDebouncing	Freeze the internal debouncing.
kResetDebouncing	Reset the internal debouncing.

ReentrancyType

enum class ara::diag::ReentrancyType : int8_t

strong

Reentrancy type of an instance.

Enumerator
kFully	Fully reentrant instance.
kNot	Not reentrant instance.

ResetRequestType

enum class ara::diag::ResetRequestType : uint32_t

strong

ECU reset request type.

Enumerator
kHardReset	!< ECU reset due to an application request
kKeyOffOnReset	!< ECU reset due to disconnecting and re-connecting the power supply
kCustomReset	!< ECU reset due to the ignition key off and on

SecurityLevelType

enum class ara::diag::SecurityLevelType : uint8_t

strong

UDS security level access status.

Enumerator
kLocked	Locked security level (no access granted)

SessionControlType

enum class ara::diag::SessionControlType : uint8_t

strong

Diagnostic session control type.

Enumerator
kDefaultSession	Default diagnostic session.
kProgrammingSession	Session to enable memory programming diagnostic services.
kExtendedDiagnosticSession	Session to enable function adjustment diagnostic services.
kSafetySystemDiagnosticSession	Session to enable safety system diagnostic services.

UdsDtcStatusBitType

enum class ara::diag::UdsDtcStatusBitType : uint8_t

strong

Specific bit flag of the UDS DTC status byte.

See also

UdsDtcStatusByteType

Enumerator
kTestFailed	DTC test is failed at the request time.
kTestFailedThisOperationCycle	DTC test is failed at the current operation cycle.
kPendingDTC	DTC test is failed at the current/preivious operation cycle.
kConfirmedDTC	DTC is confirmed at the request time.
kTestNotCompletedSinceLastClear	DTC test is not completed since the last error codes clearing.
kTestFailedSinceLastClear	DTC test is failed since the last error codes clearing.
kTestNotCompletedThisOperationCycle	DTC test is not completed at the current operation cycle.
kWarningIndicatorRequested	Warning Indicator Requested (WIR)