struct ara::diag::SovdSwUpdate::UpdatePackageStatus

The ara::diag::SovdSwUpdate::UpdatePackageStatus structure provides status, phase, and progress information of a software update process for SOVD diagnostic applications [SWS_DM_01902]. It is obtained by calling GetUpdatePackageStatus and enables the continuous monitoring of execution phases, percentage progress, as well as individual steps. In the event of an error, the structure signals the failure and conveys the exact error code from the DiagSovdErrc domain via the optional error field [SWS_DM_01909]. As a pure data transfer object, the structure presumably requires application-side synchronization in the event of concurrent access. Question Q-1d228b6cab1b505e (open)

more ›

Context

The ara::diag::SovdSwUpdate::UpdatePackageStatus data structure is part of the diag module of the AUTOSAR Adaptive Platform SWS Diagnostics §8.58.5 “Struct: UpdatePackageStatus” [SWS_DM_01902]. Within the scope of Service-Oriented Vehicle Diagnostics (SOVD), it acts as a standardized information carrier for acquiring and providing the current state of a software update package. Via the API function ara::diag::SovdSwUpdate::GetUpdatePackageStatus, the status object is generated by the diagnostic interface and passed to querying instances SWS Diagnostics §8.58.2.1.3.5 “GetUpdatePackageStatus” [SWS_DM_01921].

Within the system architecture, the structure serves as a decoupling element between the executing service component SovdSwUpdate and external or internal diagnostic clients. While the service controls the actual package processing and installation, UpdatePackageStatus encapsulates a snapshot of processing phases, progress, and possible error states [SWS_DM_01902].

Lifecycle

As a pure data container (struct), UpdatePackageStatus has no internal state logic of its own and does not perform autonomous resource management SWS Diagnostics §8.58.5 “Struct: UpdatePackageStatus” [SWS_DM_01902]. Instances are created during the call to GetUpdatePackageStatus, populated with the current status values, and returned by value to the caller [SWS_DM_01921]. The lifetime is bound to the scope of the receiver and ends with its destruction.

Although the C++ object is passive, its member variables represent the lifecycle of the underlying update process. The field phase of type SovdUpdatePhase describes the current phase of the overall process SWS Diagnostics §8.58.5.1.2 “phase” [SWS_DM_01903], while the variable status of type SovdUpdateStatus indicates the concrete state of this phase SWS Diagnostics §8.58.5.1.4 “status” [SWS_DM_01904]. Since no internal mutexes or synchronization mechanisms are specified, concurrent access to the same instance requires external protection by the user.

Usage Path

The typical usage path comprises cyclic or event-triggered monitoring of a package update by a diagnostic client:

• Status query: The client calls method GetUpdatePackageStatus on interface SovdSwUpdate SWS Diagnostics §8.58.2.1.3.5 “GetUpdatePackageStatus” [SWS_DM_01921].
• Phase and status evaluation: After receiving object [SWS_DM_01902], the client inspects variables phase [SWS_DM_01903] and status [SWS_DM_01904] to determine whether the sequence is proceeding regularly or has finished.
• Progress analysis: If an overall progress percentage is available, it is evaluated via the optional member progress SWS Diagnostics §8.58.5.1.3 “progress” [SWS_DM_01905]. Additional subphases can be inspected via vector subprogress [SWS_DM_01906].
• Step display: For logging or user guidance, the textual step designation step [SWS_DM_01907] as well as the localization key step_translation_id are used [SWS_DM_01908].

Sequence diagram: Call sequence for status query and evaluation of member variables of an UpdatePackageStatus. Sources: [SWS_DM_01921], [SWS_DM_01902], [SWS_DM_01904], [SWS_DM_01909].

Error Scenarios

Errors in the update sequence are made transparent via specific attributes of the data structure:

• Failed status: If the process encounters a problem, field status assumes the state “failed” [SWS_DM_01904].
• Error detail: In this error case, field error of type ara::core::Optional<ara::diag::DiagSovdErrc> specifies the error code that occurred SWS Diagnostics §8.58.5.1.1 “error” [SWS_DM_01909].
• Regular sequence: Unless an error has occurred, the optional field error presumably remains unset, as it is explicitly tied to the “failed” state according to the specification [SWS_DM_01909]. Question Q-c26d1c1d25d7e938 (open)
• Interface error: If API call GetUpdatePackageStatus fails at the platform level, a platform-specific error state is presumably returned instead of a status object [SWS_DM_01921]. Question Q-b029f911ee738cb1 (open)