class ara::com::ServiceVersionType

Class ara::com::ServiceVersionType serves for the standardized representation and management of service versions in the AUTOSAR Adaptive Platform ([SWS_CM_11515]). Applications use the instances for compatibility checks via equality and ordering comparisons, for storage in containers, and for logging via ToString() ([SWS_CM_11519]). The exact type may be overridden by the Communication Management provider, but must satisfy elementary C++ comparison and assignment requirements. When using it, note that all member functions of the class are specificationally classified as not exception-safe.

more ›

Context

Class ara::com::ServiceVersionType defines the version of a communication service ([SWS_CM_11515]) in header ara/com/service/service_version.h (AUTOSAR_AP_SWS_CommunicationManagement §8.11 “Header: ara/com/service/service_version.h”). Its primary responsibility is to make service versions manageable for application software so that it can store, manage, compare, and log version information ([SWS_CM_11515]).

An architectural characteristic lies in the platform's flexibility: according to [SWS_CM_11515], the concrete data type may be overridden or extended by the software provider of Communication Management. To nevertheless ensure consistent handling in portable applications, the specification requires that the type satisfy at least the C++ standard concepts [equalitycomparable] ([SWS_CM_11516]), [lessthancomparable] ([SWS_CM_11517]), and [copyassignable] ([SWS_CM_11518]) in accordance with ISO/IEC 14882:2014.

Interaction partners include not only the Communication Management software provider, but also service interfaces that provide versions as static constant serviceVersion (AUTOSAR_AP_SWS_CommunicationManagement p. 320), as well as the application software that performs version comparisons.

Context diagram: embedding of ara::com::ServiceVersionType between software provider, service interface, and application. Sources: [SWS_CM_11515], AUTOSAR_AP_SWS_CommunicationManagement p. 320, AUTOSAR_AP_SWS_CommunicationManagement §8.11.1 “Class: ServiceVersionType”.

Lifecycle

Instances of ara::com::ServiceVersionType are designed as regular value types. Creation and value transfer take place via copy and assignment: the assignment operator operator= satisfies the requirement [copyassignable] ([SWS_CM_11518]), allowing instances to take on new values.

In terms of ownership, ara::com::ServiceVersionType is subject to the scope of the respective caller or is maintained as a constant of a service definition (AUTOSAR_AP_SWS_CommunicationManagement p. 320). The type possesses no complex internal state machine, but encapsulates a discrete version value. Its destruction occurs automatically upon leaving scope.

Regarding concurrency, the read operations operator== ([SWS_CM_11516]), operator< ([SWS_CM_11517]), and ToString ([SWS_CM_11519]) are declared as const. Interpretation: Concurrent read accesses to the same instance from multiple threads are likely safe without synchronization, whereas parallel write and assignment operations must be protected externally. Question Q-9582ce9a82b9b833 (open)

Usage Path

The typical sequence for using ara::com::ServiceVersionType in an application is structured into the following steps:

1. Version query: The application accesses the version information of a service, for example via the static constant serviceVersion of an interface (AUTOSAR_AP_SWS_CommunicationManagement p. 320).
2. Compatibility check: The application compares the version with an expected version via operator== ([SWS_CM_11516]). For ordering checks or storage in sorted standard containers, operator< is used ([SWS_CM_11517]).
3. Management and storage: To pass on or locally store version states, the application uses the assignment operator operator= ([SWS_CM_11518]).
4. Logging: For diagnostic messages or log outputs, the application generates a textual representation as ara::core::StringView via method ToString() ([SWS_CM_11519], AUTOSAR_AP_SWS_CommunicationManagement §8.11.1.1.2.1 “ToString”).

Error Scenarios

When using the interface, specific constraints must be observed:

• Exception safety: All specified functions—operator= ([SWS_CM_11518]), operator== ([SWS_CM_11516]), operator< ([SWS_CM_11517]), and ToString ([SWS_CM_11519])—are explicitly declared as not exception safe in the specification. In case of an error (such as during memory allocations in provider-specific implementations), applications must not rely on automatic recovery guarantees.
• Validity of the string view: Method ToString() returns a ara::core::StringView ([SWS_CM_11519]). Interpretation: Since a StringView does not manage its own storage, the lifetime of the referenced character string is likely coupled to the underlying instance or to static storage; use beyond the validity of the data source leads to undefined behavior. Question Q-fdb6e821db46af00 (open)