DEENESPTFRRUARHIKOZHNL

classe 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

Guide utilisateurGÉNÉRÉ PAR IA

Sert au déclenchement ciblé des annonces de véhicule DoIP sur une interface réseau spécifiée.
GÉNÉRÉ PAR IA non vérifié Modèle : gemini-3.8-flash-medium · Effort : medium · Température : non réglable · Prompt : f854d0aec1c7 Provenance Questions ouvertes (1)
traduit du guide allemandgemini-3.8-flash-low · 2026-10-13 · Original allemand

Sert au déclenchement ciblé des annonces de véhicule DoIP sur une interface réseau spécifiée.

La classe [SWS_DM_00820] sert aux Adaptive Applications à déclencher explicitement auprès du Diagnostic Management l'envoi d'annonces de véhicule DoIP conformément à l'ISO 13400-2 sur une interface réseau donnée. L'accès ne s'effectue pas via une propre instanciation, mais de manière statique via une référence d'objet fournie par le système ([SWS_DM_00821]). Pour les interfaces dotées d'une commande dépendante d'une ligne d'activation, l'appel explicite n'est pas autorisé, car l'envoi s'y déroule de manière entièrement automatique ([SWS_DM_00822]).

Contexte

La classe ara::diag::DoIPTriggerVehicleAnnouncement ([SWS_DM_00820]) fournit dans l'en-tête ara/diag/doip_trigger_vehicle_announcement.h (AUTOSAR_AP_SWS_Diagnostics §8.36.1 « Class: DoIPTriggerVehicleAnnouncement ») une API permettant à une Adaptive Application de déclencher l'émission ciblée d'annonces de véhicule DoIP (« Vehicle Announcement Messages ») ([SWS_DM_00815], [SWS_DM_00822]).

Dans la communication DoIP selon l'ISO 13400-2, l'envoi d'annonces de véhicule est principalement une tâche interne du Diagnostic Management (DM) (AUTOSAR_AP_SWS_Diagnostics §« About DiagnosticDoIPTriggerVehicleAnnouncementInterface »). Par défaut, le DM envoie ces messages sous forme de broadcast à d'autres calculateurs IP et passerelles lors du démarrage du réseau, ainsi que lors de la détection de la connexion d'un testeur de diagnostic externe (AUTOSAR_AP_SWS_Diagnostics §« About DiagnosticDoIPTriggerVehicleAnnouncementInterface »). Via ara::diag::DoIPTriggerVehicleAnnouncement, la possibilité est néanmoins offerte aux applications de déclencher explicitement cet envoi pour une interface réseau spécifique ([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)

Diagramme de contexte : partenaires d'interaction lors du déclenchement d'annonces de véhicule DoIP via le Diagnostic Manager. Sources : [SWS_DM_00815], [SWS_DM_00820], AUTOSAR_AP_SWS_Diagnostics §« About DiagnosticDoIPTriggerVehicleAnnouncementInterface ».

Cycle de vie

La création et la destruction d'instances de la classe DoIPTriggerVehicleAnnouncement sont soumises à des exigences strictes : le constructeur par défaut ([SWS_DM_02100]) ainsi que le destructeur ([SWS_DM_02101]) sont déclarés comme delete, privés et spécifiques au constructeur dans leur forme concrète. Les applications ne peuvent donc ni instancier ni détruire directement des objets de cette classe.

L'accès à l'interface s'effectue de manière statique via la fonction GetDoIPTriggerVehicleAnnouncement() ([SWS_DM_00821]). Celle-ci renvoie un ara::core::Result<std::reference_wrapper<DoIPTriggerVehicleAnnouncement>>, grâce auquel l'appelant obtient une référence vers l'objet de service fourni par le DM. Interprétation : en raison des constructeurs privés et supprimés et du renvoi d'une référence d'objet, la classe devrait être gérée en interne par le DM en tant que singleton à longue durée de vie. Question Q-cecb961746b3ad13 (ouverte)

En ce qui concerne la concurrence, ni l'interrogation d'interface GetDoIPTriggerVehicleAnnouncement() ni l'appel de méthode TriggerVehicleAnnouncement() ne sont spécifiés comme étant thread-safe (« not thread-safe ») ([SWS_DM_00821], [SWS_DM_00822]). Un accès simultané depuis plusieurs threads nécessite donc une synchronisation externe. Les deux méthodes sont spécifiées comme étant sûres vis-à-vis des exceptions (« exception safe ») ([SWS_DM_00821], [SWS_DM_00822]).

Parcours d'utilisation

Le déroulement type pour demander une annonce de véhicule DoIP se divise en plusieurs étapes :

  1. Récupérer l'instance : l'application appelle statiquement ara::diag::DoIPTriggerVehicleAnnouncement::GetDoIPTriggerVehicleAnnouncement() ([SWS_DM_00821]).
  2. Évaluer le résultat : le ara::core::Result résultant est vérifié pour détecter d'éventuelles erreurs ; en cas de succès, la référence est dépaquetée.
  3. Demander l'annonce : via la méthode TriggerVehicleAnnouncement(networkInterfaceId), l'envoi est initié sur l'interface réseau souhaitée ([SWS_DM_00822]).
  4. Envoi du message par le DM : le DM traite la demande et envoie des messages d'annonce de véhicule conformément à l'ISO 13400-2 sur l'interface identifiée par networkInterfaceId ([SWS_DM_00815]).
Séquence pour déclencher les annonces de véhicule DoIPAdaptive ApplicationDoIPTriggerVehicleAnnouncementGestion des diagnosticsDoIP-NetzwerkGetDoIPTriggerVehicleAnnouncement()Result<reference_wrapper<DoIPTriggerVehicleAnnouncement>>TriggerVehicleAnnouncement(networkInterfaceId)Déclencher l’envoiVehicle Announcement Message (ISO 13400-2)Result<void>

Diagramme de séquence : ordre d'appel pour le déclenchement d'annonces de véhicule DoIP. Sources : [SWS_DM_00815], [SWS_DM_00821], [SWS_DM_00822].

Scénarios d'erreur

Un scénario d'erreur central lors de l'utilisation de TriggerVehicleAnnouncement concerne les interfaces réseau dépendantes d'une ligne d'activation : si la networkInterfaceId transmise appartient à une configuration d'interface (DoIPNetworkConfiguration) pour laquelle la propriété isActivationLineDependent = TRUE est définie, l'appel entraîne une erreur ([SWS_DM_00822]). Sur de telles interfaces, l'envoi de messages d'annonce est déjà déclenché automatiquement par le DM dès que la ligne d'activation est active et qu'une adresse IP a été attribuée ([SWS_DM_00816], [SWS_DM_00822]).

Aucun code d'erreur standardisé n'est spécifié pour les fonctions GetDoIPTriggerVehicleAnnouncement() et TriggerVehicleAnnouncement() ([SWS_DM_00821], [SWS_DM_00822]). Les éventuelles erreurs d'exécution ou états d'erreur spécifiques au constructeur sont véhiculés dans le ara::core::Result renvoyé et doivent être vérifiés par l'application appelante.

Ce guide de classe a été généré sur la base de la spécification AUTOSAR Adaptive R25-11.

Carte des membres

Diagramme de classes

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

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

Vue détaillée

Sélectionnez une entrée dans le plan.

Constructeurs et destructeur

Ctor is vendor-specific.

DoIPTriggerVehicleAnnouncement ()=delete;

Dtor is vendor-specific.

~DoIPTriggerVehicleAnnouncement () noexcept=delete;

Méthodes

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;

Documentation des méthodes

fonction 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#1e3b504e
Content hash
1e3b504e
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

fonction 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#4f9925e6
Content hash
4f9925e6
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

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

GÉNÉRÉ PAR IA non vérifié Modèle : gemini-3.8-flash-medium · Effort : medium · Température : non réglable · Prompt : fd0a2f72ec5a Provenance Questions ouvertes (1)
traduit du guide allemandgemini-3.8-flash-low · 2026-10-13 · Original allemand

La méthode TriggerVehicleAnnouncement de l'interface ara::diag::DoIPTriggerVehicleAnnouncement [SWS_DM_00820] sert à amener le Diagnostic Management (DM) à envoyer des annonces de véhicule DoIP selon l'ISO 13400-2 sur une interface réseau spécifiée [SWS_DM_00815], [SWS_DM_00822].

Utilisation et sémantique

La fonction prend en paramètre networkInterfaceId (std::uint8_t), qui identifie l'interface réseau cible, et renvoie un ara::core::Result<void> [SWS_DM_00822]. Elle est déclarée comme noexcept et ne lève aucune exception [SWS_DM_00822].

Gestion des erreurs et conditions limites

Aucun code d'erreur standardisé n'est défini pour cette méthode [SWS_DM_00822]. Un cas d'erreur survient lorsque la networkInterfaceId transmise appartient à une configuration réseau présentant la propriété isActivationLineDependent = TRUE [SWS_DM_00822]. Sur de telles interfaces, l'émission est déjà initiée automatiquement après l'activation de la ligne d'activation ou l'attribution de l'adresse IP [SWS_DM_00816], [SWS_DM_00822]. Interprétation : comme aucun code d'erreur standardisé n'existe, l'erreur devrait être signalée par un code d'erreur propre au fabricant dans l'objet Result. Question Q-ee2ea52f0b3064ce (ouverte)

Concurrence et interaction

L'opération est spécifiée comme non sûre vis-à-vis des threads (not thread-safe) [SWS_DM_00822]. De plus, la spécification note que l'annonce constitue principalement une fonctionnalité interne au DM et qu'un déclenchement explicite par une Adaptive Application n'est conceptuellement pas prévu AUTOSAR_AP_SWS_Diagnostics §7.x « About DiagnosticDoIPTriggerVehicleAnnouncementInterface ».

Cette note d'utilisation a été générée par une IA sur la base de la spécification AUTOSAR Adaptive R25-11.

Guide de l'implémenteur à venir (complexité 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#cd405836
Content hash
cd405836
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

fonction ~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#6a7fbb18
Content hash
6a7fbb18
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