класс ara::diag::DiagnosticSovdRecordContentElementDataView

Использование

Синхронная функция [SWS_DM_02288] вставляет целочисленное значение со знаком (std::int64_t) под указанным ключом key (ara::core::StringView) в структуру данных SOVD. Она объявлена как метод класса ara::diag::DiagnosticSovdRecordContentElementDataView и подключается через заголовочный файл ara/diag/diagnostic_sovd_content_element_data.h.

Предварительные условия и обработка ошибок

Согласно [SWS_DM_02288], базовый объект DiagnosticSovdContentElementData должен иметь тип RecordContentElementData или ContentData, в то время как добавляемый элемент сам по себе не должен быть ContentData. Функция определена как noexcept и возвращает ara::core::Result<void>. В случае сбоя операции — например, если целевой контейнер имеет несовместимый тип или элемент не может быть добавлен — результат содержит код ошибки; Интерпретация: предположительно, это типично и при коллизиях ключей. Вопрос Q-524c832a794559b7 (открытый)

Параллелизм и взаимодействие

Выполнение специфицировано как потокобезопасное и исключение-безопасное [SWS_DM_02288]. В интерфейсе существуют перегрузки с идентичной семантикой типов для беззнаковых целых чисел ([SWS_DM_02289]), чисел с плавающей точкой ([SWS_DM_02290]), логических значений ([SWS_DM_02291]), строк ([SWS_DM_02292]), а также вложенных элементов данных ([SWS_DM_02293]). Тот же метод дополнительно предоставляется в классе-носителе DiagnosticSovdContentElementData ([SWS_DM_02368]).

Синхронная функция-член Add класса ara::diag::DiagnosticSovdRecordContentElementDataView служит для добавления значения беззнакового 64-битного целого числа под заданным ключом ([SWS_DM_02289]). Она применяется в рамках функциональности SOVD модуля Diagnostic Management, которая предоставляет диагностическую коммуникацию согласно ASAM SOVD (AUTOSAR_AP_SWS_Diagnostics §1.0 «Introduction and functional overview», [SWS_DM_01369]).

Использование и вызов

Метод подключается через заголовочный файл ara/diag/diagnostic_sovd_content_element_data.h. В качестве параметров он ожидает идентификатор key в виде ara::core::StringView, а также добавляемое значение content_element в виде std::uint64_t ([SWS_DM_02289]). Вызов выполняется синхронно, специфицирован как noexcept и возвращает результат в форме ara::core::Result<void>.

Обработка ошибок и граничные условия

• Условия типов: инстанцированный DiagnosticSovdContentElementData должен быть либо типа RecordContentElementData, либо ContentData. Кроме того, сам добавляемый элемент не должен иметь тип ContentData ([SWS_DM_02289]).
• Поведение при ошибках: если нарушается одно из этих требований к типам или элемент невозможно добавить, функция возвращает ошибочный ara::core::Result ([SWS_DM_02289]). Конкретные коды ошибок спецификация в этом месте не указывает; вероятно, объект Result возвращает соответствующий код ошибки домена диагностики. Вопрос Q-ffca131eece93b35 (открытый)
• Параллелизм: функция явно специфицирована как thread-safe и exception safe ([SWS_DM_02289]).

Взаимодействие

Метод принадлежит к семейству типизированных перегрузок для сбора примитивных и сложных элементов данных, среди которых варианты для знаковых целых чисел ([SWS_DM_02288]) и структурированных подэлементов ([SWS_DM_02293]). Эквивалентный интерфейс параллельно предлагается в классе DiagnosticSovdContentElementData ([SWS_DM_02369]).

Синхронная функция-член Add класса ara::diag::DiagnosticSovdRecordContentElementDataView добавляет примитивное значение с плавающей точкой типа double под указанным ключом key в запись данных [SWS_DM_02290]. Функция служит для формирования структурированных диагностических данных для функциональности SOVD-сервера Diagnostic Management [SWS_DM_01369].

Для выполнения действуют следующие предусловия, связанные с типами [SWS_DM_02290]:

• Целевой объект должен иметь тип RecordContentElementData или ContentData.
• Добавляемый элемент сам не должен иметь тип ContentData.

Метод объявлен как noexcept (exception safe) и специфицирован как потокобезопасный (thread-safe) для параллельного доступа [SWS_DM_02290]. Если добавление завершается неудачей — например, из-за несовместимости типа объекта или невозможности вставки элемента, — об ошибке сообщается через возвращаемый ara::core::Result<void> [SWS_DM_02290]. Интерпретация: точная причина ошибки, вероятно, отражается в ara::core::ErrorCode объекта Result. Вопрос Q-c987f75d785d3e90 (открытый)

В сочетании с родственными перегрузками Add метод обеспечивает структурированное заполнение записей данных SOVD целочисленными значениями ([SWS_DM_02288], [SWS_DM_02289]), булевыми значениями [SWS_DM_02291], строками [SWS_DM_02292] или более сложными данными элементов [SWS_DM_02293].

Функция Add класса ara::diag::DiagnosticSovdRecordContentElementDataView служит для добавления булева примитивного значения под указанным ключом в элемент данных SOVD [SWS_DM_02291]. Вызов осуществляется через заголовочный файл ara/diag/diagnostic_sovd_content_element_data.h с именем параметра key типа ara::core::StringView, а также значением полезных данных content_element типа bool [SWS_DM_02291]. Поскольку метод сразу возвращает ara::core::Result<void> и асинхронность не специфицирована, операция, вероятно, протекает синхронно. Вопрос Q-a16b08bf68f8590b (открытый)

Обработка ошибок осуществляется через возвращаемый ara::core::Result<void>. Об ошибке сообщается, если лежащий в основе DiagnosticSovdContentElementData не относится ни к типу RecordContentElementData, ни к ContentData, или если элемент невозможно добавить [SWS_DM_02291]. Конкретные коды ошибок в выдержке из спецификации подробно не приведены.

В отношении параллелизма и безопасности выполнения метод классифицирован как thread-safe и обеспечивает безопасность относительно исключений (noexcept) [SWS_DM_02291]. В качестве структурного ограничения спецификация требует, чтобы добавляемый элемент сам не относился к типу ContentData [SWS_DM_02291].

В общей системе этот метод дополняет родственные перегрузки для знаковых целых чисел [SWS_DM_02288], беззнаковых целых чисел [SWS_DM_02289], чисел с плавающей точкой [SWS_DM_02290], строк [SWS_DM_02292], а также подчиненных элементов содержимого [SWS_DM_02293]. Кроме того, существует аналогичный интерфейс у класса DiagnosticSovdContentElementData [SWS_DM_02371] в контексте функциональности SOVD-сервера Diagnostic Management [SWS_DM_01369].

Использование

Синхронный метод Add класса ara::diag::DiagnosticSovdRecordContentElementDataView служит для добавления записи с ключом и примитивным строковым значением в элемент данных SOVD [SWS_DM_02292]. Вызов осуществляется через оба параметра key и content_element, каждый из которых передаётся как ara::core::StringView [SWS_DM_02292]. В качестве возвращаемого значения функция предоставляет ara::core::Result<void> для сигнализации о результате операции [SWS_DM_02292].

Обработка ошибок

Если добавление завершается неудачей, метод возвращает ошибку в ara::core::Result [SWS_DM_02292]. Это происходит, если лежащий в основе объект не относится к типу RecordContentElementData или ContentData, либо если элемент невозможно добавить [SWS_DM_02292]. Интерпретация: конкретные коды ошибок, вероятно, определяются соответствующим доменом ошибок реализации, поскольку спецификация не перечисляет их явно в определении функции. Вопрос Q-ba196615f0cd8fc8 (открытый)

Параллелизм и граничные условия

Операция объявлена как потокобезопасная (thread-safe), а также безопасная относительно исключений (exception safe) и снабжена аннотацией noexcept [SWS_DM_02292]. В качестве существенного предусловия действует требование: переданный в качестве параметра элемент сам не должен относиться к типу ContentData [SWS_DM_02292].

Взаимодействие

Функция является компонентом AUTOSAR Diagnostic Management (DM) для реализации SOVD для Adaptive Platform AUTOSAR_AP_SWS_Diagnostics §1 «Introduction and functional overview», где DM действует как SOVD-сервер [SWS_DM_01369]. Для этой же области существуют аналогичные перегрузки Add для знаковых целых чисел [SWS_DM_02288], беззнаковых целых чисел [SWS_DM_02289], чисел с плавающей точкой [SWS_DM_02290], булевых значений [SWS_DM_02291], а также сложных элементов данных [SWS_DM_02293]. Кроме того, ara::diag::DiagnosticSovdContentElementData предоставляет соответствующую строковую перегрузку [SWS_DM_02372].

Синхронная функция Add класса ara::diag::DiagnosticSovdRecordContentElementDataView добавляет к элементу данных по указанному ключу key вложенный элемент типа DiagnosticSovdContentElementData [SWS_DM_02293]. Это служит для структурированного предоставления диагностических данных в рамках SOVD (Service-Oriented Vehicle Diagnostics), поддерживаемого Diagnostic Management (DM) на Adaptive Platform ([SWS_DM_01369], AUTOSAR_AP_SWS_Diagnostics §1 «Introduction and functional overview»).

При использовании необходимо соблюдать обязательные требования к типам:

• Вызывающий объект данных должен иметь тип RecordContentElementData или ContentData [SWS_DM_02293].
• Добавляемый элемент content_element явным образом не должен иметь тип ContentData [SWS_DM_02293].
• В дополнение к сложным структурам данных для элементарных значений доступны отдельные перегрузки, например для целочисленных значений ([SWS_DM_02288], [SWS_DM_02289]), чисел с плавающей точкой [SWS_DM_02290], логических значений [SWS_DM_02291] или строк [SWS_DM_02292], как они также определены в DiagnosticSovdContentElementData [SWS_DM_02373].

Для обработки ошибок функция возвращает ara::core::Result<void>. В случае сбоя операции — например, из-за нарушения требований к типам или невозможности вставки элемента — результат содержит ошибку [SWS_DM_02293]. Точное кодирование ошибок, вероятно, основано на доменно-специфичных ошибках управления диагностикой. Вопрос Q-56c929209d0c7358 (открытый) В отношении параллелизма и безопасности метод объявлен как noexcept, является исключение-безопасным (exception safe) и специфицирован как потокобезопасный (thread-safe) для конкурентного доступа [SWS_DM_02293].

Использование и семантика

Метод Clear класса ara::diag::DiagnosticSovdRecordContentElementDataView служит для синхронного удаления всех элементов содержимого из RecordContentElementData [SWS_DM_02276]. Вызов выполняется без параметров через заголовок #include "ara/diag/diagnostic_sovd_content_element_data.h" и не имеет возвращаемого значения (void) [SWS_DM_02276].

В качестве предварительного условия для выполнения определено, что базовая инстанция данных должна иметь тип RecordContentElementData или ContentData [SWS_DM_02276]. Интерпретация: поскольку функция объявлена как noexcept и не сообщает о статусе ошибки, соответствие этому типу данных, вероятно, обеспечивается заранее при создании объекта представления (View). Вопрос Q-93e43eee235a8f12 (открытый)

Обработка ошибок и параллелизм

Что касается безопасности выполнения, метод специфицирован как exception safe и благодаря объявлению noexcept не вызывает исключений [SWS_DM_02276]. Вызов также явно классифицирован как thread-safe, поэтому параллельные обращения допустимы [SWS_DM_02276].

Взаимодействие и разграничение

В среде SOVD эта функция отличается от метода Clear для DiagnosticSovdContentElementData [SWS_DM_02338], который определён для элементов массива и возвращает ara::core::Result<void>. Также существует функциональное отличие от метода представления для массивов [SWS_DM_02233] и от асинхронного удаления DTC через ara::diag::DTCInformation::Clear, которое возвращает ara::core::Future<void> и не является потокобезопасным [SWS_DM_00671].

Функция-член Erase класса ara::diag::DiagnosticSovdRecordContentElementDataView служит для удаления подчиненного элемента содержимого из записи диагностических данных ([SWS_DM_02294], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.14 «Erase»). Объявление предоставляется через заголовочный файл #include "ara/diag/diagnostic_sovd_content_element_data.h" ([SWS_DM_02294]).

Использование и семантика: В качестве входного параметра функция принимает итератор iterator типа DiagnosticSovdRecordContentElementDataIterator, указывающий на конкретный удаляемый элемент ([SWS_DM_02294]). Интерпретация: поскольку функция объявлена с noexcept и возвращает напрямую ara::core::Result<void> вместо объекта future, операция удаления, вероятно, выполняется синхронно в потоке вызывающей стороны. Вопрос Q-148ae95c28910b16 (открытый) При успешном выполнении метод возвращает пустой ara::core::Result<void> ([SWS_DM_02294]).

Обработка ошибок: Операция завершается сбоем, если соответствующий элемент данных не относится ни к типу RecordContentElementData, ни к типу ContentData или если элемент не удалось удалить из контейнера ([SWS_DM_02294]). В этих случаях ошибок функция возвращает ошибку с кодом ошибки DiagErrc::kInvalidArgument ([SWS_DM_02294]).

Параллелизм и взаимодействие: Для вызова интерфейс специфицирован как thread-safe, а также exception safe ([SWS_DM_02294]). С функциональной точки зрения функция соответствует варианту для массива ara::diag::DiagnosticSovdArrayContentElementDataView::Erase ([SWS_DM_02247], AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.8 «Erase») и взаимодействует с базовыми операциями удаления класса контейнера DiagnosticSovdContentElementData для массивов ([SWS_DM_02352]) и записей ([SWS_DM_02374]).

Синхронная функция-член Find класса представления ara::diag::DiagnosticSovdRecordContentElementDataView служит для поиска элемента по его ключу ([SWS_DM_02285], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.15 «Find»). В качестве параметра передается key типа ara::core::StringView; в качестве результата функция возвращает модифицируемый итератор типа DiagnosticSovdRecordContentElementDataIterator ([SWS_DM_02285]). Необходимым условием для использования является то, что соответствующий DiagnosticSovdContentElementData имеет тип RecordContentElementData или ContentData ([SWS_DM_02285]).

В отношении обработки ошибок и параллелизма функция объявлена как noexcept, считается безопасной к исключениям (exception safe) и согласно спецификации является потокобезопасной (thread-safe) ([SWS_DM_02285]). Поскольку возвращаемый тип представляет собой непосредственно итератор, а не ara::core::Result, функция не сообщает о специфических кодах ошибок; если искомый ключ не существует, предположительно возвращается итератор конца. Вопрос Q-a34054c9851517ae (открытый)

Во взаимодействии с родственными интерфейсами в том же классе представления существует константная перегрузка ([SWS_DM_02286], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.16 «Find»), которая возвращает DiagnosticSovdRecordContentElementDataConstIterator. Аналогичный константный интерфейс предоставляет также класс DiagnosticSovdRecordContentElementDataConstView ([SWS_DM_02306], AUTOSAR_AP_SWS_Diagnostics §8.60.9.1.1.7 «Find»). Напротив, метод Find в DiagnosticSovdContentElementData инкапсулирует свой итератор в ara::core::Result, чтобы представлять недопустимые типы или отсутствующие ключи как ошибки ([SWS_DM_02365], [SWS_DM_02366], AUTOSAR_AP_SWS_Diagnostics §8.60.6.1.2.25 «Find»).

Синхронная функция-член Find класса ara::diag::DiagnosticSovdRecordContentElementDataView служит для доступного только для чтения поиска элемента данных по его ключу ([SWS_DM_02286], AUTOSAR AP SWS Diagnostics §8.60.11.1.1.16 «Find»).

Использование и параметры

Функция принимает искомый ключ key как ara::core::StringView ([SWS_DM_02286]). Обязательным условием для вызова является то, что экземпляр относится к типу диагностики RecordContentElementData или ContentData ([SWS_DM_02286]). В качестве возвращаемого значения она синхронно возвращает константный итератор типа DiagnosticSovdRecordContentElementDataConstIterator ([SWS_DM_02286]). Если элемент, соответствующий ключу, не существует, предположительно возвращается итератор, обозначающий конец последовательности (интерпретация). Вопрос Q-41a1eba77c0bc236 (открытый)

Обработка ошибок и параллелизм

Интерфейс объявлен с noexcept, гарантирует безопасность исключений (exception safe) и специфицирован как потокобезопасный (thread-safe) при параллельном доступе ([SWS_DM_02286]). В отличие от метода для ara::diag::DiagnosticSovdContentElementData ([SWS_DM_02366]), возврат через ara::core::Result не выполняется, поэтому случаи сбоев не отображаются с помощью кодов ошибок.

Взаимодействие

Для операций записи или модификации того же представления существует неконстантная перегрузка [SWS_DM_02285] с изменяемым итератором. Для представлений только для чтения класс DiagnosticSovdRecordContentElementDataConstView предоставляет аналогичную функцию Find ([SWS_DM_02306]).

Синхронная функция-член Remove класса ara::diag::DiagnosticSovdRecordContentElementDataView служит для целевого удаления записи по ее ключу [SWS_DM_02287]. Она определена в заголовочном файле ara/diag/diagnostic_sovd_content_element_data.h и обрабатывает параметр key типа ara::core::StringView AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.19 «Remove».

В качестве возвращаемого значения функция возвращает ara::core::Result<bool> [SWS_DM_02287]:

• В случае успеха содержащееся булево значение сигнализирует, действительно ли удалось удалить адресуемый элемент.
• Ошибка возвращается через ara::core::Result, если элемент не относится к типу RecordContentElementData или ContentData либо указанный ключ не был найден [SWS_DM_02287].

В отношении параллелизма и ограничений функция специфицирована как исключительной безопасности (exception safe) и потокобезопасная (thread-safe), а также объявлена с noexcept [SWS_DM_02287]. В качестве условия вызова спецификация обязательно требует, чтобы базовый экземпляр относился к типу RecordContentElementData или ContentData [SWS_DM_02287].

Интерпретация: функционально операция, вероятно, соответствует удалению в классе данных ara::diag::DiagnosticSovdContentElementData::Remove [SWS_DM_02367], поскольку сигнатура, параметры и сценарии ошибок специфицированы полностью одинаково AUTOSAR_AP_SWS_Diagnostics §8.60.6.1.2.54 «Remove». Вопрос Q-5a9ac29a9b5814be (открытый)

Метод Reserve класса ara::diag::DiagnosticSovdRecordContentElementDataView ([SWS_DM_02283], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.20 «Reserve») синхронно резервирует требуемую емкость памяти для RecordContentElementData. Вызов предоставляется через заголовочный файл #include "ara/diag/diagnostic_sovd_content_element_data.h" и принимает параметр capacity типа std::size_t. В качестве возвращаемого значения функция возвращает void.

Интерфейс объявлен как noexcept и специфицирован как исключебно-безопасный («exception safe») ([SWS_DM_02283]). Специфические коды ошибок или структуры ошибок не возвращаются. Интерпретация: если выделение требуемой емкости завершается неудачно, ошибка из-за отсутствия канала возврата, такого как ara::core::Result, вероятно, перехватывается внутри или приводит к аварийному завершению программы. Вопрос Q-ddbaac36f8ed58ad (открытый)

Что касается параллелизма, функция определена как потокобезопасная («thread-safe») ([SWS_DM_02283]). Таким образом, её можно вызывать параллельно и без дополнительных мер синхронизации из нескольких потоков.

Во взаимодействии со связанными интерфейсами вариант для массивов DiagnosticSovdArrayContentElementDataView::Reserve ([SWS_DM_02240]) ведёт себя аналогично. В отличие от него, DiagnosticSovdContentElementData::Reserve ([SWS_DM_02345]) возвращает ara::core::Result<void> для сообщения о конфликтах типов. Функция DiagnosticServiceDynamicAccessList::Reserve ([SWS_DM_01163]), напротив, служит для наихудшего предварительного выделения (worst-case) для шаблонов служб, ожидает два параметра и не является потокобезопасной.