Logo
中文版
详情联系： neusar-support@reachauto.com
Public 成员函数 | 所有成员列表
ara::diag::EcuResetRequest类 参考abstract
CommonAPIs

Service EcuReset Request interface. 更多...

#include <ecu_reset_request.h>

ara::diag::EcuResetRequest 的协作图:
Collaboration graph

Public 成员函数

 EcuResetRequest (const ara::core::InstanceSpecifier &specifier)
 Constructor of EcuResetRequest. 更多...
 
virtual ~EcuResetRequest () noexcept
 Destructor of EcuResetRequest. 更多...
 
virtual ara::core::Future< void > RequestReset (ResetRequestType resetType, ara::core::Optional< std::uint8_t > id, const MetaInfo &metaInfo, CancellationHandler &cancellationHandler)=0
 Called for any EcuRest subFunction, except En-/DisableRapidShutdown. StateManagement needs to evalute carefully if the request to restart parts or the whole machine. Once the request to reset is accepted, the StateManagement has to rely on this decision for the ExecuteReset() trigger. 更多...
 
virtual void ExecuteReset (MetaInfo metaInfo)=0
 StateManagement has to execute the requested reset. Called after DM sent the response message to tester. 更多...
 
ara::core::Result< void > Offer ()
 This Offer will enable the DM to forward request messages to this handler. 更多...
 
void StopOffer ()
 This StopOffer will disable the forwarding of request messages from DM. 更多...
 
virtual ara::core::Future< void > EnableRapidShutdown (bool enable, const MetaInfo &metaInfo, CancellationHandler &cancellationHandler)=0
 interface for subFunction En-/DisableRapidShutdown 更多...
 

详细描述

Service EcuReset Request interface.

Swsid
SWS_DM_01009
符合标准
yes
非标原因
N/A
种类
class
符号
EcuResetRequest
范围
namespace ara::diag
基类
N/A
分类
ara
头文件
ara/diag/ecu_reset_request.h
注解
EcuResetRequest service ECU restart.
模板参数
N/A

在文件 第 行定义.

构造及析构函数说明

◆ EcuResetRequest()

ara::diag::EcuResetRequest::EcuResetRequest ( const ara::core::InstanceSpecifier &  specifier)
explicit

Constructor of EcuResetRequest.

模板参数
N/A
参数
[in]specifierAn InstanceSpecifier linking this instance with the PortPrototype in the manifest
[out]N/A
[in,out]N/A
返回
N/A
注解
N/A
异常
N/A
Swsid
SWS_DM_01010
符合标准
yes
非标原因
N/A
种类
function
可见
public
线程安全
no
Fireandforget
no
错误
N/A
头文件
ara/diag/ecu_reset_request.h
异常安全
N/A
分类
ara

在文件 第 行定义.

◆ ~EcuResetRequest()

ara::diag::EcuResetRequest::~EcuResetRequest ( )
virtualnoexcept

Destructor of EcuResetRequest.

模板参数
N/A
参数
[in]N/A
[out]N/A
[in,out]N/A
返回
N/A
注解
N/A
异常
N/A
Swsid
SWS_DM_01011
符合标准
yes
非标原因
N/A
种类
function
可见
public
线程安全
no
Fireandforget
no
错误
N/A
头文件
ara/diag/ecu_reset_request.h
异常安全
noexcept
分类
ara

在文件 第 行定义.

成员函数说明

◆ EnableRapidShutdown()

virtual ara::core::Future<void> ara::diag::EcuResetRequest::EnableRapidShutdown ( bool  enable,
const MetaInfo &  metaInfo,
CancellationHandler &  cancellationHandler 
)
pure virtual

interface for subFunction En-/DisableRapidShutdown

模板参数
N/A
参数
[in]enablewhen enable is set to true the rapid shutdown will be enabled, setting enable to false will disable rapid shutdown
[in]metaInfoMetaInfo of the request.
[in]cancellationHandlerSet if the current conversation is canceled.
[out]N/A
[in,out]N/A
返回
ara::core::Future<void>
注解
N/A
异常
N/A
Swsid
SWS_DM_01012
符合标准
yes
非标原因
N/A
种类
function
可见
public
线程安全
no
Fireandforget
no
错误
DiagErrorDomain::DiagErrc::kRejected
错误
DiagErrorDomain::DiagErrc::kResetTypeNotSupported
头文件
ara/diag/ecu_reset_request.h
异常安全
N/A
分类
ara

◆ ExecuteReset()

virtual void ara::diag::EcuResetRequest::ExecuteReset ( MetaInfo  metaInfo)
pure virtual

StateManagement has to execute the requested reset. Called after DM sent the response message to tester.

模板参数
N/A
参数
[in]metaInfoMetaInfo of the request.
[out]N/A
[in,out]N/A
返回
N/A
注解
N/A
异常
N/A
Swsid
SWS_DM_01014
符合标准
yes
非标原因
N/A
种类
function
可见
public
线程安全
no
Fireandforget
no
错误
N/A
头文件
ara/diag/ecu_reset_request.h
异常安全
N/A
分类
ara

◆ Offer()

ara::core::Result< void > ara::diag::EcuResetRequest::Offer ( )

This Offer will enable the DM to forward request messages to this handler.

模板参数
N/A
参数
[in]N/A
[out]N/A
[in,out]N/A
返回
ara::core::Result<void>
注解
N/A
异常
N/A
Swsid
SWS_DM_01016
符合标准
yes
非标原因
N/A
种类
function
可见
public
线程安全
no
Fireandforget
no
错误
DiagErrorDomain::DiagReportingErrc::kNotOffered
错误
DiagErrorDomain::DiagReportingErrc::kGenericError
错误
DiagErrorDomain::DiagOfferErrc::kAlreadyOffered
头文件
ara/diag/ecu_reset_request.h
异常安全
N/A
分类
ara

在文件 第 行定义.

引用了 ara::diag::kAlreadyOffered.

◆ RequestReset()

virtual ara::core::Future<void> ara::diag::EcuResetRequest::RequestReset ( ResetRequestType  resetType,
ara::core::Optional< std::uint8_t >  id,
const MetaInfo &  metaInfo,
CancellationHandler &  cancellationHandler 
)
pure virtual

Called for any EcuRest subFunction, except En-/DisableRapidShutdown. StateManagement needs to evalute carefully if the request to restart parts or the whole machine. Once the request to reset is accepted, the StateManagement has to rely on this decision for the ExecuteReset() trigger.

模板参数
N/A
参数
[in]resetTypeType of the requested reset.
[in]idid of the custom reset type. Will only be evaluated when resetType is "custom"
[in]metaInfoMetaInfo of the request.
[in]cancellationHandlerSet if the current conversation is canceled.
[out]N/A
[in,out]N/A
返回
ara::core::Future<void>
注解
N/A
异常
N/A
Swsid
SWS_DM_01013
符合标准
yes
非标原因
N/A
种类
function
可见
public
线程安全
no
Fireandforget
no
错误
DiagErrorDomain::DiagErrc::kRejected
错误
DiagErrorDomain::DiagErrc::kRequestFailed
错误
DiagErrorDomain::DiagErrc::kCustomResetTypeNotSupported
错误
DiagErrorDomain::DiagErrc::kResetTypeNotSupported
头文件
ara/diag/ecu_reset_request.h
异常安全
N/A
分类
ara

◆ StopOffer()

void ara::diag::EcuResetRequest::StopOffer ( )

This StopOffer will disable the forwarding of request messages from DM.

模板参数
N/A
参数
[in]N/A
[out]N/A
[in,out]N/A
返回
N/A
注解
N/A
异常
N/A
Swsid
SWS_DM_01017
符合标准
yes
非标原因
N/A
种类
function
可见
public
线程安全
no
Fireandforget
no
错误
N/A
头文件
ara/diag/ecu_reset_request.h
异常安全
N/A
分类
ara

在文件 第 行定义.