DiagnosticDTCInformationInterface. 更多...

#include <dtc_information.h>

ara::diag::DTCInformation 的协作图:

类
struct	SnapshotDataIdentifierType
	Type for SnapshotDataIdentifierType status. 更多...

struct	SnapshotDataRecordType
	Type for SnapshotDataRecordType status. 更多...

struct	SnapshotRecordUpdatedType
	Type for SnapshotRecordUpdatedType status. 更多...

Public 类型
using	UdsDtcStatusByteType = std::uint8_t
	Type for UDS DTC status byte. 更多...

Public 成员函数
	DTCInformation (const ara::core::InstanceSpecifier &specifier)
	Class for an DTCInformation. 更多...

	~DTCInformation () noexcept=default
	Destructor of class DTCInformation. 更多...

ara::core::Result< UdsDtcStatusByteType >	GetCurrentStatus (std::uint32_t dtc)
	Retrieves the current UDS DTC status byte of the given DTC identifier. 更多...

ara::core::Result< void >	SetDTCStatusChangedNotifier (std::function< void(std::uint32_t dtc, UdsDtcStatusByteType udsStatusByteOld, UdsDtcStatusByteType udsStatusByteNew)>notifier)
	Register a notifier function which is called if a DTC is changed. 更多...

ara::core::Result< ControlDtcStatusType >	GetControlDTCStatus ()
	Contains the current status of the ControlDTCStatus. 更多...

ara::core::Result< std::uint32_t >	GetNumberOfStoredEntries ()
	Contains the number of currently stored fault memory entries. 更多...

ara::core::Result< void >	SetNumberOfStoredEntriesNotifier (std::function< void(std::uint32_t)> notifier)
	Register a notifier function which is called if the number of currently stored fault memory entries changed. 更多...

ara::core::Result< void >	SetControlDtcStatusNotifier (std::function< void(ControlDtcStatusType)> notifier)
	Registers a notifier function which is called if the control DTC setting is changed. 更多...

ara::core::Result< void >	EnableControlDtc ()
	Enforce restoring ControlDTCStatus setting to enabled in case the monitor has some conditions or states demands to do so. 更多...

ara::core::Result< void >	SetSnapshotRecordUpdatedNotifier (std::function< void(SnapshotRecordUpdatedType)> notifier)
	Register a notifier function which is called if the SnapshotRecord is changed. 更多...

详细描述

DiagnosticDTCInformationInterface.

Swsid: SWS_DM_00657

符合标准: yes

非标原因: N/A

种类: class

符号: ara::diag::DTCInformation

范围: namespace ara::diag

基类: N/A

分类: ara

头文件: ara/diag/dtc_information.h

注解: DiagnosticDTCInformationInterface.

模板参数

N/A

在文件第行定义.

成员类型定义说明

◆ UdsDtcStatusByteType

using ara::diag::DTCInformation::UdsDtcStatusByteType = std::uint8_t

Type for UDS DTC status byte.

Swsid: SWS_DM_00659

符合标准: yes

非标原因: N/A

种类: std::uint8_t

符号: N/A

范围: class ara::diag::DTCInformation

分类: ara

头文件: ara/diag/dtc_information.h

注解: Type for UDS DTC status byte.

在文件第行定义.

构造及析构函数说明

◆ DTCInformation()

ara::diag::DTCInformation::DTCInformation ( const ara::core::InstanceSpecifier & specifier )

explicit

Class for an DTCInformation.

模板参数

N/A

参数

[in]	specifier	specifier InstanceSpecifier to an PortPrototype of an DiagnosticDTCInformationInterface.
[out]	N/A
[in,out]	N/A

返回: N/A

注解: N/A

异常

N/A

Swsid: SWS_DM_00664

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: N/A

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

在文件第行定义.

◆ ~DTCInformation()

ara::diag::DTCInformation::~DTCInformation ( )

defaultnoexcept

Destructor of class DTCInformation.

模板参数

N/A

参数

[in]	N/A
[out]	N/A
[in,out]	N/A

返回: N/A

注解: N/A

异常

N/A

Swsid: SWS_DM_00665

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: N/A

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

成员函数说明

◆ EnableControlDtc()

ara::core::Result< void > ara::diag::DTCInformation::EnableControlDtc ( )

Enforce restoring ControlDTCStatus setting to enabled in case the monitor has some conditions or states demands to do so.

模板参数

N/A

参数

[in]	N/A
[out]	ara::core::Result<void>
[in,out]	N/A

返回: ara::core::Result<void>

注解: N/A

异常

N/A

Swsid: SWS_DM_00674

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: DiagErrorDomain::DiagReportingErrc::kGenericError Connection to DM lost

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ GetControlDTCStatus()

ara::core::Result< ControlDtcStatusType > ara::diag::DTCInformation::GetControlDTCStatus ( )

Contains the current status of the ControlDTCStatus.

模板参数

N/A

参数

[in]	N/A
[out]	ara::core::Result<ControlDtcStatusType>	The current status of ControlDtcStatus (related to UDS service 0x85)
[in,out]	N/A

返回: ara::core::Result<ControlDtcStatusType>

注解: N/A

异常

N/A

Swsid: SWS_DM_00672

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: DiagErrorDomain::DiagReportingErrc::kGenericError Connection to DM lost

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ GetCurrentStatus()

ara::core::Result< ara::diag::DTCInformation::UdsDtcStatusByteType > ara::diag::DTCInformation::GetCurrentStatus ( std::uint32_t dtc )

Retrieves the current UDS DTC status byte of the given DTC identifier.

模板参数

N/A

参数

[in]	std::uint32_t	dtc DTC indentifier for which the status should be retrieved.
[out]	ara::core::Result<UdsDtcStatusByteType>	the current UDS DTC status byte of the given DTC identifier.
[in,out]	N/A

返回: ara::core::Result<UdsDtcStatusByteType>

注解: N/A

异常

N/A

Swsid: SWS_DM_00666

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: DiagErrorDomain::DiagErrc::kNoSuchDtc given DTC identifier not available.

错误: DiagErrorDomain::DiagReportingErrc::kGenericError Connection to DM lost

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ GetNumberOfStoredEntries()

ara::core::Result< std::uint32_t > ara::diag::DTCInformation::GetNumberOfStoredEntries ( )

Contains the number of currently stored fault memory entries.

模板参数

N/A

参数

[in]	N/A	The function to be called if a DTC status has changed.
[out]	ara::core::Result<std::uint32_t>	Number of currently stored fault memory entries.
[in,out]	N/A

返回: ara::core::Result<std::uint32_t>

注解: N/A

异常

N/A

Swsid: SWS_DM_00669

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: DiagErrorDomain::DiagReportingErrc::kGenericError Connection to DM lost

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ SetControlDtcStatusNotifier()

ara::core::Result< void > ara::diag::DTCInformation::SetControlDtcStatusNotifier ( std::function< void(ControlDtcStatusType)> notifier )

Registers a notifier function which is called if the control DTC setting is changed.

模板参数

N/A

参数

[in]	notifier	The function to be called if the ControlDTCStatus (related to UDS service 0x85) for this diagnostic memory instance has changed.
[out]	ara::core::Result<void>
[in,out]	N/A

返回: ara::core::Result<void>

注解: N/A

异常

N/A

Swsid: SWS_DM_00673

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: DiagErrorDomain::DiagReportingErrc::kGenericError Connection to DM lost

错误: DiagErrorDomain::DiagErrc::kInvalidArgument given argument is invalid (pointer).

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ SetDTCStatusChangedNotifier()

ara::core::Result< void > ara::diag::DTCInformation::SetDTCStatusChangedNotifier ( std::function< void(std::uint32_t dtc, UdsDtcStatusByteType udsStatusByteOld, UdsDtcStatusByteType udsStatusByteNew)> notifier )

Register a notifier function which is called if a DTC is changed.

模板参数

N/A

参数

[in]	notifier	The function to be called if a DTC status has changed.
[out]	ara::core::Result<	void >
[in,out]	N/A

返回: ara::core::Result< void >

注解: N/A

异常

N/A

Swsid: SWS_DM_00667

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: DiagErrorDomain::DiagErrc::kInvalidArgument given argument is invalid (pointer).

错误: DiagErrorDomain::DiagReportingErrc::kGenericError Connection to DM lost

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ SetNumberOfStoredEntriesNotifier()

ara::core::Result< void > ara::diag::DTCInformation::SetNumberOfStoredEntriesNotifier ( std::function< void(std::uint32_t)> notifier )

Register a notifier function which is called if the number of currently stored fault memory entries changed.

模板参数

N/A

参数

[in]	notifier	The function to be called if the number of entries for this diagnostic event memory instance has changed.
[out]	ara::core::Result<void>	-
[in,out]	N/A

返回: ara::core::Result<void> -

注解: N/A

异常

N/A

Swsid: SWS_DM_00670

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: DiagErrorDomain::DiagErrc::kInvalidArgument given argument is invalid (pointer).

错误: DiagErrorDomain::DiagReportingErrc::kGenericError Connection to DM lost

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kInvalidArgument.

◆ SetSnapshotRecordUpdatedNotifier()

ara::core::Result< void > ara::diag::DTCInformation::SetSnapshotRecordUpdatedNotifier ( std::function< void(SnapshotRecordUpdatedType)> notifier )

Register a notifier function which is called if the SnapshotRecord is changed.

模板参数

N/A

参数

[in]	notifier	The function to be called if the SnapshotRecord is changed.
[out]	ara::core::Result<void>
[in,out]	N/A

返回: ara::core::Result<void>

注解: N/A

异常

N/A

Swsid: SWS_DM_00668

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: DiagErrorDomain::DiagReportingErrc::kGenericError Connection to DM lost

错误: DiagErrorDomain::DiagErrc::kInvalidArgument given argument is invalid (pointer).

头文件: ara/diag/dtc_information.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kInvalidArgument.

类

Public 类型

Public 成员函数

详细描述

成员类型定义说明

◆ UdsDtcStatusByteType

构造及析构函数说明

◆ DTCInformation()

◆ ~DTCInformation()

成员函数说明

◆ EnableControlDtc()

◆ GetControlDTCStatus()

◆ GetCurrentStatus()

◆ GetNumberOfStoredEntries()

◆ SetControlDtcStatusNotifier()

◆ SetDTCStatusChangedNotifier()

◆ SetNumberOfStoredEntriesNotifier()

◆ SetSnapshotRecordUpdatedNotifier()