ara::diag::DoIPActivationLine类 参考

A simple interface class for APP to notify DM of status change of active line. 更多...

#include <doip_activation_line.h>

ara::diag::DoIPActivationLine 的协作图:

Public 成员函数
	DoIPActivationLine (const ara::core::InstanceSpecifier &specifier)
	Constructor. 更多...
virtual	~DoIPActivationLine () noexcept
	destructor. 更多...
virtual ara::core::Future< std::uint8_t >	GetNetworkInterfaceId ()=0
	Called to get the network interface Id (see DoIpNetworkConfiguration.networkInterfaceId) for which this DoIPActivationLine instance is responsible. 更多...
void	UpdateActivationLineState (bool state)
	Notify DM to update activation line status. 更多...
virtual ara::core::Future< bool >	GetActivationLineState ()=0
	Called to get the current activation line state. 更多...
ara::core::Result< void >	Offer ()
	Provides a service, this method enables the DM to start listening for changes in the active line. 更多...
void	StopOffer ()
	This StopOffer will disable the provision of activation line state to DM 更多...

详细描述

A simple interface class for APP to notify DM of status change of active line.

Swsid

SWS_DM_00830

符合标准

Yes

非标原因

N/A

种类

class

符号

ara::diag::DoIPActivationLine

范围

namespace ara::diag

基类

communication::DiagnosticSkeleton

分类

ara

头文件

ara/diag/doip_activation_line.h

注解

The DoIPActivationLine service is used to inherit this class and implement corresponding virtual functions according to business requirements.

模板参数

N/A

在文件 第 行定义.

构造及析构函数说明

DoIPActivationLine()

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

explicit

Constructor.

模板参数

N/A

参数

[in]	specifier	Communication channel identifier. InstanceSpecifier is an alias for std::string type.
[out]	N/A
[in,out]	N/A

返回

N/A

注解

N/A

异常

N/A

Swsid

SWS_DM_00831

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/doip_activation_line.h

异常安全

N/A

分类

ara

在文件 第 行定义.

~DoIPActivationLine()

ara::diag::DoIPActivationLine::~DoIPActivationLine ( )

virtualnoexcept

destructor.

模板参数

N/A

参数

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

返回

N/A

注解

[Error]: N/A

异常

N/A

Swsid

SWS_DM_00832

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/doip_activation_line.h

异常安全

N/A

分类

ara

在文件 第 行定义.

成员函数说明

GetActivationLineState()

virtual ara::core::Future<bool> ara::diag::DoIPActivationLine::GetActivationLineState ( )

pure virtual

Called to get the current activation line state.

模板参数

N/A

参数

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

返回

ara::core::Future< bool >

注解

N/A

异常

N/A

Swsid

SWS_DM_00835

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/doip_activation_line.h

异常安全

N/A

分类

ara

GetNetworkInterfaceId()

virtual ara::core::Future<std::uint8_t> ara::diag::DoIPActivationLine::GetNetworkInterfaceId ( )

pure virtual

Called to get the network interface Id (see DoIpNetworkConfiguration.networkInterfaceId) for which this DoIPActivationLine instance is responsible.

模板参数

N/A

参数

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

返回

ara::core::Future< std::uint8_t >

注解

If the reported DoIpNetworkConfiguration.networkInterfaceId belongs to a DoIpNetwork Configuration with property isActivationLineDependent = ’FALSE’, this is an error!

异常

N/A

Swsid

SWS_DM_00833

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/doip_activation_line.h

异常安全

N/A

分类

ara

Offer()

ara::core::Result< void > ara::diag::DoIPActivationLine::Offer

(

)

Provides a service, this method enables the DM to start listening for changes in the active line.

模板参数

N/A

参数

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

返回

N/A

注解

N/A

异常

N/A

Swsid

SWS_DM_00836

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

DiagErrorDomain::DiagReportingErrc::kGenericError

错误

DiagErrorDomain::DiagOfferErrc::kAlreadyOffered

头文件

ara/diag/doip_activation_line.h

异常安全

N/A

分类

ara

在文件 第 行定义.

引用了 ara::diag::kAlreadyOffered.

StopOffer()

void ara::diag::DoIPActivationLine::StopOffer

(

)

This StopOffer will disable the provision of activation line state to DM

StopOffer prohibits the provision of an active line signal to the DM.

模板参数

N/A

参数

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

返回

N/A

注解

N/A

异常

N/A

Swsid

SWS_DM_00837

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/doip_activation_line.h

异常安全

N/A

分类

ara

在文件 第 行定义.

UpdateActivationLineState()

void ara::diag::DoIPActivationLine::UpdateActivationLineState

(

bool

state

)

Notify DM to update activation line status.

模板参数

N/A

参数

[in]	bool	active line state.
[out]	N/A
[in,out]	N/A

返回

N/A

注解

N/A

异常

N/A

Swsid

SWS_DM_00834

符合标准

yes

非标原因

N/A

种类

function

可见

public

线程安全

N/A

Fireandforget

N/A

错误

N/A

头文件

ara/diag/doip_activation_line.h

异常安全

N/A

分类

ara

在文件 第 行定义.