Class to implement operations on diagnostic Events. 更多...

#include <event.h>

ara::diag::Event 的协作图:

Public 类型
enum	DebouncingState : uint8_t { DebouncingState::kNeutral = 0x00, DebouncingState::kTemporarilyDefective = 0x01, DebouncingState::kFinallyDefective = 0x02, DebouncingState::kTemporarilyHealed = 0x04, DebouncingState::kFinallyHealed = 0x08 }
	Debounce status of event . 更多...

using	EventStatusByte = std::uint8_t
	Current event status bit-encoded. 更多...

Public 成员函数
	Event (const ara::core::InstanceSpecifier &specifier)
	Constructor fct. for objects of class Event. 更多...

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

ara::core::Result< EventStatusByte >	GetEventStatus ()
	Returns the current diagnostic event status. 更多...

ara::core::Result< void >	SetEventStatusChangedNotifier (std::function< void(EventStatusByte)> notifier)
	Register a notifier function which is called if a diagnostic event is changed. 更多...

ara::core::Result< std::uint32_t >	GetDTCNumber (DTCFormatType dtcFormat)
	Returns the DTC-ID related to this event instance. 更多...

ara::core::Result< DebouncingState >	GetDebouncingStatus ()
	Get the current debouncing status. 更多...

ara::core::Result< std::int8_t >	GetFaultDetectionCounter ()
	Returns the current value of fault detection counter of this event. 更多...

详细描述

Class to implement operations on diagnostic Events.

Swsid: SWS_DM_00646

符合标准: yes

非标原因: N/A

种类: class

符号: ara::diag::Event

范围: namespace ara::diag

基类: N/A

分类: ara

头文件: ara/diag/event.h

注解: Class to implement operations on diagnostic Events.

模板参数

N/A

在文件第行定义.

成员类型定义说明

◆ EventStatusByte

using ara::diag::Event::EventStatusByte = std::uint8_t

Current event status bit-encoded.

Swsid: SWS_DM_00644

符合标准: yes

非标原因: N/A

种类: std::uint8_t

符号: N/A

范围: class ara::diag::Event

分类: ara

头文件: ara/diag/event.h

注解: Current event status bit-encoded.

在文件第行定义.

成员枚举类型说明

◆ DebouncingState

enum ara::diag::Event::DebouncingState : uint8_t

strong

Debounce status of event .

Swsid: SWS_DM_00645

符合标准: yes

非标原因: N/A

种类: enumeration

符号: DebouncingState

范围: namespace ara::diag::Event

基本类型: std::uint8_t

取值: N/A

分类: ara

头文件: ara/diag/event.h

注解: N/A

枚举值
kNeutral	Neutral (corresponds to FDC = 0)
kTemporarilyDefective	Temporarily Defective (corresponds to 0 < FDC < 127)
kFinallyDefective	finally Defective (corresponds to FDC = 127)
kTemporarilyHealed	temporarily healed (corresponds to -128 < FDC < 0)
kFinallyHealed	finally healed (corresponds to FDC = -128)

在文件第行定义.

构造及析构函数说明

◆ Event()

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

explicit

Constructor fct. for objects of class Event.

模板参数

N/A

参数

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

返回: N/A

注解: N/A

异常

N/A

Swsid: SWS_DM_00647

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: N/A

头文件: ara/diag/event.h

异常安全: N/A

分类: ara

在文件第行定义.

◆ ~Event()

ara::diag::Event::~Event ( )

defaultnoexcept

Destructor of class Event.

模板参数

N/A

参数

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

返回: N/A

注解: N/A

异常

N/A

Swsid: SWS_DM_00648

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: N/A

头文件: ara/diag/event.h

异常安全: N/A

分类: ara

成员函数说明

◆ GetDebouncingStatus()

ara::core::Result< ara::diag::Event::DebouncingState > ara::diag::Event::GetDebouncingStatus ( )

Get the current debouncing status.

模板参数

N/A

参数

[in]	N/A
[out]	ara::core::Result<DebouncingState>	Return the current debouncing state of this event.
[in,out]	N/A

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

注解: N/A

异常

N/A

Swsid: SWS_DM_00654

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

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

头文件: ara/diag/event.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ GetDTCNumber()

ara::core::Result< std::uint32_t > ara::diag::Event::GetDTCNumber ( DTCFormatType dtcFormat )

Returns the DTC-ID related to this event instance.

模板参数

N/A

参数

[in]	dtc_format	Define DTC format for the return value.
[out]	ara::core::Result<std::uint32_t>	DTC number in respective DTCFormatType.
[in,out]	N/A

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

注解: DTCFormatType noly supported kDTCFormatUDS

异常

N/A

Swsid: SWS_DM_00653

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

错误: DiagErrorDomain::DiagReportingErrc::kGenericError General error occurred.

头文件: ara/diag/event.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ GetEventStatus()

ara::core::Result< ara::diag::Event::EventStatusByte > ara::diag::Event::GetEventStatus ( )

Returns the current diagnostic event status.

模板参数

N/A

参数

[in]	N/A
[out]	ara::core::Result<EventStatusByte>	the current diagnostic event status.
[in,out]	N/A

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

注解: N/A

异常

N/A

Swsid: SWS_DM_00649

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

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

头文件: ara/diag/event.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ GetFaultDetectionCounter()

ara::core::Result< std::int8_t > ara::diag::Event::GetFaultDetectionCounter ( )

Returns the current value of fault detection counter of this event.

模板参数

N/A

参数

[in]	N/A
[out]	ara::core::Result<std::int8_t>	current faultDetectionCounter value.
[in,out]	N/A

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

注解: N/A

异常

N/A

Swsid: SWS_DM_00656

符合标准: yes

非标原因: N/A

种类: function

可见: public

线程安全: N/A

Fireandforget: N/A

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

头文件: ara/diag/event.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

◆ SetEventStatusChangedNotifier()

ara::core::Result< void > ara::diag::Event::SetEventStatusChangedNotifier ( std::function< void(EventStatusByte)> notifier )

Register a notifier function which is called if a diagnostic event is changed.

模板参数

N/A

参数

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

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

注解: N/A

异常

N/A

Swsid: SWS_DM_00650

符合标准: 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/event.h

异常安全: N/A

分类: ara

在文件第行定义.

引用了 ara::diag::kGenericError.

Public 类型

Public 成员函数

详细描述

成员类型定义说明

◆ EventStatusByte

成员枚举类型说明

◆ DebouncingState

构造及析构函数说明

◆ Event()

◆ ~Event()

成员函数说明

◆ GetDebouncingStatus()

◆ GetDTCNumber()

◆ GetEventStatus()

◆ GetFaultDetectionCounter()

◆ SetEventStatusChangedNotifier()