class <DataIdentifier-Namespace>::<DataIdentifierInterface>

use

The constructor function <DataIdentifierInterface> serves to instantiate a data identifier from an ara::core::InstanceSpecifier [SWS_DM_00585]. The declaration takes place within namespace <DataIdentifier-Namespace> via header file #include "<DataIdentifierDirectoryPath>/<DataIdentifierShortname>.h" [SWS_DM_00585]. The synchronous call is specified as noexcept and possesses the properties "exception safe" and "thread-safe" [SWS_DM_00585].

The function accepts the following input parameters [SWS_DM_00585]:

• instanceSpec (ara::core::InstanceSpecifier): Identifier of the concrete instance of a service [SWS_DM_00585].
• concurrencyType (ara::diag::ConcurrencyType): Defines whether the interface is operated thread-safely with kConcurrent or non-thread-safely with kNotConcurrent [SWS_DM_00585].

Error Handling and Modeling Rules

The function provides no return value and throws no exceptions. Instead, errors in configuration or modeling lead to defined violations [SWS_DM_00585]:

• InstanceSpecifierMappingIntegrityViolation: The instanceSpec cannot be resolved in the context of the executable or does not refer to a PortPrototype [SWS_DM_00585].
• PortInterfaceMappingViolation: A PortPrototype typed by DiagnosticDataIdentifierInterface is not referenced by a DiagnosticDataPortMapping [SWS_DM_00585].
• ProcessMappingViolation: No matching modeled process exists for the current runtime process for the instance reference [SWS_DM_00585].
• InstanceSpecifierAlreadyInUseViolation: The constructor was called with a instanceSpec that is already in use in the current process [SWS_DM_00585].

Interpretation: Since the function is declared as noexcept, identified violations are likely treated internally by the framework as critical initialization errors. Question Q-8616025446bf33f2 (open)

Concurrency

The constructor function itself is implemented thread-safe [SWS_DM_00585]. Argument concurrencyType controls whether subsequent interface calls on the instance may occur concurrently [SWS_DM_00585].

Usage and Call Context

The synchronous method Offer() enables Diagnostic Management (DM) to forward incoming diagnostic requests to the respective instance of <DataIdentifierInterface> ([SWS_DM_00599]). The function takes no input parameters and is specified as noexcept ([SWS_DM_00599]). Interpretation: The call is likely to occur typically during the initialization phase of the application, as the DM cannot deliver requests prior to offering. Question Q-4ba81ff234a09f46 (open)

Error Handling and Return Values

ara::core::Result<void> serves as the return value ([SWS_DM_00599]). If registration was successful, the result contains no value. If the handler was already offered previously, the call fails and returns the error code DiagOfferErrc::kAlreadyOffered with rollback semantics ([SWS_DM_00599]; cf. [SWS_DM_00514]).

Concurrency and Limitations

The function ensures exception safety (exception safe), but is explicitly specified as not thread-safe (not thread-safe) ([SWS_DM_00599]). Parallel calls on the same instance must be synchronized by the application.

Interaction

The offering pattern corresponds to the uniform activation approach in the DM: Analogous Offer() methods exist for generic identifiers ([SWS_DM_00638]), data elements ([SWS_DM_00597]), routines ([SWS_DM_00557], [SWS_DM_00594]), and DoIP services ([SWS_DM_00725], [SWS_DM_00735]). As long as Offer() has not been executed, the DM does not forward any requests to the handler and responds with default values for DoIP services ([SWS_DM_01525], [SWS_DM_01527]).

use

The method Read serves to provide data of a diagnostic data identifier (DataIdentifier) in the reader role of a DiagnosticDataIdentifierInterface [SWS_DM_00640]. The call is made asynchronously by the Diagnostic Manager (DM) upon external diagnostic requests AUTOSAR_AP_SWS_Diagnostics p. 143 §7.3.2.6.1 “NRCs created by application”. As parameters, metaInfo for evaluating the request properties as well as a cancellationHandler are passed [SWS_DM_00640]. The processing application can query the cancellation status via cancellationHandler.IsCanceled() or register a callback by means of cancellationHandler.SetNotifier() in case the session is canceled prematurely [SWS_DM_00640]. The result is returned asynchronously as ara::core::Future with a ReadOutput object [SWS_DM_00640], [SWS_DM_00579].

Error handling

The function is specified as exception safe and must not propagate any exceptions to the outside [SWS_DM_00640]. If an error occurs during data retrieval, the application returns a negative return value in the ara::core::Future in the form of a matching UDS error code (NRC according to ISO 14229-1 via DiagUdsNrcErrc) or a ApApplicationError [SWS_DM_00640], AUTOSAR_AP_SWS_Diagnostics p. 143 §7.3.2.6.1 “NRCs created by application”.

Concurrency and Interaction

The interface function is not thread-safe by default [SWS_DM_00640]. Concurrent execution of read and write accesses by the Diagnostic Manager is governed by the type ara::diag::DataIdentifierConcurrencyType::readWrite, which defaults to kNotConcurrent [SWS_DM_00939]. Related read operations exist for individual data elements via DiagnosticDataElementInterface [SWS_DM_00596] as well as for generic identifiers [SWS_DM_00636].

The StopOffer method uninstalls the forwarding of incoming diagnostic requests from Diagnostic Management (DM) to the specific interface instance [SWS_DM_00600]. By issuing the call, the adaptive application signals that it is temporarily or permanently no longer available to process requests for this DataIdentifier.

Usage and Semantics

The call is synchronous, parameterless, and returns no value [SWS_DM_00600]. The generated interface file #include "<DataIdentifierDirectoryPath>/<DataIdentifierShortname>.h" must be included as the header [SWS_DM_00600]. The naming follows the pattern known from ara::com, but represents an independent interface of the diagnostic domain AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”.

Error Handling and Concurrency

• Exception safety: The function is declared with noexcept and guarantees complete exception safety (exception safe) [SWS_DM_00600]. No exceptions are thrown.
• Thread safety: The operation is specified as not thread-safe [SWS_DM_00600]. The call must be synchronized so that no parallel access to the same interface instance occurs.

Interaction

The behavior corresponds to the uniform deactivation pattern of Diagnostic Management, as also defined analogously for related interfaces such as routines [SWS_DM_00558], generic data elements [SWS_DM_00639], or download services [SWS_DM_00793]. After successful deactivation, incoming requests from the DM to this DataIdentifier are no longer forwarded to the application handler [SWS_DM_00600]; the DM is then expected to generate corresponding negative response codes. Question Q-d301740d097f9946 (open)

The interface function serves to provide a writing DataIdentifier (DID) in the role Write in a type-safe manner [SWS_DM_00598]. It is called by the Diagnostic Server instance upon incoming diagnostic requests of UDS service 0x2E (WriteDataByIdentifier) [SWS_DM_00186], provided that the DID is supported in the system and the checks of the active diagnostic session and the security level were successfully passed [SWS_DM_00415] [SWS_DM_00416] [SWS_DM_00417]. In contrast to the generic variant with raw byte span [SWS_DM_00637], the method binds model-specifically typed input parameters [SWS_DM_00598].

• Parameters: In addition to the generated input arguments, the method receives meta-information about the request via metaInfo as well as a cancellationHandler [SWS_DM_00598]. Via the cancellation handler, the application can check via IsCanceled whether the conversation was canceled, or register a notification for the cancellation case with SetNotifier [SWS_DM_00598].
• Return value and error handling: Execution is asynchronous via ara::core::Future<void> [SWS_DM_00598]. In the case of success, the future returns type void. In the error case, an applicable UDS NRC according to ISO 14229-1 via ara::diag::DiagUdsNrcErrc or a corresponding ApplicationError must be returned [SWS_DM_00598]. The function is declared as exception-safe (exception safe) [SWS_DM_00598].
• Concurrency: The method is classified as not thread-safe (not thread-safe) [SWS_DM_00598]. Whether read and write accesses may be called in parallel by Diagnostic Management is controlled via the configuration element readWrite in DataIdentifierConcurrencyType [SWS_DM_00939].