struct ara::diag::DoIPGroupIdentification::GidStatus

Structure ara::diag::DoIPGroupIdentification::GidStatus serves as a data container for the positive response data when querying the DoIP group identification [SWS_DM_00721]. It is provided by an Adaptive Application when Diagnostic Management requests the group identification via interface GetGidStatus if DoIpInstantiation.gid is not configured [SWS_DM_00813]. The structure transports the determined GID values directly to the Diagnostic Manager for forwarding in the DoIP protocol. It is strictly limited to successful responses and contains no mechanisms for error scenarios.

more ›

Context

Data structure ara::diag::DoIPGroupIdentification::GidStatus represents the positive response data for group identification in the DoIP subsystem (Diagnostic over IP) of the AUTOSAR Adaptive Platform [SWS_DM_00721], AUTOSAR_AP_SWS_Diagnostics §8.34.2 “Struct: GidStatus”. It serves as a standardized result container for group identification data (GID) when external diagnostic clients request information on vehicle or group identification via DoIP. In the system network, three main partners interact: the external DoIP client, AUTOSAR Diagnostic Management (DM), and the application-specific Adaptive Application providing interface ara::diag::DoIPGroupIdentification. Provided that the GID is not statically stored via configuration parameter DoIpInstantiation.gid, the DM is required by specification to retrieve the GID via the application interface [SWS_DM_00813], AUTOSAR_AP_SWS_Diagnostics §8.34.1 “Providing the GID in DoIP protocol messages using application interface”.

Lifecycle

As a C++ data structure (struct), GidStatus has no independent process or service lifecycle, but functions purely as a data transfer object [SWS_DM_00721]. An instance of GidStatus is instantiated by the responsible Adaptive Application and populated with the current identification data as soon as the query method GetGidStatus is called [SWS_DM_00724], AUTOSAR_AP_SWS_Diagnostics §8.34.1.1.3.1 “GetGidStatus”. Interpretation: The structure is likely typically created as a temporary value object on the stack and passed to the DM as part of the return value via copy or move semantics, whereby its lifecycle ends after processing of the DoIP message in the DM. Question Q-4974fdbc2c6accbb (open) Because multiple diagnostic requests or parallel DoIP message processings can occur, the data held within the structure must be provided thread-safely or created isolated for each query context.

Usage Path

The typical use of GidStatus is structured into a fixed interaction sequence between the DoIP client, Diagnostic Management, and the Adaptive Application:

Sequence diagram: sequence of providing GidStatus via GetGidStatus when GID is unconfigured. Sources: [SWS_DM_00721], [SWS_DM_00724], [SWS_DM_00813].

1. An external DoIP client sends a diagnostic or identification request over the DoIP network to the vehicle.
2. Diagnostic Management checks the configuration: if DoIpInstantiation.gid is not configured, DM requests the group identification via GetGidStatus from the Adaptive Application [SWS_DM_00813], [SWS_DM_00724].
3. The Adaptive Application determines the group identification characteristics, creates an instance of GidStatus with the positive response data, and returns it to the DM [SWS_DM_00721].
4. The DM extracts the data from GidStatus and sends the complete DoIP protocol message to the external DoIP client [SWS_DM_00813].

Error Scenarios

The specification explicitly defines GidStatus as positive response data (“Response data of positive response message”) [SWS_DM_00721], AUTOSAR_AP_SWS_Diagnostics §8.34.2 “Struct: GidStatus”. Interpretation: If the Adaptive Application is unable to provide the group identification, or if an internal error occurs, a regular GidStatus instance is likely not returned; instead, method GetGidStatus is likely to signal an error to the DM via standardized platform error mechanisms (such as error codes in ara::core::Result). Question Q-01181eb14d27eeb2 (open) In addition, the context of related DoIP interfaces such as ara::diag::DoIPPowerMode [SWS_DM_00814] illustrates that the DM uses defined default or substitute values for interfaces that are not yet offered [SWS_DM_01525]; for group identification, a failure to obtain valid response data requires corresponding negative handling in the DoIP protocol, since without GID no valid positive response can be transmitted [SWS_DM_00813].