Used for specifically triggering DoIP vehicle announcements on a specified network interface.
AI-GENERATEDunreviewedModel: gemini-3.8-flash-medium · Effort: medium · Temperature: not controllable · Prompt: f854d0aec1c7ProvenanceOpen questions (1)
translated from the German guidegemini-3.8-flash-low · 2026-10-13 · German original
Used for specifically triggering DoIP vehicle announcements on a specified network interface.
The class [SWS_DM_00820] is used by Adaptive Applications to explicitly trigger the sending of DoIP vehicle announcements according to ISO 13400-2 on a specific network interface with Diagnostic Management. Access is not performed via proprietary instantiation, but statically via an object reference provided by the system ([SWS_DM_00821]). For interfaces with activation line-dependent control, explicit invocation is not permitted because sending occurs fully automatically there ([SWS_DM_00822]).
The creation and destruction of instances of class DoIPTriggerVehicleAnnouncement are subject to strict requirements: Both the default constructor ([SWS_DM_02100]) and the destructor ([SWS_DM_02101]) are declared as delete, private, and vendor-specific in their concrete design. Applications can therefore neither directly instantiate nor destroy objects of this class.
Access to the interface takes place statically via the function GetDoIPTriggerVehicleAnnouncement() ([SWS_DM_00821]). This returns a ara::core::Result<std::reference_wrapper<DoIPTriggerVehicleAnnouncement>>, providing the caller with a reference to the service object provided by the DM. Interpretation: Due to the private, deleted constructors and the return of an object reference, the class is likely managed internally by the DM as a long-lived singleton. Question Q-cecb961746b3ad13 (open)
Regarding concurrency, neither the interface query GetDoIPTriggerVehicleAnnouncement() nor the method invocation TriggerVehicleAnnouncement() are specified as thread-safe (“not thread-safe”) ([SWS_DM_00821], [SWS_DM_00822]). Concurrent access from multiple threads therefore requires external synchronization. Both methods are specified as exception-safe (“exception safe”) ([SWS_DM_00821], [SWS_DM_00822]).
Usage Path
The typical sequence for requesting a DoIP vehicle announcement is divided into the following steps:
Retrieve instance: The application statically calls ara::diag::DoIPTriggerVehicleAnnouncement::GetDoIPTriggerVehicleAnnouncement() ([SWS_DM_00821]).
Evaluate result: The resulting ara::core::Result is checked for errors; on success, the reference is unwrapped.
Request announcement: Transmission on the desired network interface is triggered via method TriggerVehicleAnnouncement(networkInterfaceId) ([SWS_DM_00822]).
Message transmission by DM: The DM processes the request and sends vehicle announcement messages according to ISO 13400-2 on the interface identified by networkInterfaceId ([SWS_DM_00815]).
A central error scenario when using TriggerVehicleAnnouncement concerns activation line-dependent network interfaces: If the passed networkInterfaceId belongs to an interface configuration (DoIPNetworkConfiguration) in which property isActivationLineDependent = TRUE is set, the call results in an error ([SWS_DM_00822]). On such interfaces, the transmission of announcement messages is already triggered automatically by the DM as soon as the activation line is active and an IP address has been assigned ([SWS_DM_00816], [SWS_DM_00822]).
No standardized error codes are specified for the functions GetDoIPTriggerVehicleAnnouncement() and TriggerVehicleAnnouncement() ([SWS_DM_00821], [SWS_DM_00822]). Any runtime errors or vendor-specific error states are transported in the returned ara::core::Result and must be checked by the calling application.
This class guide was generated based on the AUTOSAR Adaptive specification R25-11.
Called by application to trigger DM sending out vehicle announcements on the given network interface Id.
AI-GENERATEDunreviewedModel: gemini-3.8-flash-medium · Effort: medium · Temperature: not controllable · Prompt: fd0a2f72ec5aProvenanceOpen questions (1)
translated from the German guidegemini-3.8-flash-low · 2026-10-13 · German original
Method TriggerVehicleAnnouncement of interface ara::diag::DoIPTriggerVehicleAnnouncement[SWS_DM_00820] serves to cause Diagnostic Management (DM) to send DoIP vehicle announcements in accordance with ISO 13400-2 on a specified network interface [SWS_DM_00815], [SWS_DM_00822].
Usage and Semantics
The function accepts the parameter networkInterfaceId (std::uint8_t), which identifies the destination network interface, and returns a ara::core::Result<void>[SWS_DM_00822]. It is declared as noexcept and throws no exceptions [SWS_DM_00822].
Error Handling and Boundary Conditions
Standardized error codes are not defined for this method [SWS_DM_00822]. An error case occurs if the passed networkInterfaceId belongs to a network configuration with property isActivationLineDependent = TRUE[SWS_DM_00822]. On such interfaces, transmission is already initiated automatically after activation of the activation line or IP address assignment [SWS_DM_00816], [SWS_DM_00822]. Interpretation: Since no standardized error codes exist, the error is likely signaled via a manufacturer-specific error code in the Result object. Question Q-ee2ea52f0b3064ce (open)
This function does not specify any standardized errors.
Hinweise: If the reported DoIPNetworkConfiguration.networkInterfaceId belongs to a DoIPNetwork Configuration with property isActivationLineDependent = TRUE, this is an error as on those interfaces sending of announcements happens automatically after activation line going up/IP address assignment.
Request a governed re-review of this record. The record is not changed immediately.
gemini-3.8-flash-low· 2026-10-13 · German original