DEENESPTFRRUARHIKOZHNL

class ara::shwa::Event

Diese Seite wurde vollständig KI-generiert auf Basis von SWS Safe Hardware Acceleration (R25-11) — kein offizieller AUTOSAR-Text und keine automatisch extrahierte API-Seite wie die übrigen Module. Als Interpretation gekennzeichnete Aussagen sind Schlussfolgerungen aus den Quellen.

[AP_SWS_SHWA_00601] wording not yet imported Upstream: RS_SHWA_00016

class Event final {...};

Die Spezifikation definiert diesen Klassentyp mit der gezeigten Schnittstelle.

Header-Datei#include "ara/shwa/event.h"
Scopenamespace ara::shwa

User GuideAI-GENERATED

Synchronizes applications to the completion of associated or dependent hardware accelerator tasks.
AI-GENERATED unreviewed Model: gemini-3.8-flash-medium · Effort: medium · Temperature: not controllable · Prompt: ca0070588ff8 Provenance Open questions (2)
translated from the German guidegemini-3.8-flash-low · 2026-10-13 · German original

Synchronizes applications to the completion of associated or dependent hardware accelerator tasks.

The class ara::shwa::Event serves to synchronize to the completion of hardware accelerator tasks in the shwa module [AP_SWS_SHWA_00604]. After thread-safe factory creation via Create() [AP_SWS_SHWA_00602], waiting is performed blocking or timed via non-thread-safe methods such as Wait() or WaitFor(). If an error occurs during task execution, no rollback semantics apply, which is why utilized data are considered modified unintentionally [AP_SWS_SHWA_00604].

Context

The class ara::shwa::Event functions within module shwa as a central synchronization element for hardware accelerator tasks. Its main responsibility is to synchronize to the completion of associated or dependent tasks [AP_SWS_SHWA_00604]. Interaction partners are caller-side threads and application components that coordinate asynchronous accelerator operations. Interpretation: Since the interface synchronizes task completions, a single Event object likely encapsulates the execution and synchronization signals of a specific hardware execution. Question Q-b4aa1debd356c45c (open)

Lifecycle

Instances of ara::shwa::Event are created via the static factory method Create(), which returns a ara::core::Result<Event> [AP_SWS_SHWA_00602]. This creation path is thread-safe and does not throw exceptions (noexcept, exception safe) [AP_SWS_SHWA_00602]. After creation, the object is in the active operating state and enables the querying of dependencies as well as synchronization operations.

With regard to concurrency, application components must note that all instance methods as well as the synchronization calls are explicitly specified as not thread-safe [AP_SWS_SHWA_00603], [AP_SWS_SHWA_00604], [AP_SWS_SHWA_00605], [AP_SWS_SHWA_00606]. Concurrent access by multiple threads to the same event instance or shared event lists therefore requires external synchronization. Destruction of the object occurs via regular C++ lifetime; an explicit closing or releasing method does not exist in the interface.

Usage Path

The regular sequence for synchronization is divided into object creation, optional inspection of dependencies, and the actual waiting for execution:

  1. Instantiation: The caller invokes Create() and checks the obtained ara::core::Result for success [AP_SWS_SHWA_00602].
  2. Querying dependencies: Via GetWaitList(), a list of dependent events can be read out as ara::core::Vector<Event> [AP_SWS_SHWA_00603]. Presumably, GetWaitList() functions as an inspection of upstream tasks on whose completion the event internally depends. Question Q-ed01dc595c23ce28 (open)
  3. Executing synchronization: Three variants are available for synchronization:
    • Instance-based waiting via Wait() blocks on the completion of tasks associated with the event [AP_SWS_SHWA_00604].
    • Static waiting for a group of events via Wait(eventList) synchronizes to an entire collection of Event objects [AP_SWS_SHWA_00605].
    • Timed static waiting via WaitFor(ms) limits waiting to a defined duration in milliseconds [AP_SWS_SHWA_00606].
Sequence of event synchronizationApplicationara::shwa::EventUse Case: InstanziierungCreate()ara::core::Result<Event>Use Case: Dependency check (optional)GetWaitList()ara::core::Result<Vector<Event>>Use Case: Synchronisationaltblocking wait for instanceWait()ara::core::Result<void>zeitbegrenztes WartenWaitFor(ms)ara::core::Result<void>

Sequence diagram: Typical flow from creation through dependency query to synchronization. Sources: [AP_SWS_SHWA_00602], [AP_SWS_SHWA_00603], [AP_SWS_SHWA_00604], [AP_SWS_SHWA_00606]

Error Scenarios

All methods are declared with noexcept and report error states via the return type ara::core::Result. Specific error codes occur in this process:

Special attention is required for the rollback semantics: no_rollback_semantics applies to the wait operations Wait() and Wait(eventList) [AP_SWS_SHWA_00604], [AP_SWS_SHWA_00605]. If an error occurs during task execution, the data used by the failed task must be regarded as unintentionally modified [AP_SWS_SHWA_00604], [AP_SWS_SHWA_00605], [AP_SWS_SHWA_00606].

This guide is based exclusively on the specification of the shwa module for Release R25-11.

Member map

Detail view

Select an entry in the outline.

Methods

Create function

Erzeugt beziehungsweise liefert das in der Signatur beschriebene Objekt oder Ergebnis über den angegebenen Factory-Pfad.

static ara::core::Result< Event > Create () noexcept;
GetWaitList function

Liest die durch die Signatur bezeichnete Information oder Eigenschaft aus dem Objekt.

ara::core::Result< ara::core::Vector< Event > > GetWaitList () noexcept;
Wait function 2

Synchronisiert gemäß der Signatur auf den Abschluss assoziierter oder abhängiger Aufgaben; die zeitbegrenzte Variante begrenzt das Warten.

Overloads Wait 2
static ara::core::Result< void > Wait (const ara::core::Vector< Event > &eventList) noexcept; AP_SWS_SHWA_00605
ara::core::Result< void > Wait () noexcept; AP_SWS_SHWA_00604
WaitFor function

Synchronisiert gemäß der Signatur auf den Abschluss assoziierter oder abhängiger Aufgaben; die zeitbegrenzte Variante begrenzt das Warten.

static ara::core::Result< void > WaitFor (const size_t ms) noexcept;

Details

function Create [AP_SWS_SHWA_00602] Upstream: RS_SHWA_00007, RS_SHWA_00016

static ara::core::Result< Event > Create () noexcept;

Erzeugt beziehungsweise liefert das in der Signatur beschriebene Objekt oder Ergebnis über den angegebenen Factory-Pfad.

Scopeclass ara::shwa::Event
Thread Safetythread-safe rollback_semantics
Exception Safetyexception safe
ErrorsShwaErrorCode::k Runtime General runtime error

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

Record
AUTOSAR/AP/record/AP_SWS_SHWA_00602
Status
valid/unmigrated
Version
AUTOSAR/AP/record/AP_SWS_SHWA_00602@rel:R25-11#257b2cab
Content hash
257b2cab
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_SafeHardwareAcceleration.pdf#nameddest=AP_SWS_SHWA_00602
Status: valid/unmigrated Version: rel:R25-11#257b2cab Versionshistorie & Revisions (1 transition)
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/AP_SWS_SHWA_00602@rel:R25-11#257b2cab
Point-in-Time History:
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 GetWaitList [AP_SWS_SHWA_00603] Upstream: RS_SHWA_00007, RS_SHWA_00016

ara::core::Result< ara::core::Vector< Event > > GetWaitList () noexcept;

Liest die durch die Signatur bezeichnete Information oder Eigenschaft aus dem Objekt.

Scopeclass ara::shwa::Event
Thread Safetynot thread-safe rollback_semantics ShwaErrorCode::k Runtime General runtime error rollback_semantics
Exception Safetyexception safe
ErrorsShwaErrorCode::kEvent InvalidOperation Error related to events (e.g., invalid wait on event)

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

Record
AUTOSAR/AP/record/AP_SWS_SHWA_00603
Status
valid/unmigrated
Version
AUTOSAR/AP/record/AP_SWS_SHWA_00603@rel:R25-11#3d013547
Content hash
3d013547
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_SafeHardwareAcceleration.pdf#nameddest=AP_SWS_SHWA_00603
Status: valid/unmigrated Version: rel:R25-11#3d013547 Versionshistorie & Revisions (1 transition)
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/AP_SWS_SHWA_00603@rel:R25-11#3d013547
Point-in-Time History:
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 Wait [AP_SWS_SHWA_00605] Upstream: RS_SHWA_00007, RS_SHWA_00016

static ara::core::Result< void > Wait (const ara::core::Vector< Event > &eventList) noexcept;

Synchronisiert gemäß der Signatur auf den Abschluss assoziierter oder abhängiger Aufgaben; die zeitbegrenzte Variante begrenzt das Warten.

Scopeclass ara::shwa::Event
Thread Safetynot thread-safe no_rollback_semantics ShwaErrorCode::k Runtime General runtime error. The data used within failed task execution should be considered as changed in unintended way no_rollback_semantics ShwaErrorCode::kTask ExecutionFailure Error during task execution. The data used within failed task execution should be considered as changed in unintended way no_rollback_semantics
Exception Safetyexception safe
ErrorsShwaErrorCode::kEvent InvalidOperation Error related to events (e.g., invalid wait on event)

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

Record
AUTOSAR/AP/record/AP_SWS_SHWA_00605
Status
valid/unmigrated
Version
AUTOSAR/AP/record/AP_SWS_SHWA_00605@rel:R25-11#ab1e1fa9
Content hash
ab1e1fa9
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_SafeHardwareAcceleration.pdf#nameddest=AP_SWS_SHWA_00605
Status: valid/unmigrated Version: rel:R25-11#ab1e1fa9 Versionshistorie & Revisions (1 transition)
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/AP_SWS_SHWA_00605@rel:R25-11#ab1e1fa9
Point-in-Time History:
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 Wait [AP_SWS_SHWA_00604] Upstream: RS_SHWA_00007, RS_SHWA_00016

ara::core::Result< void > Wait () noexcept;

Synchronisiert gemäß der Signatur auf den Abschluss assoziierter oder abhängiger Aufgaben; die zeitbegrenzte Variante begrenzt das Warten.

Scopeclass ara::shwa::Event
Thread Safetynot thread-safe no_rollback_semantics ShwaErrorCode::k Runtime General runtime error. The data used within failed task execution should be considered as changed in unintended way no_rollback_semantics ShwaErrorCode::kTask ExecutionFailure Error during task execution. The data used within failed task execution should be considered as changed in unintended way no_rollback_semantics
Exception Safetyexception safe
ErrorsShwaErrorCode::kEvent InvalidOperation Error related to events (e.g., invalid wait on event)

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

Record
AUTOSAR/AP/record/AP_SWS_SHWA_00604
Status
valid/unmigrated
Version
AUTOSAR/AP/record/AP_SWS_SHWA_00604@rel:R25-11#52685e47
Content hash
52685e47
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_SafeHardwareAcceleration.pdf#nameddest=AP_SWS_SHWA_00604
Status: valid/unmigrated Version: rel:R25-11#52685e47 Versionshistorie & Revisions (1 transition)
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/AP_SWS_SHWA_00604@rel:R25-11#52685e47
Point-in-Time History:
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 WaitFor [AP_SWS_SHWA_00606] Upstream: RS_SHWA_00005, RS_SHWA_00007, RS_SHWA_00016

static ara::core::Result< void > WaitFor (const size_t ms) noexcept;

Synchronisiert gemäß der Signatur auf den Abschluss assoziierter oder abhängiger Aufgaben; die zeitbegrenzte Variante begrenzt das Warten.

Scopeclass ara::shwa::Event
Thread Safetynot thread-safe rollback_semantics ShwaErrorCode::k Runtime General runtime error. The data used within failed task execution should be considered as changed in unintended way no_rollback_semantics
Exception Safetyexception safe
ErrorsShwaErrorCode::kEvent InvalidOperation Error related to events (e.g., invalid wait on event) no_rollback_semantics ShwaErrorCode::kTask ExecutionFailure Error during task execution. The data used within failed task execution should be considered as changed in unintended way no_rollback_semantics ShwaErrorCode::kTimed Out Task execution timed-out. The data used within failed task execution should be considered as changed in unintended way

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

Record
AUTOSAR/AP/record/AP_SWS_SHWA_00606
Status
valid/unmigrated
Version
AUTOSAR/AP/record/AP_SWS_SHWA_00606@rel:R25-11#2301dadd
Content hash
2301dadd
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_SafeHardwareAcceleration.pdf#nameddest=AP_SWS_SHWA_00606
Status: valid/unmigrated Version: rel:R25-11#2301dadd Versionshistorie & Revisions (1 transition)
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/AP_SWS_SHWA_00606@rel:R25-11#2301dadd
Point-in-Time History:
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