klasse ara::diag::DiagnosticSovdRecordContentElementDataView

Gebruik

De synchrone functie [SWS_DM_02288] voegt een signed integerwaarde (std::int64_t) onder de aangegeven sleutel key (ara::core::StringView) in een SOVD-datastructuur in. Ze is als methode van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView gedeclareerd en via de header ara/diag/diagnostic_sovd_content_element_data.h ingevoegd.

Voorwaarden en foutafhandeling

Volgens [SWS_DM_02288] moet het onderliggende DiagnosticSovdContentElementData-object van het type RecordContentElementData of ContentData zijn, terwijl het toe te voegen element zelf geen ContentData mag zijn. De functie is gedefinieerd als noexcept en levert een ara::core::Result<void> terug. Schiet de bewerking tekort – bijvoorbeeld omdat de doelcontainer een incompatibel type heeft of het element niet kan worden toegevoegd –, dan bevat het resultaat een foutcode; Interpretation: Dit zal doorgaans ook het geval zijn bij sleutelconflicten. Vraag Q-524c832a794559b7 (open)

Gelijktijdigheid en wisselwerking

De uitvoering is als thread-safe en exception-veilig gespecificeerd [SWS_DM_02288]. Binnen de interface bestaan typegelijke overbelastingen voor unsigned integers ([SWS_DM_02289]), drijvende-kommagetallen ([SWS_DM_02290]), booleaanse waarden ([SWS_DM_02291]), tekenreeksen ([SWS_DM_02292]) en geneste gegevenselementen ([SWS_DM_02293]). Dezelfde methode wordt bovendien op de dragerklasse DiagnosticSovdContentElementData beschikbaar gesteld ([SWS_DM_02368]).

De synchrone memberfunctie Add van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView dient voor het toevoegen van een niet-ondertekende 64-bits geheel getal-waarde onder een vooraf bepaalde sleutel ([SWS_DM_02289]). Zij wordt gebruikt in het kader van de SOVD-functionaliteit van Diagnostic Management, die diagnosecommunicatie conform ASAM SOVD verschaft (AUTOSAR_AP_SWS_Diagnostics §1.0 “Introduction and functional overview”, [SWS_DM_01369]).

Gebruik en aanroep

De methode wordt ingevoegd via de header ara/diag/diagnostic_sovd_content_element_data.h. Als parameters verwacht zij de identifier key als ara::core::StringView en de toe te voegen waarde content_element als std::uint64_t ([SWS_DM_02289]). De aanroep verloopt synchroon, is gespecificeerd als noexcept en retourneert het resultaat in de vorm van ara::core::Result<void>.

Foutafhandeling en randvoorwaarden

• Typevoorwaarden: De geïnstantieerde DiagnosticSovdContentElementData moet ofwel van het type RecordContentElementData of ContentData zijn. Bovendien mag het toe te voegen element zelf niet van het type ContentData zijn ([SWS_DM_02289]).
• Foutgedrag: Als een van deze typevereisten wordt geschonden of het element niet kan worden toegevoegd, retourneert de functie een foutief ara::core::Result ([SWS_DM_02289]). Specifieke foutcodes noemt de specificatie op deze plaats niet; vermoedelijk levert het Result-object een overeenkomstige foutcode van het diagnosedomein op. Vraag Q-ffca131eece93b35 (open)
• Gelijktijdigheid: De functie is expliciet gespecificeerd als thread-safe en exception safe ([SWS_DM_02289]).

Samenspel

De methode behoort tot een familie getypeerde overbelastingen voor het registreren van primitieve en complexe gegevenselementen, waaronder varianten voor getekende gehele getallen ([SWS_DM_02288]) en gestructureerde subelementen ([SWS_DM_02293]). Een gelijkwaardige interface wordt parallel aangeboden op de klasse DiagnosticSovdContentElementData ([SWS_DM_02369]).

De synchrone lidfunctie Add van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView voegt een primitieve drijvende-kommawaarde van het type double onder de opgegeven sleutel key toe aan een record [SWS_DM_02290]. De functie dient voor het opbouwen van gestructureerde diagnosegegevens voor de SOVD-serverfunctionaliteit van Diagnostic Management [SWS_DM_01369].

Voor de uitvoering gelden de volgende typegebonden voorwaarden [SWS_DM_02290]:

• Het doelobject moet van het type RecordContentElementData of ContentData zijn.
• Het toe te voegen element mag zelf niet van het type ContentData zijn.

De methode is gedeclareerd als noexcept (exception safe) en voor gelijktijdige toegang gespecificeerd als thread-veilig (thread-safe) [SWS_DM_02290]. Mislukt het toevoegen – bijvoorbeeld doordat het objecttype incompatibel is of het element niet kan worden ingevoegd –, dan wordt een fout gemeld via de geretourneerde ara::core::Result<void> [SWS_DM_02290]. Interpretatie: de exacte foutoorzaak wordt daarbij vermoedelijk weergegeven in de ara::core::ErrorCode van het Result-object. Vraag Q-c987f75d785d3e90 (open)

In combinatie met de verwante overbelastingen van Add maakt de methode het gestructureerd vullen van SOVD-records mogelijk met geheeltallige waarden ([SWS_DM_02288], [SWS_DM_02289]), booleaanse waarden [SWS_DM_02291], tekenreeksen [SWS_DM_02292] of complexere elementgegevens [SWS_DM_02293].

De functie Add van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView dient voor het toevoegen van een booleaanse primitieve waarde onder een opgegeven sleutel aan een SOVD-gegevenselement [SWS_DM_02291]. De aanroep vindt plaats via het headerbestand ara/diag/diagnostic_sovd_content_element_data.h met de parameternaam key van het type ara::core::StringView evenals de payloadwaarde content_element van het type bool [SWS_DM_02291]. Aangezien de methode onmiddellijk een ara::core::Result<void> retourneert en er geen asynchroniciteit is gespecificeerd, verloopt de operatie vermoedelijk synchroon. Vraag Q-a16b08bf68f8590b (open)

De foutafhandeling verloopt via de geretourneerde ara::core::Result<void>. Er wordt een fout teruggemeld wanneer het onderliggende DiagnosticSovdContentElementData noch van het type RecordContentElementData noch van het type ContentData is, of wanneer het element niet kan worden toegevoegd [SWS_DM_02291]. Specifieke foutcodes zijn in het specificatiefragment niet nader vermeld.

Wat betreft gelijktijdigheid en uitvoeringsveiligheid is de methode geclassificeerd als thread-safe en biedt deze uitzonderingsveiligheid (noexcept) [SWS_DM_02291]. Als structurele beperking eist de specificatie dat het toe te voegen element zelf niet van het type ContentData mag zijn [SWS_DM_02291].

In het totale systeem vult deze methode verwante overbelastingen aan voor gehele getallen met teken [SWS_DM_02288], gehele getallen zonder teken [SWS_DM_02289], drijvende-kommagetallen [SWS_DM_02290], tekenreeksen [SWS_DM_02292] en onderliggende inhoudselementen [SWS_DM_02293]. Bovendien bestaat de analoge interface aan de klasse DiagnosticSovdContentElementData [SWS_DM_02371] in de context van de SOVD-serverfunctionaliteit van het Diagnostic Management [SWS_DM_01369].

Gebruik

De synchrone methode Add van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView dient voor het toevoegen van een item met een sleutel en een primitieve tekenreekswaarde aan een SOVD-gegevenselement [SWS_DM_02292]. De aanroep geschiedt via de twee parameters key en content_element, die elk als ara::core::StringView worden doorgegeven [SWS_DM_02292]. Als retourwaarde levert de functie een ara::core::Result<void> op ter signalering van het operatieresultaat [SWS_DM_02292].

Foutafhandeling

Mislukt het toevoegen, dan retourneert de methode een fout in de ara::core::Result [SWS_DM_02292]. Dit treedt op wanneer het onderliggende object niet van het type RecordContentElementData of ContentData is of wanneer het element niet kan worden toegevoegd [SWS_DM_02292]. Interpretatie: de concrete foutcodes worden vermoedelijk bepaald door het bijbehorende foutdomein van de implementatie, aangezien de specificatie deze bij de functiedefinitie niet expliciet opsomt. Vraag Q-ba196615f0cd8fc8 (open)

Gelijktijdigheid en randvoorwaarden

De operatie is gedeclareerd als thread-veilig (thread-safe) en als uitzonderingsveilig (exception safe) en geannoteerd met noexcept [SWS_DM_02292]. Als wezenlijke voorwaarde geldt dat het als parameter doorgegeven element zelf niet van het type ContentData mag zijn [SWS_DM_02292].

Samenspel

De functie maakt deel uit van het AUTOSAR Diagnostic Management (DM) voor de realisatie van SOVD voor het Adaptive Platform AUTOSAR_AP_SWS_Diagnostics §1 “Introduction and functional overview”, waarbij het DM fungeert als SOVD-server [SWS_DM_01369]. Voor dezelfde scope bestaan analoge overbelastingen van Add voor gehele getallen met teken [SWS_DM_02288], gehele getallen zonder teken [SWS_DM_02289], drijvende-kommagetallen [SWS_DM_02290], booleaanse waarden [SWS_DM_02291] en complexe gegevenselementen [SWS_DM_02293]. Bovendien stelt ara::diag::DiagnosticSovdContentElementData een overeenkomstige tekenreeks-overbelasting beschikbaar [SWS_DM_02372].

De synchrone functie Add van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView voegt onder de aangegeven sleutel key een genest element van het type DiagnosticSovdContentElementData toe aan een gegevenselement [SWS_DM_02293]. Dit dient voor de gestructureerde terbeschikkingstelling van diagnosegegevens in het kader van SOVD (Service-Oriented Vehicle Diagnostics), dat door Diagnostic Management (DM) op het Adaptive Platform wordt ondersteund ([SWS_DM_01369], AUTOSAR_AP_SWS_Diagnostics §1 “Introduction and functional overview”).

Bij het gebruik moeten dwingende typevoorschriften worden nageleefd:

• Het aanroepende gegevensobject moet van het type RecordContentElementData of ContentData zijn [SWS_DM_02293].
• Het toe te voegen element content_element mag expliciet niet van het type ContentData zijn [SWS_DM_02293].
• Als aanvulling op complexe datastructuren staan voor elementaire waarden afzonderlijke overbelastingen ter beschikking, bijvoorbeeld voor integerwaarden ([SWS_DM_02288], [SWS_DM_02289]), drijvende-kommagetallen [SWS_DM_02290], waarheidswaarden [SWS_DM_02291] of tekenreeksen [SWS_DM_02292], zoals ze ook op DiagnosticSovdContentElementData zijn gedefinieerd [SWS_DM_02373].

Voor foutafhandeling retourneert de functie een ara::core::Result<void>. Schiet de bewerking tekort – bijvoorbeeld omdat de typevoorwaarden geschonden zijn of het element niet kan worden ingevoegd –, dan bevat het resultaat een fout [SWS_DM_02293]. De exacte foutcodering is vermoedelijk gebaseerd op domeinspecifieke fouten van het diagnosebeheer. Vraag Q-56c929209d0c7358 (open) Wat betreft gelijktijdigheid en veiligheid is de methode als noexcept gedeclareerd, geldt ze als exception-veilig (exception safe) en is ze voor gelijktijdige toegang als thread-safe (thread-safe) gespecificeerd [SWS_DM_02293].

Gebruik en semantiek

De methode Clear van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView dient voor het synchroon verwijderen van alle inhoudselementen uit een RecordContentElementData [SWS_DM_02276]. De aanroep vindt parameterloos plaats via de header #include "ara/diag/diagnostic_sovd_content_element_data.h" en heeft geen retourwaarde (void) [SWS_DM_02276].

Als voorwaarde voor de uitvoering is gedefinieerd dat de onderliggende gegevensinstantie van het type RecordContentElementData of ContentData moet zijn [SWS_DM_02276]. Interpretatie: aangezien de functie gedeclareerd is als noexcept en geen foutstatus meldt, zal het naleven van dit datatype vermoedelijk al vooraf bij de creatie van het view-object gewaarborgd zijn. Vraag Q-93e43eee235a8f12 (open)

Foutafhandeling en gelijktijdigheid

Wat de uitvoeringsveiligheid betreft, is de methode gespecificeerd als exception safe en werpt deze door de declaratie noexcept geen excepties op [SWS_DM_02276]. De aanroep is bovendien expliciet geclassificeerd als thread-safe, zodat gelijktijdige toegangen zijn toegestaan [SWS_DM_02276].

Interactie en afbakening

In de SOVD-omgeving onderscheidt deze functie zich van de methode Clear op DiagnosticSovdContentElementData [SWS_DM_02338], die gedefinieerd is voor array-elementen en een ara::core::Result<void> levert. Evenzo bestaat er een functioneel onderscheid met de view-methode voor arrays [SWS_DM_02233] en met het asynchroon wissen van DTC's via ara::diag::DTCInformation::Clear, dat een ara::core::Future<void> retourneert en niet-thread-safe is [SWS_DM_00671].

De lidfunctie Erase van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView dient voor het verwijderen van een onderliggend inhoudselement uit een diagnosedata-record ([SWS_DM_02294], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.14 “Erase”). De declaratie wordt beschikbaar gesteld via de header #include "ara/diag/diagnostic_sovd_content_element_data.h" ([SWS_DM_02294]).

Gebruik en semantiek: Als invoerparameter accepteert de functie de iterator iterator van het type DiagnosticSovdRecordContentElementDataIterator, die verwijst naar het concreet te verwijderen element ([SWS_DM_02294]). Interpretatie: aangezien de functie gedeclareerd is met noexcept en direct ara::core::Result<void> retourneert in plaats van een future-object, zal de verwijderoperatie vermoedelijk synchroon in de thread van de aanroeper worden uitgevoerd. Vraag Q-148ae95c28910b16 (open) Bij succesvolle uitvoering levert de methode een lege ara::core::Result<void> op ([SWS_DM_02294]).

Foutafhandeling: De operatie mislukt wanneer het betreffende gegevenselement noch van het type RecordContentElementData noch van het type ContentData is of wanneer het element niet uit de container kon worden verwijderd ([SWS_DM_02294]). In deze foutgevallen retourneert de functie een fout met de foutcode DiagErrc::kInvalidArgument ([SWS_DM_02294]).

Gelijktijdigheid en interactie: Voor de aanroep is de interface gespecificeerd als thread-safe en exception safe ([SWS_DM_02294]). Functioneel komt de functie overeen met de array-variant ara::diag::DiagnosticSovdArrayContentElementDataView::Erase ([SWS_DM_02247], AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.8 “Erase”) en interacteert deze met de elementaire verwijderoperaties van de containerklasse DiagnosticSovdContentElementData voor arrays ([SWS_DM_02352]) en records ([SWS_DM_02374]).

De synchrone memberfunctie Find van de view-klasse ara::diag::DiagnosticSovdRecordContentElementDataView dient voor het vinden van een element aan de hand van zijn sleutel ([SWS_DM_02285], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.15 “Find”). Als parameter wordt key van het type ara::core::StringView meegegeven; als resultaat levert de functie een modificeerbare iterator van het type DiagnosticSovdRecordContentElementDataIterator op ([SWS_DM_02285]). Voorwaarde voor het gebruik is dat het bijbehorende DiagnosticSovdContentElementData van het type RecordContentElementData of ContentData is ([SWS_DM_02285]).

Wat betreft foutafhandeling en gelijktijdigheid is de functie gedeclareerd als noexcept, geldt als uitzonderingsveilig (exception safe) en is volgens de specificatie thread-veilig (thread-safe) ([SWS_DM_02285]). Aangezien het retourtype rechtstreeks een iterator is en geen ara::core::Result, meldt de functie geen specifieke foutcodes; als de gezochte sleutel niet bestaat, wordt vermoedelijk een end-iterator geretourneerd. Vraag Q-a34054c9851517ae (open)

In samenspel met verwante interfaces bestaat op dezelfde view-klasse een constante overbelasting ([SWS_DM_02286], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.16 “Find”), die een DiagnosticSovdRecordContentElementDataConstIterator retourneert. Een analoge constante interface biedt ook de klasse DiagnosticSovdRecordContentElementDataConstView ([SWS_DM_02306], AUTOSAR_AP_SWS_Diagnostics §8.60.9.1.1.7 “Find”). Daarentegen kapselt de methode Find op DiagnosticSovdContentElementData haar iterator in een ara::core::Result in om ongeldige types of ontbrekende sleutels als fout weer te geven ([SWS_DM_02365], [SWS_DM_02366], AUTOSAR_AP_SWS_Diagnostics §8.60.6.1.2.25 “Find”).

De synchrone lidfunctie Find van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView dient voor het alleen-lezen opzoeken van een gegevenselement aan de hand van de bijbehorende sleutel ([SWS_DM_02286], AUTOSAR AP SWS Diagnostics §8.60.11.1.1.16 “Find”).

Gebruik en parameters

De functie accepteert de gezochte sleutel key als ara::core::StringView ([SWS_DM_02286]). Voorwaarde voor de aanroep is dat de instantie van het diagnosetype RecordContentElementData of ContentData is ([SWS_DM_02286]). Als retourwaarde levert deze synchroon een constante iterator van het type DiagnosticSovdRecordContentElementDataConstIterator op ([SWS_DM_02286]). Indien er geen element bestaat dat overeenkomt met de sleutel, wordt vermoedelijk een iterator geretourneerd die het einde van de reeks markeert (interpretatie). Vraag Q-41a1eba77c0bc236 (open)

Foutafhandeling en gelijktijdigheid

De interface is gedeclareerd met noexcept, waarborgt uitzonderingsveiligheid (exception safe) en is voor gelijktijdige toegang gespecificeerd als thread-safe (thread-safe) ([SWS_DM_02286]). Anders dan bij de methode op ara::diag::DiagnosticSovdContentElementData ([SWS_DM_02366]) vindt er geen teruggave via ara::core::Result plaats, waardoor foutsituaties niet via foutcodes worden weergegeven.

Samenspel

Voor schrijvende respectievelijk modificerende toegang tot dezelfde view bestaat de niet-constante overload [SWS_DM_02285] met aanpasbare iterator. Voor zuivere lees-views stelt de klasse DiagnosticSovdRecordContentElementDataConstView een analoge Find-functie beschikbaar ([SWS_DM_02306]).

De synchrone elementfunctie Remove van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView dient voor het gericht verwijderen van een item aan de hand van zijn sleutel [SWS_DM_02287]. Zij is gedefinieerd in de header ara/diag/diagnostic_sovd_content_element_data.h en verwerkt de parameter key van het type ara::core::StringView AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.19 “Remove”.

Als retourwaarde levert de functie een ara::core::Result<bool> [SWS_DM_02287]:

• In het geval van succes signaleert de opgenomen booleaanse waarde of het geadresseerde element daadwerkelijk kon worden verwijderd.
• Een fout wordt via de ara::core::Result teruggemeld wanneer het element niet van het type RecordContentElementData of ContentData is of de opgegeven sleutel niet is gevonden [SWS_DM_02287].

Wat betreft concurrency en beperkingen is de functie gespecificeerd als uitzonderingsveilig (exception safe) en thread-safe (thread-safe) en gedeclareerd met noexcept [SWS_DM_02287]. Als aanroepvoorwaarde vereist de specificatie dwingend dat de onderliggende instantie van het type RecordContentElementData of ContentData is [SWS_DM_02287].

Interpretatie: Functioneel zal de bewerking vermoedelijk overeenkomen met het verwijderen op de dataklasse ara::diag::DiagnosticSovdContentElementData::Remove [SWS_DM_02367], aangezien signatuur, parameters en foutscenario's volkomen identiek zijn gespecificeerd AUTOSAR_AP_SWS_Diagnostics §8.60.6.1.2.54 “Remove”. Vraag Q-5a9ac29a9b5814be (open)

De methode Reserve van de klasse ara::diag::DiagnosticSovdRecordContentElementDataView ([SWS_DM_02283], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.20 “Reserve”) reserveert synchroon de gewenste geheugencapaciteit voor RecordContentElementData. De aanroep 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. Als retourwaarde levert de functie void.

De interface is gedeclareerd als noexcept en gespecificeerd als uitzonderingsveilig („exception safe”) ([SWS_DM_02283]). Er worden noch specifieke foutcodes noch foutstructuren teruggegeven. Interpretatie: Als de allocatie van de vereiste capaciteit mislukt, zal de fout bij gebrek aan een retourkanaal zoals ara::core::Result intern vermoedelijk worden opgevangen of tot een programmastop leiden. Vraag Q-ddbaac36f8ed58ad (open)

Wat betreft gelijktijdigheid is de functie gedefinieerd als thread-safe („thread-safe”) ([SWS_DM_02283]). Zij kan zodoende parallel en zonder aanvullende synchronisatiemaatregelen vanuit meerdere threads worden aangeroepen.

In het samenspel met verwante interfaces gedraagt de array-variant DiagnosticSovdArrayContentElementDataView::Reserve ([SWS_DM_02240]) zich analoog. In tegenstelling daartoe geeft DiagnosticSovdContentElementData::Reserve ([SWS_DM_02345]) een ara::core::Result<void> terug om typeconflicten te melden. De functie DiagnosticServiceDynamicAccessList::Reserve ([SWS_DM_01163]) dient daarentegen voor een worstcase-vooraf-allocatie voor service-patterns, verwacht twee parameters en is niet-thread-safe.