DEENESPTFRRUARHIKOZHNL

class ara::diag::DoIPTriggerVehicleAnnouncement

[SWS_DM_00820] Upstream: RS_Diag_04242

class DoIPTriggerVehicleAnnouncement {...};

DiagnosticDoIPTriggerVehicleAnnouncement.

Header-Datei#include "ara/diag/doip_trigger_vehicle_announcement.h"
Forwarding-Header#include "ara/diag/diag_fwd.h"
Scopenamespace ara::diag

User GuideKI-GENERIERT

Dient dem gezielten Anstoßen von DoIP-Fahrzeugankündigungen auf einer angegebenen Netzwerkschnittstelle.
KI-GENERIERT ungeprüft Modell: gemini-3.8-flash-medium · Aufwand: medium · Temperatur: nicht steuerbar · Prompt: f854d0aec1c7 Herkunft Offene Fragen (1)
KI-generiertgemini-3.8-flash-medium · 2026-10-13

Dient dem gezielten Anstoßen von DoIP-Fahrzeugankündigungen auf einer angegebenen Netzwerkschnittstelle.

Die Klasse [SWS_DM_00820] dient Adaptive Applications dazu, das Versenden von DoIP-Fahrzeugankündigungen gemäß ISO 13400-2 auf einer bestimmten Netzwerkschnittstelle explizit beim Diagnostic Management anzustoßen. Der Zugriff erfolgt nicht über eigene Instanziierung, sondern statisch über eine vom System bereitgestellte Objektreferenz ([SWS_DM_00821]). Für Schnittstellen mit aktivierungsleitungsabhängiger Steuerung ist der explizite Aufruf unzulässig, da der Versand dort vollautomatisch erfolgt ([SWS_DM_00822]).

Kontext

Die Klasse ara::diag::DoIPTriggerVehicleAnnouncement ([SWS_DM_00820]) stellt im Header ara/diag/doip_trigger_vehicle_announcement.h (AUTOSAR_AP_SWS_Diagnostics §8.36.1 „Class: DoIPTriggerVehicleAnnouncement“) eine API bereit, mit der eine Adaptive Application das gezielte Aussenden von DoIP-Fahrzeugankündigungen („Vehicle Announcement Messages“) anstoßen kann ([SWS_DM_00815], [SWS_DM_00822]).

In der DoIP-Kommunikation nach ISO 13400-2 ist das Versenden von Fahrzeugankündigungen primär eine interne Aufgabe des Diagnostic Management (DM) (AUTOSAR_AP_SWS_Diagnostics §„About DiagnosticDoIPTriggerVehicleAnnouncementInterface“). Der DM versendet diese Nachrichten standardmäßig beim Hochfahren des Netzwerks als Broadcast an andere IP-Steuergeräte und Gateways sowie bei Erkennung der Verbindung eines externen Diagnosetesters (AUTOSAR_AP_SWS_Diagnostics §„About DiagnosticDoIPTriggerVehicleAnnouncementInterface“). Über ara::diag::DoIPTriggerVehicleAnnouncement wird Anwendungen dennoch die Möglichkeit eröffnet, dieses Senden für eine spezifische Netzwerkschnittstelle explizit zu veranlassen ([SWS_DM_00815], [SWS_DM_00820]).

diag_kontext app Adaptive Application api ara::diag::DoIPTriggerVehicleAnnouncement app->api TriggerVehicleAnnouncement() dm Diagnostic Management (DM) api->dm Weiterleitung an DM net DoIP-Netzwerkschnittstelle dm->net Vehicle Announcement (ISO 13400-2)

Kontextdiagramm: Interaktionspartner beim Auslösen von DoIP-Fahrzeugankündigungen über den Diagnostic Manager. Quellen: [SWS_DM_00815], [SWS_DM_00820], AUTOSAR_AP_SWS_Diagnostics §„About DiagnosticDoIPTriggerVehicleAnnouncementInterface“.

Lebenszyklus

Die Erzeugung und Zerstörung von Instanzen der Klasse DoIPTriggerVehicleAnnouncement unterliegt strikten Vorgaben: Sowohl der Standardkonstruktor ([SWS_DM_02100]) als auch der Destruktor ([SWS_DM_02101]) sind als delete deklariert, privat und in ihrer konkreten Ausprägung herstellerspezifisch. Anwendungen können Objekte dieser Klasse somit weder direkt instanziieren noch zerstören.

Der Zugriff auf die Schnittstelle erfolgt statisch über die Funktion GetDoIPTriggerVehicleAnnouncement() ([SWS_DM_00821]). Diese gibt ein ara::core::Result<std::reference_wrapper<DoIPTriggerVehicleAnnouncement>> zurück, wodurch der Aufrufer eine Referenz auf das vom DM bereitgestellte Dienstobjekt erhält. Interpretation: Wegen der privaten, gelöschten Konstruktoren und der Rückgabe einer Objektreferenz dürfte die Klasse intern vom DM als langlebiges Singleton verwaltet werden. Frage Q-cecb961746b3ad13 (offen)

Hinsichtlich der Nebenläufigkeit sind weder die Schnittstellenabfrage GetDoIPTriggerVehicleAnnouncement() noch der Methodenaufruf TriggerVehicleAnnouncement() thread-sicher spezifiziert („not thread-safe“) ([SWS_DM_00821], [SWS_DM_00822]). Ein gleichzeitiger Zugriff aus mehreren Threads erfordert daher eine externe Synchronisation. Beide Methoden sind als ausnahmesicher („exception safe“) spezifiziert ([SWS_DM_00821], [SWS_DM_00822]).

Nutzungspfad

Der typische Ablauf zur Anforderung einer DoIP-Fahrzeugankündigung gliedert sich in folgende Schritte:

  1. Instanz abrufen: Die Anwendung ruft statisch ara::diag::DoIPTriggerVehicleAnnouncement::GetDoIPTriggerVehicleAnnouncement() auf ([SWS_DM_00821]).
  2. Ergebnis auswerten: Das resultierende ara::core::Result wird auf Fehler geprüft; bei Erfolg wird die Referenz entpackt.
  3. Ankündigung anfordern: Über die Methode TriggerVehicleAnnouncement(networkInterfaceId) wird der Versand auf der gewünschten Netzwerkschnittstelle angestoßen ([SWS_DM_00822]).
  4. Nachrichtenversand durch DM: Der DM verarbeitet die Anfrage und sendet Fahrzeugankündigungsnachrichten gemäß ISO 13400-2 auf der durch networkInterfaceId identifizierten Schnittstelle ([SWS_DM_00815]).
Sequenz zur Auslösung von DoIP-FahrzeugankündigungenAdaptive ApplicationDoIPTriggerVehicleAnnouncementDiagnostic ManagementDoIP-NetzwerkGetDoIPTriggerVehicleAnnouncement()Result<reference_wrapper<DoIPTriggerVehicleAnnouncement>>TriggerVehicleAnnouncement(networkInterfaceId)Versand auslösenVehicle Announcement Message (ISO 13400-2)Result<void>

Sequenzdiagramm: Aufrufreihenfolge zur Auslösung von DoIP-Fahrzeugankündigungen. Quellen: [SWS_DM_00815], [SWS_DM_00821], [SWS_DM_00822].

Fehlerszenarien

Ein zentrales Fehlerszenario bei der Nutzung von TriggerVehicleAnnouncement betrifft aktivierungsleitungsabhängige Netzwerkschnittstellen: Gehört die übergebene networkInterfaceId zu einer Schnittstellenkonfiguration (DoIPNetworkConfiguration), bei der die Eigenschaft isActivationLineDependent = TRUE gesetzt ist, führt der Aufruf zu einem Fehler ([SWS_DM_00822]). Auf solchen Schnittstellen wird der Versand von Ankündigungsnachrichten bereits automatisch durch den DM ausgelöst, sobald die Aktivierungsleitung aktiv ist und eine IP-Adresse zugewiesen wurde ([SWS_DM_00816], [SWS_DM_00822]).

Für die Funktionen GetDoIPTriggerVehicleAnnouncement() und TriggerVehicleAnnouncement() sind keine standardisierten Fehlercodes spezifiziert ([SWS_DM_00821], [SWS_DM_00822]). Etwaige Laufzeitfehler oder herstellerspezifische Fehlerzustände werden im zurückgegebenen ara::core::Result transportiert und müssen von der aufrufenden Anwendung geprüft werden.

Dieser Klassen-Leitfaden wurde auf Basis der AUTOSAR-Adaptive-Spezifikation R25-11 generiert.

Mitgliederkarte

Klassendiagramm

Hohle Dreieckspfeile = Vererbung (zeigt zur Basisklasse); Klicken öffnet die jeweilige Klassenseite.

G nara__diag__DoIPTriggerVehicleAnnouncement193 DoIPTriggerVehicleAnnouncement + GetDoIPTriggerVehicleAnnouncement() + TriggerVehicleAnnouncement() + DoIPTriggerVehicleAnnouncement() + ~DoIPTriggerVehicleAnnouncement()

Detailansicht

Wähle in der Gliederung einen Eintrag aus.

Konstruktoren und Destruktor

Ctor is vendor-specific.

DoIPTriggerVehicleAnnouncement ()=delete;

Dtor is vendor-specific.

~DoIPTriggerVehicleAnnouncement () noexcept=delete;

Methoden

Get DoIPTriggerVehicleAnnouncement interface from DM.

static ara::core::Result< std::reference_wrapper< DoIPTriggerVehicle Announcement > > GetDoIPTriggerVehicleAnnouncement () noexcept;

Called by application to trigger DM sending out vehicle announcements on the given network interface Id.

virtual ara::core::Result< void > TriggerVehicleAnnouncement (std::uint8_t networkInterfaceId) noexcept=0;

Dokumentation der Methoden

function DoIPTriggerVehicleAnnouncement [SWS_DM_02100] Upstream: RS_Diag_04242

DoIPTriggerVehicleAnnouncement ()=delete;

Ctor is vendor-specific.

Header-Datei#include "ara/diag/doip_trigger_vehicle_announcement.h"
Scopeclass ara::diag::DoIPTriggerVehicleAnnouncement
Sichtbarkeitprivate

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_DM_02100
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_DM_02100@rel:R25-11#2f98fe40
Content hash
2f98fe40
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_Diagnostics.pdf#nameddest=SWS_DM_02100
Status: valid/unmigrated Version: rel:R25-11#1d989e18 Versionshistorie & Revisions (1 transition, 3 revision)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_DM_02100@rel:R25-11#1d989e18
Point-in-Time History:
Recorded Revisions (3):
  • R25-11rel:R25-11#2f98fe402026-09-30
  • R24-11rel:R24-11#1d989e182026-10-14
  • R25-11rel:R25-11#1d989e182026-10-14 active
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function GetDoIPTriggerVehicleAnnouncement [SWS_DM_00821] Upstream: RS_Diag_04242

static ara::core::Result< std::reference_wrapper< DoIPTriggerVehicle Announcement > > GetDoIPTriggerVehicleAnnouncement () noexcept;

Get DoIPTriggerVehicleAnnouncement interface from DM.

Header-Datei#include "ara/diag/doip_trigger_vehicle_announcement.h"
Scopeclass ara::diag::DoIPTriggerVehicleAnnouncement
Exception-Sicherheitexception safe
Thread-Sicherheitnot thread-safe

Rückgabewert

TypBeschreibung
ara::core::Result<std::reference_wrapper<DoIPTriggerVehicleAnnouncement > >DoIPTriggerVehicleAnnouncement object

Fehler

FehlercodeBeschreibung
This function does not specify any standardized errors.

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_DM_00821
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_DM_00821@rel:R25-11#6119e35a
Content hash
6119e35a
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_Diagnostics.pdf#nameddest=SWS_DM_00821
Status: valid/unmigrated Version: rel:R25-11#e62d6a96 Versionshistorie & Revisions (1 transition, 8 revision)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_DM_00821@rel:R25-11#e62d6a96
Point-in-Time History:
Recorded Revisions (8):
  • R25-11rel:R25-11#6119e35a2026-09-30
  • R19-11rel:R19-11#e173afea2026-10-14
  • R20-11rel:R20-11#41c521af2026-10-14
  • R21-11rel:R21-11#41c521af2026-10-14
  • R22-11rel:R22-11#db12de522026-10-14
  • R23-11rel:R23-11#df1fdca12026-10-14
  • R24-11rel:R24-11#bfe464be2026-10-14
  • R25-11rel:R25-11#e62d6a962026-10-14 active
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function TriggerVehicleAnnouncement [SWS_DM_00822] Upstream: RS_Diag_04242

virtual ara::core::Result< void > TriggerVehicleAnnouncement (std::uint8_t networkInterfaceId) noexcept=0;

Called by application to trigger DM sending out vehicle announcements on the given network interface Id.

KI-GENERIERT ungeprüft Modell: gemini-3.8-flash-medium · Aufwand: medium · Temperatur: nicht steuerbar · Prompt: fd0a2f72ec5a Herkunft Offene Fragen (1)
KI-generiertgemini-3.8-flash-medium · 2026-10-13

Die Methode TriggerVehicleAnnouncement der Schnittstelle ara::diag::DoIPTriggerVehicleAnnouncement [SWS_DM_00820] dient dazu, das Diagnostic Management (DM) zum Versenden von DoIP-Fahrzeugankündigungen gemäß ISO 13400-2 auf einer angegebenen Netzwerkschnittstelle zu veranlassen [SWS_DM_00815], [SWS_DM_00822].

Verwendung und Semantik

Die Funktion nimmt den Parameter networkInterfaceId (std::uint8_t) entgegen, welcher die Ziel-Netzwerkschnittstelle identifiziert, und liefert ein ara::core::Result<void> zurück [SWS_DM_00822]. Sie ist als noexcept deklariert und wirft keine Ausnahmen [SWS_DM_00822].

Fehlerbehandlung und Randbedingungen

Standardisierte Fehlercodes sind für diese Methode nicht definiert [SWS_DM_00822]. Ein Fehlerfall liegt vor, wenn die übergebene networkInterfaceId zu einer Netzwerkkonfiguration mit der Eigenschaft isActivationLineDependent = TRUE gehört [SWS_DM_00822]. Auf solchen Schnittstellen wird die Aussendung bereits automatisch nach Aktivierung der Aktivierungsleitung oder IP-Adressvergabe initiiert [SWS_DM_00816], [SWS_DM_00822]. Interpretation: Da keine standardisierten Fehlercodes existieren, dürfte der Fehler über einen herstellerspezifischen Fehlercode im Result-Objekt signalisiert werden. Frage Q-ee2ea52f0b3064ce (offen)

Nebenläufigkeit und Zusammenspiel

Die Operation ist als nicht threadsicher (not thread-safe) spezifiziert [SWS_DM_00822]. Zudem merkt die Spezifikation an, dass die Ankündigung primär eine DM-interne Funktionalität darstellt und ein explizites Auslösen durch eine Adaptive Application konzeptionell eigentlich nicht vorgesehen ist AUTOSAR_AP_SWS_Diagnostics §7.x „About DiagnosticDoIPTriggerVehicleAnnouncementInterface“.

Dieser Nutzungshinweis wurde von einer KI auf Basis der Spezifikation AUTOSAR Adaptive R25-11 generiert.

Implementer's Guide folgt (Komplexität I1)

Header-Datei#include "ara/diag/doip_trigger_vehicle_announcement.h"
Scopeclass ara::diag::DoIPTriggerVehicleAnnouncement
Exception-Sicherheitexception safe
Thread-Sicherheitnot thread-safe

Parameter (in)

ParameterBeschreibung
networkInterfaceIdnetwork interface id on which a vehicle announcement shall be sent.

Rückgabewert

TypBeschreibung
ara::core::Result< void >Returns nothing or an error.

Fehler

FehlercodeBeschreibung
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.

Record
AUTOSAR/AP/record/SWS_DM_00822
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_DM_00822@rel:R25-11#b92e3a47
Content hash
b92e3a47
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_Diagnostics.pdf#nameddest=SWS_DM_00822
Status: valid/unmigrated Version: rel:R25-11#a555ed27 Versionshistorie & Revisions (1 transition, 8 revision)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_DM_00822@rel:R25-11#a555ed27
Point-in-Time History:
Recorded Revisions (8):
  • R25-11rel:R25-11#b92e3a472026-09-30
  • R19-11rel:R19-11#fc8292e52026-10-14
  • R20-11rel:R20-11#f9a672462026-10-14
  • R21-11rel:R21-11#c73179122026-10-14
  • R22-11rel:R22-11#5dc1998b2026-10-14
  • R23-11rel:R23-11#fee398c12026-10-14
  • R24-11rel:R24-11#bed5c8df2026-10-14
  • R25-11rel:R25-11#a555ed272026-10-14 active
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function ~DoIPTriggerVehicleAnnouncement [SWS_DM_02101] Upstream: RS_Diag_04242

~DoIPTriggerVehicleAnnouncement () noexcept=delete;

Dtor is vendor-specific.

Header-Datei#include "ara/diag/doip_trigger_vehicle_announcement.h"
Scopeclass ara::diag::DoIPTriggerVehicleAnnouncement
Sichtbarkeitprivate

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_DM_02101
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_DM_02101@rel:R25-11#a098acdb
Content hash
a098acdb
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_Diagnostics.pdf#nameddest=SWS_DM_02101
Status: valid/unmigrated Version: rel:R25-11#23915694 Versionshistorie & Revisions (1 transition, 3 revision)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_DM_02101@rel:R25-11#23915694
Point-in-Time History:
Recorded Revisions (3):
  • R25-11rel:R25-11#a098acdb2026-09-30
  • R24-11rel:R24-11#239156942026-10-14
  • R25-11rel:R25-11#239156942026-10-14 active
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill