klasse ara::diag::DiagnosticSovdArrayContentElementDataView

Gebruik

De lidfunctie Clear van de klasse ara::diag::DiagnosticSovdArrayContentElementDataView maakt de volledige inhoud van een SOVD-array-element ([SWS_DM_02233]) leeg. De aanroep wordt beschikbaar gesteld via de header #include "ara/diag/diagnostic_sovd_content_element_data.h". De methode heeft de signatuur auto Clear () noexcept -> void;. Zij werkt synchroon, accepteert geen parameters en levert geen retourwaarde op ([SWS_DM_02233]).

Foutafhandeling en randvoorwaarden

Conform de specificatie is de functie gedefinieerd als uitzonderingsveilig (exception safe) en voorzien van de specificator noexcept ([SWS_DM_02233]). Zij geeft noch foutcodes noch een ara::core::Result terug. Als bindende eis geldt dat de gereferentieerde DiagnosticSovdContentElementData van het type ArrayContentElementData moet zijn ([SWS_DM_02233]). Aangezien er geen fouten worden gesignaleerd, zal de naleving van dit type vermoedelijk al tijdens de constructietijd door de view-klasse zijn gewaarborgd. Vraag Q-cdb2385e081c3456 (open)

Concurrency

De specificatie classificeert de methode uitdrukkelijk als thread-safe (thread-safe) ([SWS_DM_02233]). Aanroepen van Clear kunnen daarom zonder externe synchronisatie gelijktijdig vanuit meerdere threads plaatsvinden.

Samenspel in het diagnosesubsysteem

Binnen de SOVD-datastructuren is de bewerking nauw verbonden met andere wis-methoden:

• DiagnosticSovdContentElementData::Clear ([SWS_DM_02338]) vormt de generieke tegenhanger op elementniveau, maar geeft een ara::core::Result<void> terug en faalt wanneer het object geen array representeert.
• DiagnosticSovdRecordContentElementDataView::Clear ([SWS_DM_02276]) neemt de analoge opschoning voor datastructuren van het type RecordContentElementData resp. ContentData voor zijn rekening.
• In de klassieke foutgeheugencontext dient daarentegen ara::diag::DTCInformation::Clear ([SWS_DM_00671]) voor het asynchroon opschonen van UDS-DTC's via ara::core::Future.

Gebruik

De methode Erase van de klasse ara::diag::DiagnosticSovdArrayContentElementDataView dient voor het verwijderen van een element uit diagnostische SOVD-inhoudsgegevens ([SWS_DM_02247], SWS Diagnostics §8.60.5.1.1.8 “Erase”). Als parameter accepteert de functie een iterator van het type DiagnosticSovdArrayContentElementDataIterator, die verwijst naar het te verwijderen element. De aanroep vindt plaats als een synchrone operatie; dit volgt vermoedelijk uit de directe teruggave van ara::core::Result<void> zonder asynchroon future-patroon. Vraag Q-28de22574e525c78 (open)

Foutafhandeling en randvoorwaarden

De functie is gedeclareerd met noexcept en bezit de eigenschappen exception safe en thread-safe ([SWS_DM_02247]). Mislukt het verwijderen, dan levert de methode een fout op via de geretourneerde ara::core::Result. Dit is het geval wanneer de bovenliggende DiagnosticSovdContentElementData niet van het vereiste type ArrayContentElementData is of het element om andere redenen niet kon worden verwijderd ([SWS_DM_02247]).

Samenspel

Binnen de SOVD-interface correspondeert deze operatie met de verwijdermethode Erase van de onderliggende datacontainer DiagnosticSovdContentElementData voor array-elementen ([SWS_DM_02352]). Voor record-structuren bestaan met DiagnosticSovdRecordContentElementDataView::Erase en de overeenkomstige container-methode analoge tegenhangers ([SWS_DM_02294], [SWS_DM_02374]).

De synchrone memberfunctie PushBack dient ertoe om een signed integer-element van het type std::int64_t toe te voegen aan een arraystructuur van diagnose-SOVD-inhoudselementen ([SWS_DM_02241], AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.14 “PushBack”). Ze is in het headerbestand ara/diag/diagnostic_sovd_content_element_data.h gedeclareerd en gedefinieerd als noexcept ([SWS_DM_02241]).

Voor een succesvolle aanroep gelden de volgende voorwaarden en interfacevereisten:

• Aanroepcontext en randvoorwaarden: Het doelobject van de klasse ara::diag::DiagnosticSovdArrayContentElementDataView moet een ArrayContentElementData vertegenwoordigen, en het toe te voegen primitieve type moet overeenkomen met het in de constructor gedefinieerde elementtype ([SWS_DM_02241]).
• Retourwaarde en foutafhandeling: De functie retourneert een ara::core::Result<void>. Schiet de controle tekort omdat het onderliggende element niet van het type ArrayContentElementData is, dan bevat het resultaat een fout ([SWS_DM_02241]). Interpretation: Een discrepantie met het in de constructor voorgeschreven datatype wordt vermoedelijk analoog als fout in het resultaatobject gemeld. Vraag Q-d4715ecbd0f12d26 (open)
• Gelijktijdigheid: De functie is als thread-safe en exception-safe gespecificeerd ([SWS_DM_02241]).

De methode is onderdeel van een familie getypeerde overbelastingen binnen DiagnosticSovdArrayContentElementDataView voor unsigned integers ([SWS_DM_02242]), drijvende-kommagetallen ([SWS_DM_02243]), waarheidswaarden ([SWS_DM_02244]), tekenreeksen ([SWS_DM_02245]) en volledige gegevenselementen ([SWS_DM_02246]). Corresponderende methoden bestaan bovendien op de gegevensklasse DiagnosticSovdContentElementData zelf ([SWS_DM_02346]).

Gebruik

De synchrone API-functie PushBack van de klasse ara::diag::DiagnosticSovdArrayContentElementDataView voegt een unsigned 64-bits integerwaarde (std::uint64_t) als primitief gegevenselement toe aan het einde van een bestaand SOVD-array-element [SWS_DM_02242]. De opname vindt plaats via het headerbestand ara/diag/diagnostic_sovd_content_element_data.h SWS Diagnostics §8.60.5.1.1.15 “PushBack”. Voorwaarde voor een succesvolle aanroep is dat het huidige element een ArrayContentElementData vertegenwoordigt en de toe te voegen waarde overeenkomt met het in de constructor gedefinieerde elementtype [SWS_DM_02242].

Foutafhandeling en gelijktijdigheid

De functie signaleert haar uitvoeringsstatus via ara::core::Result<void> [SWS_DM_02242]. Is het doelobject niet van het type ArrayContentElementData, dan levert de functie een fout in het resultaat terug [SWS_DM_02242]. Aangezien er geen specifieke foutcodes worden genoemd (Interpretation: fouttoestanden worden generiek door het Result gesignaleerd), moet de aanroeper het Result-object evalueren. Vraag Q-95f2dd96e2681368 (open) De methode is gedeclareerd als noexcept, garandeert exception-veiligheid en is expliciet als thread-safe gespecificeerd [SWS_DM_02242].

Samenspel

De bewerking behoort tot een familie typespecifieke overbelastingen binnen DiagnosticSovdArrayContentElementDataView, die analoog signed integers via std::int64_t [SWS_DM_02241], drijvende-kommagetallen via double [SWS_DM_02243], waarheidswaarden via bool [SWS_DM_02244], tekenreeksen via ara::core::StringView [SWS_DM_02245] of gestructureerde elementen van het type DiagnosticSovdContentElementData [SWS_DM_02246] verwerken. Een gelijksoortige implementatie voor std::uint64_t wordt bovendien door DiagnosticSovdContentElementData beschikbaar gesteld [SWS_DM_02347].

Gebruik

De synchrone methode PushBack wordt via het headerbestand #include "ara/diag/diagnostic_sovd_content_element_data.h" in de scope van de klasse ara::diag::DiagnosticSovdArrayContentElementDataView beschikbaar gesteld ([SWS_DM_02243], AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.13 “PushBack”). Ze voegt een primitieve drijvende-kommawaarde van het type double als inhoudselement toe aan een bestaande array ([SWS_DM_02243]). De enige overdrachtsparameter is het toe te voegen gegeven content_element.

Foutafhandeling en randvoorwaarden

De functie retourneert een ara::core::Result<void> ([SWS_DM_02243]). Een succesvolle uitvoering vereist dat het huidige element van het type ArrayContentElementData is en het toe te voegen element overeenkomt met het type dat in de constructor van ArrayContentElementData is vastgelegd ([SWS_DM_02243]). Voor zover het doel niet van het type ArrayContentElementData is, mislukt de bewerking en retourneert deze een fout in het Result ([SWS_DM_02243]).

Concurrency

De functie is gedeclareerd als noexcept, waarborgt exception-veiligheid (exception safe) en is volgens de specificatie thread-safe ([SWS_DM_02243]). Meerdere threads kunnen de functie daarom gelijktijdig zonder externe synchronisatie aanroepen.

Samenspel

Binnen DiagnosticSovdArrayContentElementDataView bestaan typegelijke overbelastingen voor verdere primitieve datatypes, waaronder std::int64_t ([SWS_DM_02241]), std::uint64_t ([SWS_DM_02242]), bool ([SWS_DM_02244]), ara::core::StringView ([SWS_DM_02245]) evenals voor volledige DiagnosticSovdContentElementData-objecten ([SWS_DM_02246]). Analoge methoden staan ook op DiagnosticSovdContentElementData ter beschikking (bijv. [SWS_DM_02348]).

De elementfunctie PushBack dient ertoe om een DiagnosticSovdContentElementData met het primitieve datatype bool toe te voegen aan een bestaand array-element ([SWS_DM_02244]). De interface is in de header ara/diag/diagnostic_sovd_content_element_data.h binnen de klasse ara::diag::DiagnosticSovdArrayContentElementDataView gedefinieerd (AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.12 “PushBack”). Als invoerparameter neemt de synchrone functie de waarheidswaarde content_element aan ([SWS_DM_02244]).

Voorwaarde voor de aanroep is dat het huidige element van het type ArrayContentElementData is en de toe te voegen waarde overeenkomt met het type dat in de constructor van de datastructuur is gedeclareerd ([SWS_DM_02244]). Is het doelelement niet van het type ArrayContentElementData, dan mislukt de bewerking en retourneert deze een ara::core::Result<void> met een bijbehorende fout; bij succes bevat het resultaat een lege void ([SWS_DM_02244]).

Wat betreft de uitvoeringsveiligheid is de methode als noexcept gedeclareerd evenals als thread-safe (thread-safe) en exception-veilig (exception safe) gespecificeerd ([SWS_DM_02244]).

De methode is onderdeel van een familie getypeerde PushBack-overbelastingen binnen DiagnosticSovdArrayContentElementDataView. Naast booleaanse waarden dekken zusterfuncties het invoegen van integertypes zoals std::int64_t ([SWS_DM_02241]) en std::uint64_t ([SWS_DM_02242]), drijvende-kommawaarden double ([SWS_DM_02243]), tekenreeksen ara::core::StringView ([SWS_DM_02245]) evenals complexe gegevenselementen ([SWS_DM_02246]) af. Corresponderende bewerkingen staan bovendien op het niveau van DiagnosticSovdContentElementData ter beschikking, waaronder de booleaanse variant [SWS_DM_02349].

Gebruik

De synchrone elementfunctie PushBack van de klasse ara::diag::DiagnosticSovdArrayContentElementDataView ([SWS_DM_02245], gedefinieerd in SWS Diagnostics §8.60.5.1.1.11 “PushBack”) voegt een nieuw element met het primitieve type tekenreeks toe aan een diagnostische SOVD-array. Hiervoor moet de header ara/diag/diagnostic_sovd_content_element_data.h worden ingevoegd. De functie ontvangt het toe te voegen element via de parameter content_element van het type ara::core::StringView.

Foutafhandeling

Als retourtype dient ara::core::Result<void>. Er wordt een fout geretourneerd in het resultaatobject als het huidige object niet van het type ArrayContentElementData is of als het type van het doorgegeven element niet overeenkomt met het in de constructor van ArrayContentElementData vastgelegde elementtype ([SWS_DM_02245]).

Gelijktijdigheid en beperkingen

De functie is gedeclareerd met de specificator noexcept. Zij biedt gegarandeerde exception-veiligheid (exception safe) en is onbeperkt thread-veilig (thread-safe) gespecificeerd ([SWS_DM_02245]).

Samenspel

De bewerking maakt deel uit van een familie overbelaste methoden. Binnen DiagnosticSovdArrayContentElementDataView bestaan verdere overbelastingen voor scalaire typen zoals std::int64_t ([SWS_DM_02241]), std::uint64_t ([SWS_DM_02242]), double ([SWS_DM_02243]) en bool ([SWS_DM_02244]), evenals voor volledige elementen van het type DiagnosticSovdContentElementData ([SWS_DM_02246]). Bovendien stelt ook de klasse ara::diag::DiagnosticSovdContentElementData een overeenkomstige PushBack-interface voor tekenreeksen beschikbaar ([SWS_DM_02350]).

Gebruik

De synchrone memberfunctie PushBack van de klasse ara::diag::DiagnosticSovdArrayContentElementDataView (SWS Diagnostics §8.60.5.1.1.10 “PushBack”) voegt een element van het type DiagnosticSovdContentElementData toe aan een bestaande array-gegevensweergave ([SWS_DM_02246]). Als overdrachtsparameter neemt ze het toe te voegen object content_element by value over en heeft ze geen retourwaarde (void). De declaratie wordt via het headerbestand ara/diag/diagnostic_sovd_content_element_data.h beschikbaar gesteld.

Gelijktijdigheid en randvoorwaarden

De specificatie definieert de functie als exception-veilig (exception safe), thread-safe (thread-safe) en geannoteerd met noexcept ([SWS_DM_02246]). Als bindende randvoorwaarde vereist de bewerking dat het huidige element van het type ArrayContentElementData is en het toe te voegen element exact overeenkomt met het type dat in de constructor van ArrayContentElementData is vastgelegd ([SWS_DM_02246]).

Foutafhandeling en wisselwerking

In tegenstelling tot de overbelastingen voor primitieve types zoals std::int64_t ([SWS_DM_02241]), std::uint64_t ([SWS_DM_02242]), double ([SWS_DM_02243]), bool ([SWS_DM_02244]) of ara::core::StringView ([SWS_DM_02245]), die een ara::core::Result<void> voor foutoverdracht retourneren, levert deze methode void. Het ligt daarom vermoedelijk in de verantwoordelijkheid van de aanroeper om de typecompatibiliteit vooraf te controleren, aangezien runtimefouten aan deze interface niet via een Result-type worden gesignaleerd. Vraag Q-00739dff7d34e242 (open) Een equivalente methode voor het toevoegen van gegevenselementen is ook op DiagnosticSovdContentElementData gedefinieerd ([SWS_DM_02351]).

De synchrone methode Reserve van de klasse ara::diag::DiagnosticSovdArrayContentElementDataView dient voor de vooraf-allocatie van geheugencapaciteit voor array-gegevenselementen ([SWS_DM_02240], SWS Diagnostics §8.60.5.1.1.16 “Reserve”). Zij wordt beschikbaar gesteld via de header #include "ara/diag/diagnostic_sovd_content_element_data.h" en accepteert de parameter capacity van het type std::size_t, die de beschikbaar te stellen capaciteit van de onderliggende DiagnosticSovdArrayContentElementData vastlegt ([SWS_DM_02240]). Een retourwaarde wordt niet teruggegeven ([SWS_DM_02240]).

Wat betreft foutafhandeling is de functie gedeclareerd als uitzonderingsveilig (exception safe) en noexcept ([SWS_DM_02240]). Zij maakt noch gebruik van foutcodes via ara::core::Result noch van C++-exceptions. Interpretatie: Bij een geheugentekort zal de allocatie intern vermoedelijk mislukken of tot een programmastop leiden, aangezien er voor de aanroeper geen foutkanaal beschikbaar is. Vraag Q-348805197c004eea (open)

Voor gelijktijdigheid is de bewerking expliciet als thread-safe (thread-safe) gespecificeerd ([SWS_DM_02240]). Aanroepen kunnen zodoende zonder externe vergrendeling vanuit parallelle threads plaatsvinden.

In het totale systeem vult de interface verwante reserveringsfuncties aan: terwijl DiagnosticSovdRecordContentElementDataView::Reserve analoog verantwoordelijk is voor record-datastructuren ([SWS_DM_02283], SWS Diagnostics §8.60.11.1.1.20 “Reserve”), levert de algemene basisklassefunctie DiagnosticSovdContentElementData::Reserve een ara::core::Result<void> op om bij een onjuist elementtype een fout te melden ([SWS_DM_02345], SWS Diagnostics §8.60.6.1.2.55 “Reserve”). In tegenstelling tot de niet-thread-safe geheugenreservering DiagnosticServiceDynamicAccessList::Reserve ([SWS_DM_01163], SWS Diagnostics §8.13.1.1.3.3 “Reserve”) werkt deze view-methode direct en gelijktijdig op SOVD-array-elementen.