clase ara::diag::DiagnosticSovdRecordContentElementDataView

usar

La función síncrona [SWS_DM_02288] inserta un valor entero con signo (std::int64_t) bajo la clave especificada key (ara::core::StringView) en una estructura de datos SOVD. Está declarada como método de la clase ara::diag::DiagnosticSovdRecordContentElementDataView e incluida a través del encabezado ara/diag/diagnostic_sovd_content_element_data.h.

Prerrequisitos y tratamiento de errores

Según [SWS_DM_02288], el objeto DiagnosticSovdContentElementData subyacente debe ser del tipo RecordContentElementData o ContentData, mientras que el elemento que se va a añadir no puede ser un ContentData. La función está definida como noexcept y devuelve un ara::core::Result<void>. Si la operación falla —por ejemplo, porque el contenedor de destino posee un tipo incompatible o el elemento no puede añadirse—, el resultado contiene un código de error; interpretación: es de esperar que este sea típicamente el caso también ante colisiones de claves. Pregunta Q-524c832a794559b7 (abierta)

Concurrencia e interacción

La ejecución está especificada como segura para subprocesos y segura frente a excepciones [SWS_DM_02288]. Dentro de la interfaz existen sobrecargas del mismo tipo para enteros sin signo ([SWS_DM_02289]), números de punto flotante ([SWS_DM_02290]), valores booleanos ([SWS_DM_02291]), cadenas de caracteres ([SWS_DM_02292]) así como elementos de datos anidados ([SWS_DM_02293]). El mismo método se proporciona además en la clase portadora DiagnosticSovdContentElementData ([SWS_DM_02368]).

La función miembro sincrónica Add de la clase ara::diag::DiagnosticSovdRecordContentElementDataView sirve para añadir un valor entero sin signo de 64 bits bajo una clave determinada ([SWS_DM_02289]). Se utiliza en el marco de la funcionalidad SOVD de Diagnostic Management, la cual proporciona comunicación de diagnóstico de conformidad con ASAM SOVD (AUTOSAR_AP_SWS_Diagnostics §1.0 «Introduction and functional overview», [SWS_DM_01369]).

Uso y llamada

El método se incluye mediante la cabecera ara/diag/diagnostic_sovd_content_element_data.h. Como parámetros espera el identificador key como ara::core::StringView así como el valor que se va a añadir content_element como std::uint64_t ([SWS_DM_02289]). La llamada se realiza de forma sincrónica, está especificada como noexcept y devuelve el resultado en forma de ara::core::Result<void>.

Tratamiento de errores y condiciones límite

• Condiciones de tipo: el DiagnosticSovdContentElementData instanciado debe ser de tipo RecordContentElementData o bien ContentData. Además, el elemento que se va a añadir no debe ser él mismo de tipo ContentData ([SWS_DM_02289]).
• Comportamiento ante errores: si se infringe uno de estos requisitos de tipo o no se puede añadir el elemento, la función devuelve un ara::core::Result erróneo ([SWS_DM_02289]). La especificación no menciona códigos de error específicos en este punto; es de prever que el objeto Result proporcione un código de error correspondiente del dominio de diagnóstico. Pregunta Q-ffca131eece93b35 (abierta)
• Concurrencia: la función está especificada explícitamente como thread-safe y exception safe ([SWS_DM_02289]).

Interacción

El método pertenece a una familia de sobrecargas tipadas para el registro de elementos de datos primitivos y complejos, entre las que se encuentran variantes para enteros con signo ([SWS_DM_02288]) y subelementos estructurados ([SWS_DM_02293]). Una interfaz equivalente se ofrece en paralelo en la clase DiagnosticSovdContentElementData ([SWS_DM_02369]).

La función miembro síncrona Add de la clase ara::diag::DiagnosticSovdRecordContentElementDataView añade a un registro de datos un valor primitivo de coma flotante de tipo double bajo la clave especificada key [SWS_DM_02290]. La función sirve para componer datos de diagnóstico estructurados para la funcionalidad de servidor SOVD de Diagnostic Management [SWS_DM_01369].

Para la ejecución son válidas las siguientes condiciones previas relativas al tipo [SWS_DM_02290]:

• El objeto de destino debe ser de tipo RecordContentElementData o ContentData.
• El elemento que se va a añadir no puede ser de tipo ContentData en sí mismo.

El método está declarado como noexcept (exception safe) y especificado como seguro frente a hilos (thread-safe) para el acceso concurrente [SWS_DM_02290]. Si falla la adición —por ejemplo, debido a que el tipo de objeto sea incompatible o a que el elemento no se pueda insertar—, se notifica un error a través del ara::core::Result<void> devuelto [SWS_DM_02290]. Interpretación: previsiblemente, la causa exacta del error se reflejará en el ara::core::ErrorCode del objeto de resultado. Pregunta Q-c987f75d785d3e90 (abierta)

En combinación con las sobrecargas afines de Add, el método permite el llenado estructurado de registros de datos SOVD con valores enteros ([SWS_DM_02288], [SWS_DM_02289]), valores booleanos [SWS_DM_02291], cadenas de caracteres [SWS_DM_02292] o datos de elementos más complejos [SWS_DM_02293].

La función Add de la clase ara::diag::DiagnosticSovdRecordContentElementDataView sirve para añadir un valor primitivo booleano bajo una clave especificada a un elemento de datos SOVD [SWS_DM_02291]. La llamada se realiza a través del archivo de encabezado ara/diag/diagnostic_sovd_content_element_data.h con el nombre de parámetro key de tipo ara::core::StringView, así como con el valor de datos útiles content_element de tipo bool [SWS_DM_02291]. Dado que el método devuelve inmediatamente un ara::core::Result<void> y no se especifica asincronía, previsiblemente el proceso se desarrolla de forma síncrona. Pregunta Q-a16b08bf68f8590b (abierta)

El tratamiento de errores se efectúa mediante el ara::core::Result<void> devuelto. Se notifica un error si el DiagnosticSovdContentElementData subyacente no es de tipo RecordContentElementData ni ContentData, o si el elemento no se puede añadir [SWS_DM_02291]. En el extracto de la especificación no se detallan códigos de error específicos.

En lo relativo a la concurrencia y a la seguridad de ejecución, el método está clasificado como thread-safe y ofrece seguridad frente a excepciones (noexcept) [SWS_DM_02291]. Como restricción estructural, la especificación exige que el elemento que se va a añadir no sea de tipo ContentData en sí mismo [SWS_DM_02291].

En el sistema global, este método complementa las sobrecargas afines para enteros con signo [SWS_DM_02288], enteros sin signo [SWS_DM_02289], números de coma flotante [SWS_DM_02290], cadenas de caracteres [SWS_DM_02292], así como elementos de contenido subordinados [SWS_DM_02293]. Además, existe la interfaz análoga en la clase DiagnosticSovdContentElementData [SWS_DM_02371] en el contexto de la funcionalidad de servidor SOVD de Diagnostic Management [SWS_DM_01369].

usar

El método síncrono Add de la clase ara::diag::DiagnosticSovdRecordContentElementDataView sirve para añadir una entrada con una clave y un valor primitivo de cadena de caracteres a un elemento de datos SOVD [SWS_DM_02292]. La llamada se realiza mediante los dos parámetros key y content_element, que se pasan respectivamente como ara::core::StringView [SWS_DM_02292]. Como valor devuelto, la función entrega un ara::core::Result<void> para señalizar el resultado de la operación [SWS_DM_02292].

Manejo de errores

Si la adición falla, el método devuelve un error en el ara::core::Result [SWS_DM_02292]. Esto ocurre si el objeto subyacente no es de tipo RecordContentElementData ni ContentData, o si el elemento no se puede añadir [SWS_DM_02292]. Interpretación: previsiblemente, los códigos de error concretos vendrán determinados por el dominio de errores asociado de la implementación, puesto que la especificación no los enumera explícitamente en la definición de la función. Pregunta Q-ba196615f0cd8fc8 (abierta)

Concurrencia y condiciones de contorno

La operación está declarada como segura frente a hilos (thread-safe) y como segura frente a excepciones (exception safe), y está anotada con noexcept [SWS_DM_02292]. Como condición previa esencial se aplica que el elemento pasado como parámetro no puede ser en sí mismo de tipo ContentData [SWS_DM_02292].

Interacción

La función forma parte de AUTOSAR Diagnostic Management (DM) para la implementación de SOVD para la Adaptive Platform AUTOSAR_AP_SWS_Diagnostics §1 «Introduction and functional overview», actuando DM como servidor SOVD [SWS_DM_01369]. Para el mismo alcance existen sobrecargas análogas de Add para enteros con signo [SWS_DM_02288], enteros sin signo [SWS_DM_02289], números de coma flotante [SWS_DM_02290], valores booleanos [SWS_DM_02291], así como elementos de datos complejos [SWS_DM_02293]. Asimismo, ara::diag::DiagnosticSovdContentElementData proporciona la sobrecarga correspondiente para cadenas de caracteres [SWS_DM_02372].

La función síncrona Add de la clase ara::diag::DiagnosticSovdRecordContentElementDataView añade a un elemento de datos, bajo la clave especificada key, un elemento anidado del tipo DiagnosticSovdContentElementData [SWS_DM_02293]. Esto sirve para la provisión estructurada de datos de diagnóstico en el marco de SOVD (Service-Oriented Vehicle Diagnostics), que es soportado por Diagnostic Management (DM) en la Adaptive Platform ([SWS_DM_01369], AUTOSAR_AP_SWS_Diagnostics §1 «Introduction and functional overview»).

Durante el uso deben cumplirse requisitos obligatorios de tipo:

• El objeto de datos llamador debe ser del tipo RecordContentElementData o ContentData [SWS_DM_02293].
• El elemento que se va a añadir content_element no debe ser explícitamente del tipo ContentData [SWS_DM_02293].
• De manera complementaria a las estructuras de datos complejas, se dispone de sobrecargas independientes para valores elementales, por ejemplo para valores enteros ([SWS_DM_02288], [SWS_DM_02289]), números de punto flotante [SWS_DM_02290], valores booleanos [SWS_DM_02291] o cadenas de caracteres [SWS_DM_02292], tal como también están definidos en DiagnosticSovdContentElementData [SWS_DM_02373].

Para el tratamiento de errores, la función devuelve un ara::core::Result<void>. Si la operación falla —por ejemplo, porque se infringen las condiciones previas de tipo o el elemento no puede insertarse—, el resultado contiene un error [SWS_DM_02293]. Es de suponer que la codificación exacta del error se base probablemente en errores específicos de dominio de la gestión de diagnóstico. Pregunta Q-56c929209d0c7358 (abierta) En cuanto a concurrencia y seguridad, el método está declarado como noexcept, se considera seguro frente a excepciones (exception safe) y está especificado como seguro para subprocesos (thread-safe) para el acceso concurrente [SWS_DM_02293].

Uso y semántica

El método Clear de la clase ara::diag::DiagnosticSovdRecordContentElementDataView sirve para la eliminación síncrona de todos los elementos de contenido de un RecordContentElementData [SWS_DM_02276]. La llamada se realiza sin parámetros a través de la cabecera #include "ara/diag/diagnostic_sovd_content_element_data.h" y no tiene valor de retorno (void) [SWS_DM_02276].

Como requisito previo para la ejecución se define que la instancia de datos subyacente debe ser del tipo RecordContentElementData o ContentData [SWS_DM_02276]. Interpretación: Dado que la función está declarada como noexcept y no notifica ningún estado de error, probablemente el cumplimiento de este tipo de datos ya esté asegurado de antemano al crear el objeto view. Pregunta Q-93e43eee235a8f12 (abierta)

Tratamiento de errores y concurrencia

En cuanto a la seguridad de ejecución, el método está especificado como exception safe y, debido a la declaración noexcept, no lanza excepciones [SWS_DM_02276]. La llamada está catalogada además explícitamente como thread-safe, de modo que se permiten accesos concurrentes [SWS_DM_02276].

Interacción y delimitación

En el entorno SOVD, esta función se diferencia del método Clear sobre DiagnosticSovdContentElementData [SWS_DM_02338], el cual está definido para elementos de array y devuelve un ara::core::Result<void>. Asimismo, existe una distinción funcional respecto al método de vista para arrays [SWS_DM_02233], así como a la eliminación asíncrona de DTC mediante ara::diag::DTCInformation::Clear, que devuelve un ara::core::Future<void> y no es segura para subprocesos [SWS_DM_00671].

La función miembro Erase de la clase ara::diag::DiagnosticSovdRecordContentElementDataView sirve para eliminar un elemento de contenido subordinado de un record de datos de diagnóstico ([SWS_DM_02294], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.14 «Erase»). La declaración se proporciona a través de la cabecera #include "ara/diag/diagnostic_sovd_content_element_data.h" ([SWS_DM_02294]).

Uso y semántica: Como parámetro de entrada, la función toma el iterador iterator del tipo DiagnosticSovdRecordContentElementDataIterator, que apunta al elemento concreto que se desea eliminar ([SWS_DM_02294]). Interpretación: Dado que la función está declarada con noexcept y devuelve directamente ara::core::Result<void> en lugar de un objeto future, el proceso de eliminación probablemente se ejecute de forma síncrona en el subproceso del llamador. Pregunta Q-148ae95c28910b16 (abierta) En caso de ejecución correcta, el método devuelve un ara::core::Result<void> vacío ([SWS_DM_02294]).

Tratamiento de errores: La operación falla si el elemento de datos afectado no es ni del tipo RecordContentElementData ni ContentData o si el elemento no pudo eliminarse del contenedor ([SWS_DM_02294]). En estos casos de error, la función devuelve un error con el código de error DiagErrc::kInvalidArgument ([SWS_DM_02294]).

Concurrencia e interacción: Para la llamada, la interfaz está especificada como thread-safe y exception safe ([SWS_DM_02294]). Desde el punto de vista funcional, la función se corresponde con la variante de array ara::diag::DiagnosticSovdArrayContentElementDataView::Erase ([SWS_DM_02247], AUTOSAR_AP_SWS_Diagnostics §8.60.5.1.1.8 «Erase») e interactúa con las operaciones elementales de eliminación de la clase contenedora DiagnosticSovdContentElementData para arrays ([SWS_DM_02352]) y records ([SWS_DM_02374]).

La función miembro síncrona Find de la clase vista ara::diag::DiagnosticSovdRecordContentElementDataView sirve para encontrar un elemento a partir de su clave ([SWS_DM_02285], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.15 «Find»). Como parámetro se pasa key del tipo ara::core::StringView; como resultado, la función devuelve un iterador modificable del tipo DiagnosticSovdRecordContentElementDataIterator ([SWS_DM_02285]). El requisito previo para su uso es que el DiagnosticSovdContentElementData asociado sea del tipo RecordContentElementData o ContentData ([SWS_DM_02285]).

En cuanto al tratamiento de errores y a la concurrencia, la función está declarada como noexcept, se considera segura frente a excepciones (exception safe) y, según la especificación, es segura para subprocesos (thread-safe) ([SWS_DM_02285]). Dado que el tipo de retorno es directamente un iterador y no un ara::core::Result, la función no notifica códigos de error específicos; si la clave buscada no existe, es de suponer que se devuelva un iterador final. Pregunta Q-a34054c9851517ae (abierta)

En interacción con interfaces relacionadas, existe en la misma clase vista una sobrecarga constante ([SWS_DM_02286], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.16 «Find») que devuelve un DiagnosticSovdRecordContentElementDataConstIterator. La clase DiagnosticSovdRecordContentElementDataConstView también ofrece una interfaz constante análoga ([SWS_DM_02306], AUTOSAR_AP_SWS_Diagnostics §8.60.9.1.1.7 «Find»). Por el contrario, el método Find en DiagnosticSovdContentElementData encapsula su iterador en un ara::core::Result para representar tipos no válidos o claves faltantes como errores ([SWS_DM_02365], [SWS_DM_02366], AUTOSAR_AP_SWS_Diagnostics §8.60.6.1.2.25 «Find»).

La función miembro síncrona Find de la clase ara::diag::DiagnosticSovdRecordContentElementDataView sirve para la búsqueda de solo lectura de un elemento de datos mediante su clave ([SWS_DM_02286], AUTOSAR AP SWS Diagnostics §8.60.11.1.1.16 «Find»).

Uso y parámetros

La función recibe la clave buscada key como ara::core::StringView ([SWS_DM_02286]). El requisito previo para la llamada es que la instancia sea del tipo de diagnóstico RecordContentElementData o ContentData ([SWS_DM_02286]). Como valor de retorno proporciona de forma síncrona un iterador constante del tipo DiagnosticSovdRecordContentElementDataConstIterator ([SWS_DM_02286]). Si no existe ningún elemento que coincida con la clave, presumiblemente se devuelva un iterador que marque el final de la secuencia (interpretación). Pregunta Q-41a1eba77c0bc236 (abierta)

Tratamiento de errores y concurrencia

La interfaz está declarada con noexcept, garantiza seguridad frente a excepciones (exception safe) y está especificada como segura para subprocesos (thread-safe) para el acceso concurrente ([SWS_DM_02286]). A diferencia del método sobre ara::diag::DiagnosticSovdContentElementData ([SWS_DM_02366]), no se produce ningún retorno mediante ara::core::Result, por lo que los casos de error no se representan mediante códigos de error.

Interacción

Para accesos de escritura o de modificación sobre la misma vista existe la sobrecarga no constante [SWS_DM_02285] con iterador modificable. Para vistas de solo lectura, la clase DiagnosticSovdRecordContentElementDataConstView proporciona una función Find análoga ([SWS_DM_02306]).

La función de elemento síncrona Remove de la clase ara::diag::DiagnosticSovdRecordContentElementDataView sirve para la eliminación selectiva de una entrada a partir de su clave [SWS_DM_02287]. Está definida en el encabezado ara/diag/diagnostic_sovd_content_element_data.h y procesa el parámetro key de tipo ara::core::StringView AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.19 «Remove».

Como valor de retorno, la función devuelve un ara::core::Result<bool> [SWS_DM_02287]:

• En caso de éxito, el valor booleano contenido señaliza si el elemento direccionado realmente se ha podido eliminar.
• Se notifica un error a través de ara::core::Result si el elemento no es de tipo RecordContentElementData ni ContentData, o bien si no se encontró la clave especificada [SWS_DM_02287].

Respecto a la concurrencia y las restricciones, la función está especificada como segura contra excepciones (exception safe) y segura para hilos (thread-safe), así como declarada con noexcept [SWS_DM_02287]. Como condición de llamada, la especificación exige obligatoriamente que la instancia subyacente sea de tipo RecordContentElementData o ContentData [SWS_DM_02287].

Interpretación: desde el punto de vista funcional, la operación probablemente corresponda a la eliminación en la clase de datos ara::diag::DiagnosticSovdContentElementData::Remove [SWS_DM_02367], ya que la firma, los parámetros y los escenarios de error están especificados de forma completamente idéntica AUTOSAR_AP_SWS_Diagnostics §8.60.6.1.2.54 «Remove». Pregunta Q-5a9ac29a9b5814be (abierta)

El método Reserve de la clase ara::diag::DiagnosticSovdRecordContentElementDataView ([SWS_DM_02283], AUTOSAR_AP_SWS_Diagnostics §8.60.11.1.1.20 «Reserve») reserva de forma síncrona la capacidad de memoria deseada para RecordContentElementData. La llamada 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. Como valor de retorno, la función proporciona void.

La interfaz está declarada como noexcept y especificada como segura ante excepciones («exception safe») ([SWS_DM_02283]). No se devuelven códigos de error específicos ni estructuras de error. Interpretación: Si la asignación de la capacidad requerida falla, es probable que el error se intercepte internamente a falta de un canal de retorno como ara::core::Result o que provoque la interrupción del programa. Pregunta Q-ddbaac36f8ed58ad (abierta)

Con respecto a la concurrencia, la función está definida como segura para subprocesos («thread-safe») ([SWS_DM_02283]). Por lo tanto, se puede llamar en paralelo y sin medidas de sincronización adicionales desde múltiples subprocesos.

En interacción con interfaces afines, la variante de matriz DiagnosticSovdArrayContentElementDataView::Reserve ([SWS_DM_02240]) se comporta de forma análoga. A diferencia de esta, DiagnosticSovdContentElementData::Reserve ([SWS_DM_02345]) devuelve un ara::core::Result<void> para notificar conflictos de tipo. La función DiagnosticServiceDynamicAccessList::Reserve ([SWS_DM_01163]), por el contrario, sirve para una asignación previa para el peor de los casos (worst-case) para patrones de servicio, espera dos parámetros y no es segura para subprocesos.