class ara::diag::DiagnosticSovdRecordContentElementDataView

use

The synchronous function [SWS_DM_02288] inserts a signed integer value (std::int64_t) under the specified key key (ara::core::StringView) into an SOVD data structure. It is declared as a method of class ara::diag::DiagnosticSovdRecordContentElementDataView and included via header ara/diag/diagnostic_sovd_content_element_data.h.

Prerequisites and error handling

According to [SWS_DM_02288], the underlying DiagnosticSovdContentElementData object must be of type RecordContentElementData or ContentData, while the element to be added must not itself be a ContentData. The function is defined as noexcept and returns a ara::core::Result<void>. If the operation fails—such as when the target container has an incompatible type or the element cannot be added—the result contains an error code; interpretation: this is also likely to be the case for key collisions. Question Q-524c832a794559b7 (open)

Concurrency and Interaction

Execution is specified as thread-safe and exception safe [SWS_DM_02288]. Within the interface, type-identical overloads exist for unsigned integers ([SWS_DM_02289]), floating-point numbers ([SWS_DM_02290]), boolean values ([SWS_DM_02291]), strings ([SWS_DM_02292]), and nested data elements ([SWS_DM_02293]). The same method is also provided on the carrier class DiagnosticSovdContentElementData ([SWS_DM_02368]).

The synchronous member function Add of class ara::diag::DiagnosticSovdRecordContentElementDataView is used to append an unsigned 64-bit integer value under a given key ([SWS_DM_02289]). It is used within the scope of the SOVD functionality of Diagnostic Management, which provides diagnostic communication according to ASAM SOVD (AUTOSAR_AP_SWS_Diagnostics §1.0 “Introduction and functional overview”, [SWS_DM_01369]).

Usage and Invocation

The method is included via header ara/diag/diagnostic_sovd_content_element_data.h. As parameters, it expects identifier key as ara::core::StringView as well as value to be added content_element as std::uint64_t ([SWS_DM_02289]). The call occurs synchronously, is specified as noexcept, and returns the result in the form of ara::core::Result<void>.

Error Handling and Boundary Conditions

• Type conditions: The instantiated DiagnosticSovdContentElementData must be of either type RecordContentElementData or ContentData. In addition, the element to be added must not itself be of type ContentData ([SWS_DM_02289]).
• Error behavior: If one of these type requirements is violated or the element cannot be added, the function returns an erroneous ara::core::Result ([SWS_DM_02289]). The specification does not name specific error codes at this point; presumably the result object returns a corresponding error code of the diagnostic domain. Question Q-ffca131eece93b35 (open)
• Concurrency: The function is explicitly specified as thread-safe and exception safe ([SWS_DM_02289]).

Interaction

The method belongs to a family of typed overloads for capturing primitive and complex data elements, including variants for signed integers ([SWS_DM_02288]) and structured sub-elements ([SWS_DM_02293]). An equivalent interface is offered in parallel on class DiagnosticSovdContentElementData ([SWS_DM_02369]).

The synchronous member function Add of class ara::diag::DiagnosticSovdRecordContentElementDataView adds a primitive floating-point value of type double to a record under the specified key key [SWS_DM_02290]. The function serves to construct structured diagnostic data for the SOVD server functionality of Diagnostic Management [SWS_DM_01369].

The following type-related preconditions apply to execution [SWS_DM_02290]:

• The target object must be of type RecordContentElementData or ContentData.
• The element to be added must not itself be of type ContentData.

The method is declared as noexcept (exception safe) and specified as thread-safe for concurrent access [SWS_DM_02290]. If adding fails—for example because the object type is incompatible or the element cannot be inserted—an error is reported via the returned ara::core::Result<void> [SWS_DM_02290]. Interpretation: The exact cause of the error is likely mapped in the ara::core::ErrorCode of the Result object. Question Q-c987f75d785d3e90 (open)

In combination with the related overloads of Add, the method enables the structured population of SOVD records with integer values ([SWS_DM_02288], [SWS_DM_02289]), boolean values [SWS_DM_02291], character strings [SWS_DM_02292], or more complex item data [SWS_DM_02293].

The function Add of class ara::diag::DiagnosticSovdRecordContentElementDataView serves to add a boolean primitive value under a specified key to a SOVD data element [SWS_DM_02291]. The call is made via the header file ara/diag/diagnostic_sovd_content_element_data.h with the parameter name key of type ara::core::StringView and the payload value content_element of type bool [SWS_DM_02291]. Since the method immediately returns a ara::core::Result<void> and no asynchrony is specified, the operation is expected to execute synchronously. Question Q-a16b08bf68f8590b (open)

Error handling is performed via the returned ara::core::Result<void>. An error is returned if the underlying DiagnosticSovdContentElementData is neither of type RecordContentElementData nor ContentData, or if the element cannot be added [SWS_DM_02291]. Specific error codes are not detailed in the specification excerpt.

Regarding concurrency and execution safety, the method is classified as thread-safe and provides exception safety (noexcept) [SWS_DM_02291]. As a structural constraint, the specification requires that the element to be added must not itself be of type ContentData [SWS_DM_02291].

In the overall system, this method complements related overloads for signed integers [SWS_DM_02288], unsigned integers [SWS_DM_02289], floating-point numbers [SWS_DM_02290], strings [SWS_DM_02292], and subordinate content elements [SWS_DM_02293]. In addition, the analogous interface exists on class DiagnosticSovdContentElementData [SWS_DM_02371] in the context of the SOVD server functionality of Diagnostic Management [SWS_DM_01369].

use

The synchronous method Add of class ara::diag::DiagnosticSovdRecordContentElementDataView serves to add an entry with a key and a primitive string value to a SOVD data element [SWS_DM_02292]. The call is made via the two parameters key and content_element, each passed as ara::core::StringView [SWS_DM_02292]. As a return value, the function provides a ara::core::Result<void> to signal the operation result [SWS_DM_02292].

Error handling

If adding fails, the method returns an error in the ara::core::Result [SWS_DM_02292]. This occurs if the underlying object is not of type RecordContentElementData or ContentData, or if the element cannot be added [SWS_DM_02292]. Interpretation: The specific error codes are likely determined by the implementation's associated error domain, as the specification does not explicitly list them on the function definition. Question Q-ba196615f0cd8fc8 (open)

Concurrency and Constraints

The operation is declared as thread-safe (thread-safe) as well as exception-safe (exception safe) and is annotated with noexcept [SWS_DM_02292]. An essential precondition is that the element passed as a parameter must not itself be of type ContentData [SWS_DM_02292].

Interaction

The function is part of AUTOSAR Diagnostic Management (DM) for implementing SOVD for the Adaptive Platform AUTOSAR_AP_SWS_Diagnostics §1 “Introduction and functional overview”, where the DM acts as a SOVD server [SWS_DM_01369]. For the same scope, analogous overloads of Add exist for signed integers [SWS_DM_02288], unsigned integers [SWS_DM_02289], floating-point numbers [SWS_DM_02290], boolean values [SWS_DM_02291], and complex data elements [SWS_DM_02293]. In addition, ara::diag::DiagnosticSovdContentElementData provides a corresponding string overload [SWS_DM_02372].

The synchronous function Add of class ara::diag::DiagnosticSovdRecordContentElementDataView adds a nested element of type DiagnosticSovdContentElementData under the specified key key to a data element [SWS_DM_02293]. This serves the structured provision of diagnostic data within the scope of SOVD (Service-Oriented Vehicle Diagnostics), which is supported by Diagnostic Management (DM) on the Adaptive Platform ([SWS_DM_01369], AUTOSAR_AP_SWS_Diagnostics §1 “Introduction and functional overview”).

Mandatory type requirements must be observed during use:

• The calling data object must be of type RecordContentElementData or ContentData [SWS_DM_02293].
• The element content_element to be added must explicitly not be of type ContentData [SWS_DM_02293].
• In addition to complex data structures, separate overloads are available for elementary values, for example for integer values ([SWS_DM_02288], [SWS_DM_02289]), floating-point numbers [SWS_DM_02290], boolean values [SWS_DM_02291], or strings [SWS_DM_02292], as are also defined on DiagnosticSovdContentElementData [SWS_DM_02373].

For error handling, the function returns a ara::core::Result<void>. If the operation fails—for example because the type prerequisites are violated or the element cannot be inserted—the result contains an error [SWS_DM_02293]. The exact error coding is presumably based on domain-specific errors of diagnostic management. Question Q-56c929209d0c7358 (open) Regarding concurrency and safety, the method is declared as noexcept, is considered exception safe (exception safe), and is specified as thread-safe (thread-safe) for concurrent access [SWS_DM_02293].

Usage and Semantics

The method Clear of class ara::diag::DiagnosticSovdRecordContentElementDataView is used to synchronously remove all content elements from a RecordContentElementData [SWS_DM_02276]. The call is parameterless via header #include "ara/diag/diagnostic_sovd_content_element_data.h" and has no return value (void) [SWS_DM_02276].

As a prerequisite for execution, it is defined that the underlying data instance must be of type RecordContentElementData or ContentData [SWS_DM_02276]. Interpretation: Since the function is declared as noexcept and reports no error status, adherence to this data type is likely already ensured beforehand during creation of the view object. Question Q-93e43eee235a8f12 (open)

Error Handling and Concurrency

Regarding execution safety, the method is specified as exception safe and throws no exceptions due to the noexcept declaration [SWS_DM_02276]. The call is also explicitly classified as thread-safe, so concurrent accesses are permitted [SWS_DM_02276].

Interaction and Distinction

In the SOVD environment, this function is distinguished from the method Clear on DiagnosticSovdContentElementData [SWS_DM_02338], which is defined for array elements and returns a ara::core::Result<void>. Likewise, a functional distinction exists from the view method for arrays [SWS_DM_02233] as well as from the asynchronous clearing of DTCs via ara::diag::DTCInformation::Clear, which returns a ara::core::Future<void> and is not thread-safe [SWS_DM_00671].

The member function Erase of class ara::diag::DiagnosticSovdRecordContentElementDataView serves to remove a subordinate content element from a diagnostic data record ([SWS_DM_02294], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.14 “Erase”). The declaration is provided via header #include "ara/diag/diagnostic_sovd_content_element_data.h" ([SWS_DM_02294]).

Usage and semantics: As an input parameter, the function accepts the iterator iterator of type DiagnosticSovdRecordContentElementDataIterator, which points to the concrete element to be deleted ([SWS_DM_02294]). Interpretation: Since the function is declared with noexcept and directly returns ara::core::Result<void> instead of a future object, the deletion is likely executed synchronously in the caller's thread. Question Q-148ae95c28910b16 (open) Upon successful execution, the method returns an empty ara::core::Result<void> ([SWS_DM_02294]).

Error handling: The operation fails if the affected data element is neither of type RecordContentElementData nor ContentData or the element could not be removed from the container ([SWS_DM_02294]). In these error cases, the function returns an error with error code DiagErrc::kInvalidArgument ([SWS_DM_02294]).

Concurrency and interaction: For the call, the interface is specified as thread-safe and exception safe ([SWS_DM_02294]). Functionally, the function corresponds to the array variant ara::diag::DiagnosticSovdArrayContentElementDataView::Erase ([SWS_DM_02247], AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.8 “Erase”) and interacts with the elementary erasure operations of the container class DiagnosticSovdContentElementData for arrays ([SWS_DM_02352]) and records ([SWS_DM_02374]).

The synchronous member function Find of the view class ara::diag::DiagnosticSovdRecordContentElementDataView serves to locate an element based on its key ([SWS_DM_02285], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.15 “Find”). Parameter key of type ara::core::StringView is passed; as a result, the function returns a modifiable iterator of type DiagnosticSovdRecordContentElementDataIterator ([SWS_DM_02285]). A prerequisite for usage is that the associated DiagnosticSovdContentElementData is of type RecordContentElementData or ContentData ([SWS_DM_02285]).

Regarding error handling and concurrency, the function is declared as noexcept, is considered exception safe (exception safe), and is specified as thread-safe (thread-safe) ([SWS_DM_02285]). Since the return type is directly an iterator and not a ara::core::Result, the function reports no specific error codes; if the searched key does not exist, an end iterator is presumably returned. Question Q-a34054c9851517ae (open)

In interplay with related interfaces, a const overload exists on the same view class ([SWS_DM_02286], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.16 “Find”), which returns a DiagnosticSovdRecordContentElementDataConstIterator. An analogous const interface is also offered by class DiagnosticSovdRecordContentElementDataConstView ([SWS_DM_02306], AUTOSAR_AP_SWS_Diagnostics §8.60.9.1.1.7 “Find”). In contrast, method Find on DiagnosticSovdContentElementData encapsulates its iterator in a ara::core::Result in order to represent invalid types or missing keys as errors ([SWS_DM_02365], [SWS_DM_02366], AUTOSAR_AP_SWS_Diagnostics §8.60.6.1.2.25 “Find”).

The synchronous member function Find of class ara::diag::DiagnosticSovdRecordContentElementDataView serves for the read-only lookup of a data element based on its key ([SWS_DM_02286], AUTOSAR AP SWS Diagnostics §8.60.11.1.1.16 “Find”).

Usage and Parameters

The function accepts the sought key key as ara::core::StringView ([SWS_DM_02286]). A prerequisite for the call is that the instance is of diagnostic type RecordContentElementData or ContentData ([SWS_DM_02286]). As a return value, it synchronously delivers a constant iterator of type DiagnosticSovdRecordContentElementDataConstIterator ([SWS_DM_02286]). If no element matching the key exists, an iterator marking the end of the sequence is presumably returned (Interpretation). Question Q-41a1eba77c0bc236 (open)

Error Handling and Concurrency

The interface is declared with noexcept, guarantees exception safety (exception safe), and is specified as thread-safe (thread-safe) for concurrent access ([SWS_DM_02286]). Unlike the method on ara::diag::DiagnosticSovdContentElementData ([SWS_DM_02366]), there is no return via ara::core::Result, which is why error cases are not represented via error codes.

Interaction

For writing or modifying accesses to the same view, the non-constant overload [SWS_DM_02285] with a mutable iterator exists. For pure read-only views, class DiagnosticSovdRecordContentElementDataConstView provides an analogous Find function ([SWS_DM_02306]).

The synchronous member function Remove of class ara::diag::DiagnosticSovdRecordContentElementDataView serves to remove an entry specifically based on its key [SWS_DM_02287]. It is defined in header ara/diag/diagnostic_sovd_content_element_data.h and processes the parameter key of type ara::core::StringView AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.19 “Remove”.

As return value, the function provides an ara::core::Result<bool> [SWS_DM_02287]:

• In the success case, the contained boolean value signals whether the addressed element could actually be removed.
• An error is reported via the ara::core::Result if the element is not of type RecordContentElementData or ContentData, or the specified key was not found [SWS_DM_02287].

Regarding concurrency and constraints, the function is specified as exception-safe (exception safe) and thread-safe (thread-safe) and declared with noexcept [SWS_DM_02287]. As a call precondition, the specification strictly requires that the underlying instance is of type RecordContentElementData or ContentData [SWS_DM_02287].

Interpretation: Functionally, the operation is likely to correspond to removal on the data class ara::diag::DiagnosticSovdContentElementData::Remove [SWS_DM_02367], since signature, parameters, and error scenarios are specified completely congruently AUTOSAR_AP_SWS_Diagnostics §8.60.6.1.2.54 “Remove”. Question Q-5a9ac29a9b5814be (open)

The method Reserve of class ara::diag::DiagnosticSovdRecordContentElementDataView ([SWS_DM_02283], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.20 “Reserve”) synchronously reserves the desired storage capacity for RecordContentElementData. The call is provided via header #include "ara/diag/diagnostic_sovd_content_element_data.h" and accepts parameter capacity of type std::size_t. As return value, the function returns void.

The interface is declared as noexcept and specified as exception safe (“exception safe”) ([SWS_DM_02283]). Neither specific error codes nor error structures are returned. Interpretation: If allocation of the required capacity fails, the error is likely to be caught internally or lead to program termination due to the lack of a return channel such as ara::core::Result. Question Q-ddbaac36f8ed58ad (open)

Regarding concurrency, the function is defined as thread-safe (“thread-safe”) ([SWS_DM_02283]). It can therefore be called in parallel and without additional synchronization measures from multiple threads.

In conjunction with related interfaces, the array variant DiagnosticSovdArrayContentElementDataView::Reserve ([SWS_DM_02240]) behaves analogously. In contrast, DiagnosticSovdContentElementData::Reserve ([SWS_DM_02345]) returns a ara::core::Result<void> to report type conflicts. Function DiagnosticServiceDynamicAccessList::Reserve ([SWS_DM_01163]), on the other hand, serves for a worst-case pre-allocation for service patterns, expects two parameters, and is not thread-safe.