class ara::diag::SovdOperationExecution

The interface serves for application-specific control and monitoring of an ongoing SOVD operation in Diagnostic Management [SWS_DM_02197]. Via protected methods, it processes status queries as well as requests to execute special capabilities or to cancel the operation. All returns occur asynchronously via futures, with errors mandatory to be transmitted as standardized SOVD error codes according to ISO 17978-3 [SWS_DM_02384]. In addition, implementations must be thread-safe and strictly bind passed cancellation handlers to the operation lifetime.

more ›

Context

The class ara::diag::SovdOperationExecution defines the programming interface for controlling and monitoring ongoing SOVD operation executions (Service-Oriented Vehicle Diagnostics) within module diag of the AUTOSAR Adaptive Platform [SWS_DM_02197], SWS Diagnostics §8.62.5 “Class: SovdOperationExecution”. It acts as a link between Diagnostic Management (DM) and the executing application logic for diagnostics-related routines according to ASAM SOVD and ISO 17978-3.

When an external SOVD client initiates the start of an operation [SWS_DM_01396] and the optional validation of the proximity challenge has completed successfully [SWS_DM_02174], the DM instantiates or binds the execution to a unique identifier (execution-id) [SWS_DM_02177]. The DM forwards all subsequent method calls for this ongoing operation—in particular status queries and cancellation commands—to that instance of ara::diag::SovdOperationExecution that is assigned to this identifier [SWS_DM_02180].

Context diagram: Integration of SovdOperationExecution between SOVD client, Diagnostic Management, and application-specific operation logic. Sources: [SWS_DM_01396], [SWS_DM_02180], [SWS_DM_02197].

Lifecycle

The class has a default constructor declared as noexcept=default [SWS_DM_02198] as well as a virtual destructor that is likewise defined as noexcept=default [SWS_DM_02199]. Because all functional methods—ExecuteCapability [SWS_DM_02384], GetStatus [SWS_DM_02201], and Terminate [SWS_DM_02202]—are pure virtual (= 0) and protected (protected), the class cannot be directly instantiated. Interpretation: Application developers derive custom classes from SovdOperationExecution to implement the application-specific routines. Question Q-c1d622c7aa17382d (open)

Each active operation execution is assigned to a execution-id in the DM [SWS_DM_02177], [SWS_DM_02180]. The specification emphasizes that operations in many cases allow only a single concurrent instance SWS Diagnostics §7.3.3.5.5.6 “Operations – Terminate execution of an operation”. All interface methods are specified as thread-safe (thread-safe) and exception-safe (exception safe) [SWS_DM_02384], [SWS_DM_02201], [SWS_DM_02202].

Strict requirements apply with respect to memory management and lifetimes: The parameter sovd_content_data remains valid until the associated promise is fulfilled or processing has been cancelled via the cancellation_handler [SWS_DM_02384]. The object cancellation_handler itself must under no circumstances be stored or invoked beyond the lifetime of the respective operation [SWS_DM_02384], [SWS_DM_02201], [SWS_DM_02202].

Usage Path

The typical sequence for accompanying an SOVD operation is divided into the following steps:

• Request capabilities: For an ongoing operation, the DM can request actions such as execute, freeze, or reset via method ExecuteCapability [SWS_DM_02384].
• Query status: If the DM receives the SOVD call "Read the Status of an operation" and the required proximity validation succeeds [SWS_DM_02173], it calls GetStatus of the assigned SovdOperationExecution instance [SWS_DM_02180], [SWS_DM_02201]. After a successful return, the DM responds to the client with the attributes status (from GetStatusResponse.status), capability (value execute), and parameters (derived from GetStatusResponse.Parameters) [SWS_DM_02181].
• Terminate operation: If the Diagnostic Server receives the SOVD method "Terminate execution of an Operation" [SWS_DM_01392], method Terminate is called on the instance specifying the reason (TerminateOperationExecutionReason) after validation of the proximity response [SWS_DM_01391] [SWS_DM_02179], [SWS_DM_02202].

Sequence diagram: Interaction sequence between Diagnostic Management and SovdOperationExecution during status queries and controlled termination. Sources: [SWS_DM_02180], [SWS_DM_02181], [SWS_DM_02179], [SWS_DM_02202].

Error Scenarios

All methods to be executed (ExecuteCapability, GetStatus, Terminate) operate asynchronously and return a ara::core::Future [SWS_DM_02384], [SWS_DM_02201], [SWS_DM_02202]. If processing within the application fails, the future must be fulfilled with an applicable SOVD error code according to ISO 17978-3 or ASAM SOVD 1.1 [SWS_DM_02384], [SWS_DM_02201], [SWS_DM_02202].

If an ongoing request is cancelled by the diagnostics framework, the DM signals this via the provided object ara::diag::CancellationHandler [SWS_DM_02384]. The implementation must consider the cancellation state of this handler and immediately terminate processing to prevent blocking states.