En esta página

QCanFrameProcessor Class

La clase QCanFrameProcessor se puede utilizar para decodificar un « QCanBusFrame » o para convertir los datos de entrada en un « QCanBusFrame » listo para enviarse al receptor. Más información...

Encabezado: #include <QCanFrameProcessor>
CMake: find_package(Qt6 REQUIRED COMPONENTS SerialBus)
target_link_libraries(mytarget PRIVATE Qt6::SerialBus)
qmake: QT += serialbus
Desde: Qt 6.5
Estado: Vista previa tecnológica

Esta clase se encuentra en fase de avance tecnológico y está sujeta a cambios.

Tipos públicos

(since 6.5) struct ParseResult
enum class Error { None, InvalidFrame, UnsupportedFrameFormat, Decoding, Encoding }

Funciones públicas

QCanFrameProcessor()
~QCanFrameProcessor()
void addMessageDescriptions(const QList<QCanMessageDescription> &descriptions)
void clearMessageDescriptions()
QCanFrameProcessor::Error error() const
QString errorString() const
QList<QCanMessageDescription> messageDescriptions() const
QCanFrameProcessor::ParseResult parseFrame(const QCanBusFrame &frame)
QCanBusFrame prepareFrame(QtCanBus::UniqueId uniqueId, const QVariantMap &signalValues)
void setMessageDescriptions(const QList<QCanMessageDescription> &descriptions)
void setUniqueIdDescription(const QCanUniqueIdDescription &description)
QCanUniqueIdDescription uniqueIdDescription() const
QStringList warnings() const

Descripción detallada

La clase QCanFrameProcessor opera sobre las descripciones de mensajes CAN (representadas por las clases QCanMessageDescription y QCanSignalDescription ) y una descripción de identificador único (representada por QCanUniqueIdDescription). Utiliza las descripciones para decodificar el « QCanBusFrame » entrante o para codificar los datos especificados por el usuario en la carga útil adecuada.

Antes de realizar cualquier operación de decodificación o codificación, la instancia de QCanFrameProcessor debe inicializarse correctamente. Es necesario proporcionar los siguientes datos:

  • Una descripción del identificador único de valid. Utiliza el método setUniqueIdDescription() para proporcionar una descripción adecuada.
  • Al menos una descripción de mensaje. Utilice el método addMessageDescriptions() o setMessageDescriptions() para proporcionar descripciones de mensajes. Todas las descripciones de mensajes deben tener identificadores únicos distintos. Cada mensaje puede contener varias descripciones de señales, pero los nombres de las señales dentro de un mismo mensaje también deben ser únicos.

El método ` parseFrame()` se puede utilizar para procesar el objeto ` QCanBusFrame` entrante. El método devuelve una estructura ` ParseResult ` que contiene el ` unique identifier ` y el mapa ` signal values `. Las claves del mapa son ` signal names`, y los valores del mapa son los valores de las señales.

El método prepareFrame() puede utilizarse para generar un objeto QCanBusFrame para un identificador único específico, utilizando los nombres de las señales proporcionados y los valores deseados.

Pueden producirse errores durante el proceso de codificación o decodificación. En tales casos, se pueden utilizar los métodos ` error()` y ` errorString()` para obtener información sobre el error.

También pueden producirse algunos problemas no críticos. Dichos problemas se registrarán en el registro, pero el proceso no se detendrá. Una vez finalizado el proceso, se puede utilizar el método warnings() para acceder a la lista de todas las advertencias.

Nota: El último error y su descripción, así como las advertencias, se restablecen una vez que se inicia la decodificación o la codificación.

Véase también QCanMessageDescription y QCanSignalDescription.

Documentación sobre tipos de miembros

enum class QCanFrameProcessor::Error

Esta enumeración representa los posibles errores que pueden producirse al codificar o descodificar el ` QCanBusFrame`.

ConstanteValorDescripción
QCanFrameProcessor::Error::None0No se ha producido ningún error.
QCanFrameProcessor::Error::InvalidFrame1La trama recibida no es válida y no se puede analizar.
QCanFrameProcessor::Error::UnsupportedFrameFormat2El formato de la trama recibida no es compatible y no se puede analizar.
QCanFrameProcessor::Error::Decoding3Se ha producido un error durante la decodificación. Utiliza ` errorString()` para obtener una representación en cadena del error.
QCanFrameProcessor::Error::Encoding4Se ha producido un error durante la codificación. Utilice errorString() para obtener una representación en cadena del error.

Documentación de funciones miembro

QCanFrameProcessor::QCanFrameProcessor()

Crea un procesador de tramas CAN.

[noexcept] QCanFrameProcessor::~QCanFrameProcessor()

Elimina este procesador de fotogramas.

void QCanFrameProcessor::addMessageDescriptions(const QList<QCanMessageDescription> &descriptions)

Añade nuevas descripciones de mensajes « descriptions » a las descripciones de mensajes disponibles.

Todas las descripciones de mensajes deben tener identificadores únicos distintos.

Si algunas descripciones de mensajes tienen identificadores únicos repetidos, solo se utilizará la última descripción.

Si el analizador ya tenía una descripción de mensaje con el mismo identificador único, se sobrescribirá.

Véase también messageDescriptions(), setMessageDescriptions() y clearMessageDescriptions().

void QCanFrameProcessor::clearMessageDescriptions()

Elimina todas las descripciones de los mensajes de este procesador de fotogramas.

Véase también messageDescriptions(), addMessageDescriptions() y setMessageDescriptions().

QCanFrameProcessor::Error QCanFrameProcessor::error() const

Devuelve el último error.

Véase también errorString(), prepareFrame() y parseFrame().

QString QCanFrameProcessor::errorString() const

Devuelve la descripción textual del último error.

Véase también error(), prepareFrame() y parseFrame().

QList<QCanMessageDescription> QCanFrameProcessor::messageDescriptions() const

Devuelve todas las descripciones de mensajes que utiliza actualmente este procesador de tramas.

Véase también addMessageDescriptions(), setMessageDescriptions() y clearMessageDescriptions().

QCanFrameProcessor::ParseResult QCanFrameProcessor::parseFrame(const QCanBusFrame &frame)

Analiza la trama frame utilizando las descripciones de mensajes especificadas.

El proceso de análisis es el siguiente:

  1. Se utiliza la función uniqueIdDescription() para extraer el identificador único del mensaje.
  2. El identificador único extraído se utiliza para buscar un ` QCanMessageDescription ` adecuado en la lista de todos los ` messageDescriptions` disponibles ().
  3. El ` QCanMessageDescription ` coincidente se utiliza para extraer los valores de las señales de la trama.

Este método devuelve un ` QCanFrameProcessor::ParseResult`, que contiene tanto el identificador único extraído como un ` QVariantMap ` con las señales y sus valores. Las claves del mapa son los ` signal names`, y los valores del mapa son los valores de las señales.

Si se ha producido un error durante la decodificación, se devuelve un resultado con un ` signalValues ` vacío. En tales casos, se pueden utilizar los métodos ` error()` y ` errorString()` para obtener información sobre los errores.

Nota: Al llamar a este método se borran todos los errores y advertencias anteriores.

Véase también addMessageDescriptions(), error(), errorString() y warnings().

QCanBusFrame QCanFrameProcessor::prepareFrame(QtCanBus::UniqueId uniqueId, const QVariantMap &signalValues)

Crea un marco de datos CAN utilizando uniqueId y signalValues, y devuelve el objeto creado QCanBusFrame.

El parámetro signalValues debe contener los nombres de las señales como claves y los valores esperados de las señales como valores.

El proceso de creación del marco es el siguiente:

  1. Se utiliza el ` uniqueId ` para buscar una descripción de mensaje adecuada.
  2. Si se encuentra la descripción del mensaje, se crea un ` QCanBusFrame ` con una carga útil del tamaño especificado. Todos los bytes de la carga útil, así como el identificador de la trama, se inicializan a ceros.
  3. Se utiliza la función ` uniqueIdDescription()` para codificar la ` uniqueId ` en la parte correspondiente de la trama (identificador de trama o carga útil).
  4. La descripción del mensaje seleccionada se utiliza para codificar todo el « signalValues » en la trama.
  5. Las partes de la trama que no están cubiertas por un identificador único o por descripciones de señales existentes no se modifican (y, por lo tanto, siguen conteniendo ceros).

Si se produce un error durante la codificación, se devuelve un QCanBusFrame no válido. En tales casos, se pueden utilizar los métodos error() y errorString() para obtener información sobre los errores.

Nota: Al llamar a este método se borran todos los errores y advertencias anteriores.

Véase también addMessageDescriptions(), error(), errorString() y warnings().

void QCanFrameProcessor::setMessageDescriptions(const QList<QCanMessageDescription> &descriptions)

Sustituye las descripciones de mensajes actuales utilizadas por este procesador de tramas por las nuevas descripciones de mensajes descriptions.

Véase también messageDescriptions(), addMessageDescriptions() y clearMessageDescriptions().

void QCanFrameProcessor::setUniqueIdDescription(const QCanUniqueIdDescription &description)

Establece la descripción del identificador único en « description ».

La descripción del identificador único debe ser válida para poder codificar o descodificar las tramas del bus CAN. Consulte la documentación de la clase « QCanUniqueIdDescription » para obtener más detalles.

Véanse también uniqueIdDescription() y QCanUniqueIdDescription.

QCanUniqueIdDescription QCanFrameProcessor::uniqueIdDescription() const

Devuelve la descripción del identificador único.

La descripción del identificador único debe ser válida para poder codificar o descodificar las tramas del bus CAN. Consulta la documentación de la clase QCanUniqueIdDescription para obtener más detalles.

Véase también setUniqueIdDescription() y QCanUniqueIdDescription.

QStringList QCanFrameProcessor::warnings() const

Devuelve la lista de advertencias generadas durante la última llamada de codificación o decodificación.

Véase también error(), errorString(), prepareFrame() y parseFrame().

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.