clase ara::diag::DiagnosticSovdArrayContentElementDataView

usar

La función miembro Clear de la clase ara::diag::DiagnosticSovdArrayContentElementDataView vacía todo el contenido de un elemento de matriz SOVD ([SWS_DM_02233]). La llamada se proporciona a través del encabezado #include "ara/diag/diagnostic_sovd_content_element_data.h". El método posee la signatura auto Clear () noexcept -> void;. Funciona de manera síncrona, no recibe parámetros y no devuelve ningún valor de retorno ([SWS_DM_02233]).

Tratamiento de errores y condiciones límite

Según la especificación, la función está definida como segura ante excepciones (exception safe) y provista del especificador noexcept ([SWS_DM_02233]). No devuelve códigos de error ni un ara::core::Result. Como requisito vinculante, el DiagnosticSovdContentElementData referenciado debe ser del tipo ArrayContentElementData ([SWS_DM_02233]). Dado que no se señalan errores, el cumplimiento de este tipo debería estar garantizado por la clase de vista ya en tiempo de construcción. Pregunta Q-cdb2385e081c3456 (abierta)

concurrencia

La especificación clasifica expresamente el método como seguro para subprocesos (thread-safe) ([SWS_DM_02233]). Por lo tanto, las llamadas a Clear se pueden realizar de forma concurrente desde varios subprocesos sin sincronización externa.

Interacción en el subsistema de diagnóstico

Dentro de las estructuras de datos SOVD, la operación está estrechamente relacionada con otros métodos de borrado:

• DiagnosticSovdContentElementData::Clear ([SWS_DM_02338]) constituye la contraparte genérica a nivel de elemento, pero devuelve un ara::core::Result<void> y falla si el objeto no representa una matriz.
• DiagnosticSovdRecordContentElementDataView::Clear ([SWS_DM_02276]) asume la limpieza análoga para estructuras de datos del tipo RecordContentElementData o ContentData.
• Por el contrario, en el contexto clásico de la memoria de averías, ara::diag::DTCInformation::Clear ([SWS_DM_00671]) sirve para la limpieza asíncrona de DTC de UDS a través de ara::core::Future.

usar

El método Erase de la clase ara::diag::DiagnosticSovdArrayContentElementDataView sirve para eliminar un elemento de datos de contenido SOVD de diagnóstico ([SWS_DM_02247], SWS Diagnostics §8.60.5.1.1.8 «Erase»). Como parámetro, la función recibe un iterador del tipo DiagnosticSovdArrayContentElementDataIterator, el cual apunta al elemento que se va a eliminar. La llamada se realiza como una operación síncrona; esto probablemente se deba al retorno directo de ara::core::Result<void> sin un patrón de future asíncrono. Pregunta Q-28de22574e525c78 (abierta)

Tratamiento de errores y condiciones límite

La función está declarada con noexcept y posee las propiedades exception safe y thread-safe ([SWS_DM_02247]). Si la eliminación falla, el método devuelve un error a través del ara::core::Result retornado. Este es el caso cuando el DiagnosticSovdContentElementData superior no es del tipo requerido ArrayContentElementData o el elemento no pudo eliminarse por otras razones ([SWS_DM_02247]).

Interacción

Dentro de la interfaz SOVD, esta operación se corresponde con el método de eliminación Erase del contenedor de datos subyacente DiagnosticSovdContentElementData para elementos de array ([SWS_DM_02352]). Para estructuras de tipo record existen contrapartes análogas con DiagnosticSovdRecordContentElementDataView::Erase así como con el correspondiente método de contenedor ([SWS_DM_02294], [SWS_DM_02374]).

La función miembro síncrona PushBack sirve para añadir un elemento entero con signo del tipo std::int64_t a una estructura de matriz de elementos de contenido SOVD de diagnóstico ([SWS_DM_02241], AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.14 «PushBack»). Está declarada en el archivo de encabezado ara/diag/diagnostic_sovd_content_element_data.h y definida como noexcept ([SWS_DM_02241]).

Para una invocación exitosa aplican los siguientes prerrequisitos y requisitos de interfaz:

• Contexto de invocación y precondiciones: El objeto de destino de la clase ara::diag::DiagnosticSovdArrayContentElementDataView debe representar un ArrayContentElementData, y el tipo primitivo que se va a añadir debe coincidir con el tipo de elemento definido en el constructor ([SWS_DM_02241]).
• Valor de retorno y tratamiento de errores: La función devuelve un ara::core::Result<void>. Si la comprobación falla debido a que el elemento subyacente no es del tipo ArrayContentElementData, el resultado contiene un error ([SWS_DM_02241]). Interpretación: Es de suponer que una discrepancia con el tipo de datos especificado en el constructor se notifique de forma análoga como un error en el objeto de resultado. Pregunta Q-d4715ecbd0f12d26 (abierta)
• Concurrencia: La función está especificada como thread-safe así como exception-safe ([SWS_DM_02241]).

El método forma parte de una familia de sobrecargas tipadas dentro de DiagnosticSovdArrayContentElementDataView para enteros sin signo ([SWS_DM_02242]), números de punto flotante ([SWS_DM_02243]), valores booleanos ([SWS_DM_02244]), cadenas de caracteres ([SWS_DM_02245]) y elementos de datos completos ([SWS_DM_02246]). Existen asimismo métodos correspondientes en la propia clase de datos DiagnosticSovdContentElementData ([SWS_DM_02346]).

usar

La función de API síncrona PushBack de la clase ara::diag::DiagnosticSovdArrayContentElementDataView añade un valor entero sin signo de 64 bits (std::uint64_t) como elemento de datos primitivo al final de un elemento de matriz SOVD existente [SWS_DM_02242]. La inclusión se realiza a través del archivo de encabezado ara/diag/diagnostic_sovd_content_element_data.h SWS Diagnostics §8.60.5.1.1.15 «PushBack». El prerrequisito para una invocación exitosa es que el elemento actual represente un ArrayContentElementData y que el valor que se va a añadir coincida con el tipo de elemento definido en el constructor [SWS_DM_02242].

Tratamiento de errores y concurrencia

La función señala su estado de ejecución mediante ara::core::Result<void> [SWS_DM_02242]. Si el objeto de destino no es del tipo ArrayContentElementData, la función devuelve un error en el resultado [SWS_DM_02242]. Dado que no se mencionan códigos de error específicos (interpretación: los estados de error se señalan genéricamente mediante el Result), el llamador debe evaluar el objeto Result. Pregunta Q-95f2dd96e2681368 (abierta) El método está declarado como noexcept, garantiza seguridad frente a excepciones y está especificado explícitamente como seguro para subprocesos [SWS_DM_02242].

Interacción

La operación pertenece a una familia de sobrecargas específicas por tipo dentro de DiagnosticSovdArrayContentElementDataView, las cuales procesan de forma análoga enteros con signo mediante std::int64_t [SWS_DM_02241], números de punto flotante vía double [SWS_DM_02243], valores booleanos mediante bool [SWS_DM_02244], cadenas de caracteres vía ara::core::StringView [SWS_DM_02245] o elementos estructurados del tipo DiagnosticSovdContentElementData [SWS_DM_02246]. DiagnosticSovdContentElementData proporciona además una implementación semejante para std::uint64_t [SWS_DM_02347].

usar

El método síncrono PushBack se proporciona a través del archivo de encabezado #include "ara/diag/diagnostic_sovd_content_element_data.h" en el ámbito de la clase ara::diag::DiagnosticSovdArrayContentElementDataView ([SWS_DM_02243], AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.13 «PushBack»). Añade un valor de punto flotante primitivo del tipo double como elemento de contenido a una matriz existente ([SWS_DM_02243]). El único parámetro de transferencia es el dato que se va a añadir content_element.

Tratamiento de errores y condiciones límite

La función devuelve un ara::core::Result<void> ([SWS_DM_02243]). Una ejecución exitosa presupone que el elemento actual sea del tipo ArrayContentElementData y que el elemento que se va a añadir coincida con el tipo fijado en el constructor de ArrayContentElementData ([SWS_DM_02243]). En caso de que el destino no sea del tipo ArrayContentElementData, la operación falla y devuelve un error en el Result ([SWS_DM_02243]).

concurrencia

La función está declarada como noexcept, garantiza seguridad frente a excepciones (exception safe) y, según la especificación, es thread-safe ([SWS_DM_02243]). Por lo tanto, varios subprocesos pueden invocar la función de forma concurrente sin sincronización externa.

Interacción

Dentro de DiagnosticSovdArrayContentElementDataView existen sobrecargas del mismo tipo para otros tipos de datos primitivos, entre ellos std::int64_t ([SWS_DM_02241]), std::uint64_t ([SWS_DM_02242]), bool ([SWS_DM_02244]), ara::core::StringView ([SWS_DM_02245]), así como para objetos DiagnosticSovdContentElementData completos ([SWS_DM_02246]). También se dispone de métodos análogos en DiagnosticSovdContentElementData (p. ej., [SWS_DM_02348]).

La función miembro PushBack sirve para añadir un DiagnosticSovdContentElementData con el tipo de datos primitivo bool a un elemento de matriz existente ([SWS_DM_02244]). La interfaz está definida en el encabezado ara/diag/diagnostic_sovd_content_element_data.h dentro de la clase ara::diag::DiagnosticSovdArrayContentElementDataView (AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.12 «PushBack»). Como parámetro de entrada, la función síncrona recibe el valor booleano content_element ([SWS_DM_02244]).

El prerrequisito para la invocación es que el elemento actual sea del tipo ArrayContentElementData y que el valor que se va a añadir coincida con el tipo declarado en el constructor de la estructura de datos ([SWS_DM_02244]). Si el elemento de destino no es del tipo ArrayContentElementData, la operación falla y devuelve un ara::core::Result<void> con el error correspondiente; en caso de éxito, el resultado contiene un void vacío ([SWS_DM_02244]).

En cuanto a la seguridad de ejecución, el método está declarado como noexcept así como especificado como seguro para subprocesos (thread-safe) y seguro frente a excepciones (exception safe) ([SWS_DM_02244]).

El método forma parte de una familia de sobrecargas PushBack tipadas dentro de DiagnosticSovdArrayContentElementDataView. Además de valores booleanos, funciones hermanas cubren la inserción de tipos enteros como std::int64_t ([SWS_DM_02241]) y std::uint64_t ([SWS_DM_02242]), valores de punto flotante double ([SWS_DM_02243]), cadenas de caracteres ara::core::StringView ([SWS_DM_02245]), así como elementos de datos complejos ([SWS_DM_02246]). Se dispone además de operaciones correspondientes al nivel de DiagnosticSovdContentElementData, entre ellas la variante booleana [SWS_DM_02349].

usar

La función miembro sincrónica PushBack de la clase ara::diag::DiagnosticSovdArrayContentElementDataView ([SWS_DM_02245], definida en SWS Diagnostics §8.60.5.1.1.11 «PushBack») añade un nuevo elemento con el tipo primitivo cadena de caracteres a un arreglo de diagnóstico SOVD. Para ello debe incluirse la cabecera ara/diag/diagnostic_sovd_content_element_data.h. La función toma el elemento que se va a añadir mediante el parámetro content_element de tipo ara::core::StringView.

Manejo de errores

Como tipo de retorno sirve ara::core::Result<void>. Se devuelve un error en el objeto de resultado si el objeto actual no es de tipo ArrayContentElementData o si el tipo del elemento transferido no coincide con el tipo de elemento estipulado en el constructor de ArrayContentElementData ([SWS_DM_02245]).

Concurrencia y restricciones

La función está declarada con el especificador noexcept. Ofrece seguridad frente a excepciones garantizada (exception safe) y está especificada sin restricciones como segura para subprocesos (thread-safe) ([SWS_DM_02245]).

Interacción

La operación forma parte de una familia de métodos sobrecargados. Dentro de DiagnosticSovdArrayContentElementDataView existen sobrecargas adicionales para tipos escalares como std::int64_t ([SWS_DM_02241]), std::uint64_t ([SWS_DM_02242]), double ([SWS_DM_02243]) y bool ([SWS_DM_02244]), así como para elementos completos de tipo DiagnosticSovdContentElementData ([SWS_DM_02246]). Además, la clase ara::diag::DiagnosticSovdContentElementData también proporciona una interfaz PushBack correspondiente para cadenas de caracteres ([SWS_DM_02350]).

usar

La función miembro síncrona PushBack de la clase ara::diag::DiagnosticSovdArrayContentElementDataView (SWS Diagnostics §8.60.5.1.1.10 «PushBack») añade un elemento del tipo DiagnosticSovdContentElementData a una vista de datos de matriz existente ([SWS_DM_02246]). Como parámetro de transferencia asume el objeto que se va a añadir content_element por valor y no posee valor de retorno (void). La declaración se proporciona a través del archivo de encabezado ara/diag/diagnostic_sovd_content_element_data.h.

Concurrencia y precondiciones

La especificación define la función como segura frente a excepciones (exception safe), segura para subprocesos (thread-safe) y anotada con noexcept ([SWS_DM_02246]). Como precondición obligatoria, la operación exige que el elemento actual sea del tipo ArrayContentElementData y que el elemento que se va a añadir coincida exactamente con el tipo fijado en el constructor de ArrayContentElementData ([SWS_DM_02246]).

Tratamiento de errores e interacción

A diferencia de las sobrecargas para tipos primitivos como std::int64_t ([SWS_DM_02241]), std::uint64_t ([SWS_DM_02242]), double ([SWS_DM_02243]), bool ([SWS_DM_02244]) o ara::core::StringView ([SWS_DM_02245]), las cuales devuelven un ara::core::Result<void> para la transmisión de errores, este método devuelve void. Por lo tanto, es probable que sea responsabilidad del llamador comprobar de antemano la compatibilidad de tipos, dado que los errores en tiempo de ejecución en esta interfaz no se señalan a través de un tipo Result. Pregunta Q-00739dff7d34e242 (abierta) En DiagnosticSovdContentElementData también se define un método equivalente para añadir elementos de datos ([SWS_DM_02351]).

El método síncrono Reserve de la clase ara::diag::DiagnosticSovdArrayContentElementDataView sirve para la asignación previa de capacidad de memoria para elementos de datos de matriz ([SWS_DM_02240], SWS Diagnostics §8.60.5.1.1.16 «Reserve»). Se proporciona a través del encabezado #include "ara/diag/diagnostic_sovd_content_element_data.h" y recibe el parámetro capacity de tipo std::size_t, que define la capacidad a suministrar de la DiagnosticSovdArrayContentElementData subyacente ([SWS_DM_02240]). No se devuelve ningún valor de retorno ([SWS_DM_02240]).

En lo relativo al tratamiento de errores, la función está declarada como segura ante excepciones (exception safe), así como noexcept ([SWS_DM_02240]). No utiliza códigos de error a través de ara::core::Result ni excepciones de C++. Interpretación: En caso de escasez de memoria, la asignación probablemente falle internamente o provoque la interrupción del programa, ya que el emisor de la llamada no dispone de un canal de error. Pregunta Q-348805197c004eea (abierta)

En cuanto a la concurrencia, la operación está especificada explícitamente como segura para subprocesos (thread-safe) ([SWS_DM_02240]). Por lo tanto, las llamadas pueden realizarse desde subprocesos paralelos sin bloqueo externo.

En el sistema global, la interfaz complementa funciones de reserva afines: mientras que DiagnosticSovdRecordContentElementDataView::Reserve es análogamente responsable de las estructuras de datos de registro ([SWS_DM_02283], SWS Diagnostics §8.60.11.1.1.20 «Reserve»), la función de la clase base general DiagnosticSovdContentElementData::Reserve devuelve un ara::core::Result<void> para notificar un error en caso de un tipo de elemento incorrecto ([SWS_DM_02345], SWS Diagnostics §8.60.6.1.2.55 «Reserve»). A diferencia de la reserva de memoria no segura para subprocesos DiagnosticServiceDynamicAccessList::Reserve ([SWS_DM_01163], SWS Diagnostics §8.13.1.1.3.3 «Reserve»), este método de vista opera de manera directa y concurrente sobre elementos de matriz SOVD.