Conversation interface.
更多...
#include <conversation.h>
Conversation interface.
- Swsid
- SWS_DM_00693
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- class
- 符号
- Conversation
- 范围
- namespace ara::diag
- 基类
- N/A
- 分类
- ara
- 头文件
- ara/diag/conversation.h
- 注解
- N/A
- 模板参数
-
在文件 第 行定义.
◆ GetActivityStatus()
Represents the status of an active conversation.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result< ActivityStatusType >
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00694
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ GetAllConversations()
| ara::core::Vector< std::reference_wrapper< Conversation > > ara::diag::Conversation::GetAllConversations |
( |
| ) |
|
|
static |
Get all possible conversations.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Vector< std::reference_wrapper< Conversation > >
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00782
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ GetConversation()
Get one conversation based on given MetaInfo.
- 模板参数
-
- 参数
-
| [in] | metaInfo | contains additional meta information |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result< Conversation & >
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00692
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
引用了 , 以及 ara::diag::kFailed.
◆ GetConversationIdentifier()
Getter for the current identification properties of the active conversation.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result<ConversationIdentifierType>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00700
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ GetCurrentActiveConversations()
| ara::core::Vector< std::reference_wrapper< Conversation > > ara::diag::Conversation::GetCurrentActiveConversations |
( |
| ) |
|
|
static |
Get all currently active conversations.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Vector< std::reference_wrapper< Conversation > >
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00783
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
引用了 ara::diag::kActive.
◆ GetDiagnosticSecurityLevel()
| ara::core::Result< SecurityLevelType > ara::diag::Conversation::GetDiagnosticSecurityLevel |
( |
| ) |
|
Represents the current active diagnostic SecurityLevel of an active conversation.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result<SecurityLevelType>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00698
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ GetDiagnosticSecurityLevelShortName()
| ara::core::Result< ara::core::StringView > ara::diag::Conversation::GetDiagnosticSecurityLevelShortName |
( |
SecurityLevelType |
securityLevel | ) |
|
Converts the given diagnostic SecurityLevel into the ShortName.
- 模板参数
-
- 参数
-
| [in] | securityLevel | Security level enum the shortname shall be returned for. |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result<ara::core::StringView>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00708
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
引用了 ara::diag::kLocked.
◆ GetDiagnosticSession()
Represents the current active diagnostic session of an active conversation.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result<SessionControlType>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00696
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ GetDiagnosticSessionShortName()
| ara::core::Result< ara::core::StringView > ara::diag::Conversation::GetDiagnosticSessionShortName |
( |
SessionControlType |
session | ) |
|
◆ ResetToDefaultSession()
| ara::core::Result< void > ara::diag::Conversation::ResetToDefaultSession |
( |
| ) |
|
Method to reset the current session to default session.
- 模板参数
-
- 参数
-
| [in] | N/A | |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result<void>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00701
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ SetActivityNotifier()
| ara::core::Result< void > ara::diag::Conversation::SetActivityNotifier |
( |
std::function< void(ActivityStatusType)> |
notifier | ) |
|
Register a notifier function which is called if the activity is changed.
- 模板参数
-
- 参数
-
| [in] | notifier | notifier function to be called |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result< void >
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00695
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ SetDiagnosticSessionNotifier()
| ara::core::Result< void > ara::diag::Conversation::SetDiagnosticSessionNotifier |
( |
std::function< void(SessionControlType)> |
notifier | ) |
|
Register a notifier function which is called if the Session is changed.
- 模板参数
-
- 参数
-
| [in] | notifier | notifier function to be called |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result<void>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00697
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.
◆ SetSecurityLevelNotifier()
| ara::core::Result< void > ara::diag::Conversation::SetSecurityLevelNotifier |
( |
std::function< void(SecurityLevelType)> |
notifier | ) |
|
Register a notifier function which is called if the SecurityLevel is changed.
- 模板参数
-
- 参数
-
| [in] | notifier | notifier function to be called |
| [out] | N/A | |
| [in,out] | N/A | |
- 返回
- ara::core::Result<void>
- 注解
- N/A
- 异常
-
- Swsid
- SWS_DM_00699
- 符合标准
- yes
- 非标原因
- N/A
- 种类
- function
- 可见
- public
- 线程安全
- no
- Fireandforget
- no
- 错误
- N/A
- 头文件
- ara/diag/conversation.h
- 异常安全
- N/A
- 分类
- ara
在文件 第 行定义.