klasse <DataIdentifier-Namespace>::<DataIdentifierInterface>

Gebruik

De constructorfunctie <DataIdentifierInterface> dient voor de instantiëring van een gegevensidentificator uit een ara::core::InstanceSpecifier [SWS_DM_00585]. De declaratie vindt plaats binnen de namespace <DataIdentifier-Namespace> via het headerbestand #include "<DataIdentifierDirectoryPath>/<DataIdentifierShortname>.h" [SWS_DM_00585]. De synchrone aanroep is gespecificeerd als noexcept en bezit de eigenschappen "exception safe" en "thread-safe" [SWS_DM_00585].

De functie accepteert de volgende overdrachtsparameters [SWS_DM_00585]:

• instanceSpec (ara::core::InstanceSpecifier): Identifier van de concrete instantie van een dienst [SWS_DM_00585].
• concurrencyType (ara::diag::ConcurrencyType): Bepaalt of de interface thread-safe met kConcurrent of niet-thread-safe met kNotConcurrent wordt gebruikt [SWS_DM_00585].

Foutafhandeling en modelleringsregels

De functie levert geen retourwaarde op en genereert geen excepties. Fouten in de configuratie of modellering leiden in plaats daarvan tot gedefinieerde violations [SWS_DM_00585]:

• InstanceSpecifierMappingIntegrityViolation: De instanceSpec kan in de context van het executable niet worden omgezet of verwijst niet naar een PortPrototype [SWS_DM_00585].
• PortInterfaceMappingViolation: Een door DiagnosticDataIdentifierInterface getypeerde PortPrototype wordt niet gerefereerd door een DiagnosticDataPortMapping [SWS_DM_00585].
• ProcessMappingViolation: Voor de instantieverwijzing bestaat geen passend gemodelleerd proces voor het huidige runtimeproces [SWS_DM_00585].
• InstanceSpecifierAlreadyInUseViolation: De constructor is aangeroepen met een instanceSpec die in het huidige proces al in gebruik is [SWS_DM_00585].

Interpretatie: aangezien de functie gedeclareerd is als noexcept, worden vastgestelde violations framework-intern vermoedelijk behandeld als kritieke initialisatiefouten. Vraag Q-8616025446bf33f2 (open)

Concurrency

De constructorfunctie zelf is thread-safe uitgevoerd [SWS_DM_00585]. Via het argument concurrencyType wordt gestuurd of navolgende interface-aanroepen van de instantie gelijktijdig mogen plaatsvinden [SWS_DM_00585].

Gebruik en aanroepcontext

De synchrone methode Offer() stelt Diagnostic Management (DM) in staat om inkomende diagnoseverzoeken door te sturen naar de desbetreffende instantie van <DataIdentifierInterface> ([SWS_DM_00599]). De functie accepteert geen overdrachtsparameters en is gespecificeerd als noexcept ([SWS_DM_00599]). Interpretatie: De aanroep vindt vermoedelijk typisch plaats tijdens de initialisatiefase van de applicatie, aangezien het DM vóór de beschikbaarstelling geen verzoeken kan afleveren. Vraag Q-4ba81ff234a09f46 (open)

Foutafhandeling en retourwaarden

Als retourwaarde dient ara::core::Result<void> ([SWS_DM_00599]). Was de registratie succesvol, dan bevat het resultaat geen waarde. Is de handler al eerder beschikbaar gesteld, dan mislukt de aanroep en levert deze de foutcode DiagOfferErrc::kAlreadyOffered op met rollback-semantiek ([SWS_DM_00599]; vgl. [SWS_DM_00514]).

Gelijktijdigheid en beperkingen

De functie waarborgt uitzonderingsveiligheid (exception safe), maar is uitdrukkelijk gespecificeerd als niet-thread-safe (not thread-safe) ([SWS_DM_00599]). Parallelle aanroepen op dezelfde instantie moeten door de applicatie worden gesynchroniseerd.

Samenspel

Het patroon voor beschikbaarstelling komt overeen met de uniforme activeringsaanpak in het DM: analoge Offer()-methoden bestaan voor generieke identifiers ([SWS_DM_00638]), data-elementen ([SWS_DM_00597]), routines ([SWS_DM_00557], [SWS_DM_00594]) en DoIP-diensten ([SWS_DM_00725], [SWS_DM_00735]). Zolang Offer() niet is uitgevoerd, stuurt het DM geen verzoeken door naar de handler en antwoordt bij DoIP-diensten met standaardwaarden ([SWS_DM_01525], [SWS_DM_01527]).

Gebruik

De methode Read dient voor het beschikbaar stellen van gegevens van een diagnose-data-identifier (DataIdentifier) in de leesrol van een DiagnosticDataIdentifierInterface [SWS_DM_00640]. De aanroep vindt asynchroon plaats door de Diagnostic Manager (DM) bij externe diagnoseverzoeken AUTOSAR_AP_SWS_Diagnostics p. 143 §7.3.2.6.1 “NRCs created by application”. Als parameters worden metaInfo voor de evaluatie van de verzoekeigenschappen en een cancellationHandler doorgegeven [SWS_DM_00640]. De verwerkende applicatie kan via cancellationHandler.IsCanceled() de afbreekstatus opvragen of middels cancellationHandler.SetNotifier() een callback registreren voor het geval de sessie voortijdig wordt afgebroken [SWS_DM_00640]. Het resultaat wordt asynchroon als ara::core::Future met een ReadOutput-object geretourneerd [SWS_DM_00640], [SWS_DM_00579].

Foutafhandeling

De functie is gespecificeerd als exception safe en mag geen excepties naar buiten propageren [SWS_DM_00640]. Treedt er bij het ophalen van gegevens een fout op, dan levert de applicatie in de ara::core::Future een negatieve retourwaarde terug in de vorm van een passende UDS-foutcode (NRC conform ISO 14229-1 via DiagUdsNrcErrc) of een ApApplicationError [SWS_DM_00640], AUTOSAR_AP_SWS_Diagnostics p. 143 §7.3.2.6.1 “NRCs created by application”.

Gelijktijdigheid en wisselwerking

De interfacefunctie is standaard not thread-safe [SWS_DM_00640]. Een gelijktijdige uitvoering van lees- en schrijftoegangen door de Diagnostic Manager wordt geregeld via het type ara::diag::DataIdentifierConcurrencyType::readWrite, dat standaard is ingesteld op kNotConcurrent [SWS_DM_00939]. Verwante leesoperaties bestaan voor afzonderlijke data-elementen via DiagnosticDataElementInterface [SWS_DM_00596] en voor generieke identifiers [SWS_DM_00636].

De methode StopOffer de-installeert het doorsturen van inkomende diagnoseverzoeken van het Diagnostic Management (DM) naar de concrete interface-instantie [SWS_DM_00600]. Door de aanroep signaleert de Adaptive-toepassing dat deze tijdelijk of permanent niet meer beschikbaar is voor de verwerking van verzoeken voor deze DataIdentifier.

Gebruik en semantiek

De aanroep verloopt synchroon, is parameterloos en levert geen retourwaarde op [SWS_DM_00600]. Als header moet het gegenereerde interfacebestand #include "<DataIdentifierDirectoryPath>/<DataIdentifierShortname>.h" worden ingevoegd [SWS_DM_00600]. De naamgeving volgt het uit ara::com bekende patroon, maar vormt een zelfstandige interface van het diagnosedomein AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”.

Foutafhandeling en gelijktijdigheid

• Uitzonderingsveiligheid: de functie is gedeclareerd met noexcept en garandeert volledige uitzonderingsveiligheid (exception safe) [SWS_DM_00600]. Er worden geen excepties geworpen.
• Thread-safety: de operatie is gespecificeerd als not thread-safe [SWS_DM_00600]. De aanroep moet gesynchroniseerd plaatsvinden, zodat er geen parallelle toegang tot dezelfde interface-instantie plaatsvindt.

Samenspel

Het gedrag komt overeen met het uniforme deactiveringspatroon van Diagnostic Management, zoals dat analoog ook is gedefinieerd voor verwante interfaces zoals routines [SWS_DM_00558], generieke gegevenselementen [SWS_DM_00639] of downloaddiensten [SWS_DM_00793]. Inkomende verzoeken van het DM aan deze DataIdentifier worden na succesvolle deactivering niet meer doorgestuurd naar de applicatiehandler [SWS_DM_00600]; het DM genereert daarop vermoedelijk overeenkomstige negatieve responscodes. Vraag Q-d301740d097f9946 (open)

De interfacefunctie dient voor het typeveilig beschikbaar stellen van een schrijvende DataIdentifier (DID) in de rol Write [SWS_DM_00598]. Deze wordt door de Diagnostic Server-instantie aangeroepen bij binnenkomende diagnoseverzoeken van de UDS-dienst 0x2E (WriteDataByIdentifier) [SWS_DM_00186], mits de DID in het systeem wordt ondersteund en de controles van de actieve diagnosesessie evenals het beveiligingsniveau met succes zijn doorstaan [SWS_DM_00415] [SWS_DM_00416] [SWS_DM_00417]. In tegenstelling tot de generieke variant met ruwe byte-span [SWS_DM_00637] bindt de methode modelspecifiek getypeerde invoerparameters [SWS_DM_00598].

• Parameters: Naast de gegenereerde invoerargumenten ontvangt de methode meta-informatie over het verzoek via metaInfo evenals een cancellationHandler [SWS_DM_00598]. Via de cancellation-handler kan de applicatie via IsCanceled controleren of de conversatie is geannuleerd, of met SetNotifier een notificatie registreren voor het geval van annulering [SWS_DM_00598].
• Retourwaarde en foutafhandeling: De uitvoering vindt asynchroon plaats via ara::core::Future<void> [SWS_DM_00598]. Bij succes levert de future het type void op. In geval van een fout moet een toepasselijke UDS-NRC conform ISO 14229-1 middels ara::diag::DiagUdsNrcErrc of een overeenkomstige ApplicationError worden geretourneerd [SWS_DM_00598]. De functie is gedeclareerd als uitzonderingsveilig (exception safe) [SWS_DM_00598].
• Concurrency: De methode is geclassificeerd als niet thread-safe (not thread-safe) [SWS_DM_00598]. Of lees- en schrijftoegangen door Diagnostic Management parallel mogen worden aangeroepen, wordt geregeld via het configuratie-element readWrite in DataIdentifierConcurrencyType [SWS_DM_00939].