DEENESPTFRRUARHIKOZHNL

klasse 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 GuideAI-GEGENEREERD

Dient voor het gericht initiëren van DoIP-voertuigaankondigingen op een opgegeven netwerkinterface.
DOOR AI GEGENEREERD ongecontroleerd Model: gemini-3.8-flash-medium · Inspanning: medium · Temperatuur: niet regelbaar · Prompt: f854d0aec1c7 Herkomst Open vragen (1)
vertaald uit de Duitse handleidinggemini-3.8-flash-low · 2026-10-13 · Duits origineel

Dient voor het gericht initiëren van DoIP-voertuigaankondigingen op een opgegeven netwerkinterface.

De klasse [SWS_DM_00820] dient ertoe dat Adaptive Applications het verzenden van DoIP-voertuigaankondigingen conform ISO 13400-2 op een specifieke netwerkinterface expliciet initiëren bij het Diagnostic Management. De toegang verloopt niet via een eigen instantiëring, maar statisch via een door het systeem beschikbaar gestelde objectreferentie ([SWS_DM_00821]). Voor interfaces met aansturing afhankelijk van een activeringslijn is de expliciete aanroep niet toegestaan, omdat de verzending daar volautomatisch plaatsvindt ([SWS_DM_00822]).

Context

De klasse ara::diag::DoIPTriggerVehicleAnnouncement ([SWS_DM_00820]) stelt in de header ara/diag/doip_trigger_vehicle_announcement.h (AUTOSAR_AP_SWS_Diagnostics §8.36.1 “Class: DoIPTriggerVehicleAnnouncement”) een API beschikbaar waarmee een Adaptive Application het gericht uitzenden van DoIP-voertuigaankondigingen („Vehicle Announcement Messages”) kan initiëren ([SWS_DM_00815], [SWS_DM_00822]).

In de DoIP-communicatie conform ISO 13400-2 is het verzenden van voertuigaankondigingen primair een interne taak van het Diagnostic Management (DM) (AUTOSAR_AP_SWS_Diagnostics §“About DiagnosticDoIPTriggerVehicleAnnouncementInterface”). De DM verzendt deze berichten standaard bij het opstarten van het netwerk als broadcast naar andere IP-regeleenheden en gateways, evenals bij detectie van de verbinding met een externe diagnosetester (AUTOSAR_AP_SWS_Diagnostics §“About DiagnosticDoIPTriggerVehicleAnnouncementInterface”). Via ara::diag::DoIPTriggerVehicleAnnouncement wordt applicaties desalniettemin de mogelijkheid geboden om deze verzending voor een specifieke netwerkinterface expliciet te laten plaatsvinden ([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)

Contextdiagram: interactiepartners bij het triggeren van DoIP-voertuigaankondigingen via de Diagnostic Manager. Bronnen: [SWS_DM_00815], [SWS_DM_00820], AUTOSAR_AP_SWS_Diagnostics §“About DiagnosticDoIPTriggerVehicleAnnouncementInterface”.

Levenscyclus

Het aanmaken en vernietigen van instanties van de klasse DoIPTriggerVehicleAnnouncement is onderworpen aan strikte voorschriften: zowel de standaardconstructor ([SWS_DM_02100]) als de destructor ([SWS_DM_02101]) zijn gedeclareerd als delete, privaat en in hun concrete vorm fabrikantspecifiek. Applicaties kunnen objecten van deze klasse zodoende noch direct instantiëren noch vernietigen.

De toegang tot de interface verloopt statisch via de functie GetDoIPTriggerVehicleAnnouncement() ([SWS_DM_00821]). Deze retourneert een ara::core::Result<std::reference_wrapper<DoIPTriggerVehicleAnnouncement>>, waardoor de aanroeper een referentie verkrijgt naar het door de DM beschikbaar gestelde service-object. Interpretatie: vanwege de private, verwijderde constructors en het retourneren van een objectreferentie wordt de klasse intern door de DM vermoedelijk als een langlevende singleton beheerd. Vraag Q-cecb961746b3ad13 (open)

Wat betreft gelijktijdigheid zijn noch de interface-query GetDoIPTriggerVehicleAnnouncement() noch de methode-aanroep TriggerVehicleAnnouncement() gespecificeerd als thread-safe („not thread-safe”) ([SWS_DM_00821], [SWS_DM_00822]). Een gelijktijdige toegang vanuit meerdere threads vereist daarom externe synchronisatie. Beide methoden zijn gespecificeerd als uitzonderingsveilig („exception safe”) ([SWS_DM_00821], [SWS_DM_00822]).

Gebruikspad

Het typische verloop voor het aanvragen van een DoIP-voertuigaankondiging bestaat uit de volgende stappen:

  1. Instantie ophalen: de applicatie roept statisch ara::diag::DoIPTriggerVehicleAnnouncement::GetDoIPTriggerVehicleAnnouncement() aan ([SWS_DM_00821]).
  2. Resultaat evalueren: het resulterende ara::core::Result wordt gecontroleerd op fouten; bij succes wordt de referentie uitgepakt.
  3. Aankondiging aanvragen: via de methode TriggerVehicleAnnouncement(networkInterfaceId) wordt de verzending op de gewenste netwerkinterface geïnitieerd ([SWS_DM_00822]).
  4. Berichtverzending door DM: de DM verwerkt het verzoek en verzendt voertuigaankondigingsberichten conform ISO 13400-2 op de door networkInterfaceId geïdentificeerde interface ([SWS_DM_00815]).
Sequentie voor het triggeren van DoIP-voertuigaankondigingenAdaptive ApplicationDoIPTriggerVehicleAnnouncementDiagnostic ManagementDoIP-NetzwerkGetDoIPTriggerVehicleAnnouncement()Result<reference_wrapper<DoIPTriggerVehicleAnnouncement>>TriggerVehicleAnnouncement(networkInterfaceId)Verzending triggerenVehicle Announcement Message (ISO 13400-2)Result<void>

Sequentiediagram: aanroepvolgorde voor het triggeren van DoIP-voertuigaankondigingen. Bronnen: [SWS_DM_00815], [SWS_DM_00821], [SWS_DM_00822].

Foutscenario's

Een cruciaal foutscenario bij het gebruik van TriggerVehicleAnnouncement betreft netwerkinterfaces die afhankelijk zijn van een activeringslijn: hoort de meegegeven networkInterfaceId bij een interfaceconfiguratie (DoIPNetworkConfiguration) waarbij de eigenschap isActivationLineDependent = TRUE is ingesteld, dan leidt de aanroep tot een fout ([SWS_DM_00822]). Op dergelijke interfaces wordt de verzending van aankondigingsberichten reeds automatisch getriggerd door de DM zodra de activeringslijn actief is en er een IP-adres is toegewezen ([SWS_DM_00816], [SWS_DM_00822]).

Voor de functies GetDoIPTriggerVehicleAnnouncement() en TriggerVehicleAnnouncement() zijn geen gestandaardiseerde foutcodes gespecificeerd ([SWS_DM_00821], [SWS_DM_00822]). Eventuele runtime-fouten of fabrikantspecifieke fouttoestanden worden getransporteerd in de geretourneerde ara::core::Result en moeten door de aanroepende applicatie worden gecontroleerd.

Deze klassenhandleiding is gegenereerd op basis van de AUTOSAR Adaptive-specificatie R25-11.

Ledenkaart

Klassendiagram

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

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

Detailweergave

Kies een item in de inhoudsopgave.

Constructors en destructor

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;

Documentatie van de methoden

functie 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#f90d38f6
Content hash
f90d38f6
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

functie 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#18233b9f
Content hash
18233b9f
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

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

DOOR AI GEGENEREERD ongecontroleerd Model: gemini-3.8-flash-medium · Inspanning: medium · Temperatuur: niet regelbaar · Prompt: fd0a2f72ec5a Herkomst Open vragen (1)
vertaald uit de Duitse handleidinggemini-3.8-flash-low · 2026-10-13 · Duits origineel

De methode TriggerVehicleAnnouncement van de interface ara::diag::DoIPTriggerVehicleAnnouncement [SWS_DM_00820] dient ertoe om het Diagnostic Management (DM) aan te zetten tot het verzenden van DoIP-voertuigaankondigingen conform ISO 13400-2 op een opgegeven netwerkinterface [SWS_DM_00815], [SWS_DM_00822].

Gebruik en semantiek

De functie accepteert de parameter networkInterfaceId (std::uint8_t), die de doelnetwerkinterface identificeert, en levert een ara::core::Result<void> terug [SWS_DM_00822]. Ze is gedeclareerd als noexcept en werpt geen excepties [SWS_DM_00822].

Foutafhandeling en randvoorwaarden

Gestandaardiseerde foutcodes zijn voor deze methode niet gedefinieerd [SWS_DM_00822]. Er is sprake van een fout wanneer de meegegeven networkInterfaceId behoort tot een netwerkconfiguratie met de eigenschap isActivationLineDependent = TRUE [SWS_DM_00822]. Op dergelijke interfaces wordt de uitzending al automatisch geïnitieerd na activering van de activeringslijn of toewijzing van het IP-adres [SWS_DM_00816], [SWS_DM_00822]. Interpretatie: Aangezien er geen gestandaardiseerde foutcodes bestaan, wordt de fout vermoedelijk gesignaleerd via een fabrikantspecifieke foutcode in het Result-object. Vraag Q-ee2ea52f0b3064ce (open)

Gelijktijdigheid en wisselwerking

De operatie is gespecificeerd als niet thread-safe (not thread-safe) [SWS_DM_00822]. Bovendien merkt de specificatie op dat de aankondiging primair een DM-interne functionaliteit vormt en dat een expliciete triggering door een Adaptive Application conceptueel eigenlijk niet is voorzien AUTOSAR_AP_SWS_Diagnostics §7.x “About DiagnosticDoIPTriggerVehicleAnnouncementInterface”.

Deze gebruiksinstructie is gegenereerd door een AI op basis van de specificatie AUTOSAR Adaptive R25-11.

Implementer's Guide volgt (complexiteit 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#1b3bbcd8
Content hash
1b3bbcd8
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

functie ~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#af07712d
Content hash
af07712d
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