En esta página

QCanDbcFileParser Class

La clase QCanDbcFileParser se puede utilizar para analizar archivos DBC. Más información...

Encabezado: #include <QCanDbcFileParser>
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 vista previa tecnológica y está sujeta a cambios.

Tipos públicos

enum class Error { None, FileReading, Parsing }
MessageValueDescriptions
SignalValueDescriptions
ValueDescriptions

Funciones públicas

QCanDbcFileParser()
~QCanDbcFileParser()
QCanDbcFileParser::Error error() const
QString errorString() const
QList<QCanMessageDescription> messageDescriptions() const
QCanDbcFileParser::MessageValueDescriptions messageValueDescriptions() const
bool parse(const QString &fileName)
bool parse(const QStringList &fileNames)
(since 6.7) bool parseData(QStringView data)
QStringList warnings() const

Miembros públicos estáticos

QCanUniqueIdDescription uniqueIdDescription()

Descripción detallada

Una base de datos CAN o un archivo DBC de CAN es un archivo de texto ASCII que contiene información sobre cómo decodificar e interpretar los datos sin procesar del bus CAN. Se puede encontrar más información sobre el formato aquí o aquí.

La clase `QCanDbcFileParser` toma el archivo DBC de entrada, lo analiza y proporciona una lista de ` QCanMessageDescription` como salida. Estas descripciones de mensajes pueden reenviarse a ` QCanFrameProcessor` y utilizarse posteriormente como reglas para codificar o decodificar ` QCanBusFrame`.

Utilice una de las sobrecargas de ` parse()` para especificar un archivo o una lista de archivos que se van a procesar. Ambas sobrecargas devuelven ` true ` si el análisis se completa con éxito y ` false ` en caso contrario.

Llama al método error() para obtener el error que se ha producido durante el análisis. Si el análisis se completa con éxito, este método devolverá None. En caso contrario, puedes utilizar el método errorString() para obtener la representación en forma de cadena de un error.

Durante el análisis también pueden producirse algunos problemas no críticos. Dichos problemas se registrarán en el log, pero el proceso de análisis no se interrumpirá. Puede utilizar el método ` warnings()` para obtener la lista completa de dichos problemas una vez finalizado el análisis.

Si el análisis se completa con éxito, llame a messageDescriptions() para obtener una lista de las descripciones de los mensajes que se extrajeron durante la última llamada a parse(). Llame a messageValueDescriptions() para obtener las descripciones textuales de los valores brutos de las señales, si están disponibles.

Utilice la función estática ` uniqueIdDescription()` para obtener un ` QCanUniqueIdDescription ` para el formato DBC.

QCanDbcFileParser fileParser;
const bool result = fileParser.parse(u"path/to/file.dbc"_s);
// Check result, call error() and warnings() if needed

// Prepare a QCanFrameProcessor to decode or encode DBC frames
QCanFrameProcessor frameProcessor;
frameProcessor.setUniqueIdDescription(QCanDbcFileParser::uniqueIdDescription());
frameProcessor.setMessageDescriptions(fileParser.messageDescriptions());

Nota: El analizador tiene estado, lo que significa que todos los resultados (como las descripciones de los mensajes extraídos, los códigos de error o las advertencias) se restablecen una vez que comienza el siguiente análisis.

Palabras clave admitidas

La implementación actual solo admite un subconjunto de palabras clave que se pueden encontrar en un archivo DBC:

  • BO_ - descripción del mensaje.
  • SG_ - Descripción de la señal.
  • SIG_VALTYPE_ - Descripción del tipo de señal.
  • SG_MUL_VAL_ - Descripción de la multiplexación ampliada.
  • CM_ - Comentarios (solo para las descripciones de mensajes y señales).
  • VAL_ - Descripciones textuales de los valores brutos de las señales.

Las líneas que comienzan con otras palabras clave simplemente se ignoran.

Véase también QCanMessageDescription y QCanFrameProcessor.

Documentación sobre tipos de miembros

enum class QCanDbcFileParser::Error

Esta enumeración representa los posibles errores que pueden producirse durante el análisis de un archivo DBC.

ConstanteValorDescripción
QCanDbcFileParser::Error::None0No se ha producido ningún error.
QCanDbcFileParser::Error::FileReading1Se ha producido un error al abrir o leer el archivo.
QCanDbcFileParser::Error::Parsing2Se ha producido un error al analizar el contenido del archivo.

[alias] QCanDbcFileParser::MessageValueDescriptions

Este es un alias de tipo para QHash<QtCanBus::UniqueId, SignalValueDescriptions>.

Las claves del hash representan los identificadores únicos de los mensajes, y los valores del hash contienen las entradas correspondientes de QCanDbcFileParser::SignalValueDescriptions.

Véase también QCanDbcFileParser::SignalValueDescriptions.

[alias] QCanDbcFileParser::SignalValueDescriptions

Este es un alias de tipo para QHash<QString, ValueDescriptions>.

Las claves del hash representan nombres de señales, y los valores del hash contienen las entradas correspondientes de ` QCanDbcFileParser::ValueDescriptions `.

Véase también QCanDbcFileParser::ValueDescriptions.

[alias] QCanDbcFileParser::ValueDescriptions

Este es un alias de tipo para ` QHash<quint32, QString>`.

Las claves del hash representan valores de señal sin procesar, y los valores del hash representan las descripciones correspondientes en forma de cadena.

Documentación de las funciones de miembro

QCanDbcFileParser::QCanDbcFileParser()

Crea un analizador de archivos DBC.

[noexcept] QCanDbcFileParser::~QCanDbcFileParser()

Elimina este analizador de archivos DBC.

QCanDbcFileParser::Error QCanDbcFileParser::error() const

Devuelve el último error que se ha producido durante el análisis sintáctico.

Véase también errorString() y parse().

QString QCanDbcFileParser::errorString() const

Devuelve la representación textual del último error que se produjo durante el análisis sintáctico o una cadena vacía si no se produjo ningún error.

Véase también error().

QList<QCanMessageDescription> QCanDbcFileParser::messageDescriptions() const

Devuelve la lista de descripciones de mensajes que se extrajeron durante la última llamada a parse().

Véase también parse() y error().

QCanDbcFileParser::MessageValueDescriptions QCanDbcFileParser::messageValueDescriptions() const

Devuelve las descripciones textuales de los valores brutos de las señales.

DBC admite la posibilidad de proporcionar descripciones textuales a los valores brutos de las señales. Si dichos datos existen en los archivos DBC analizados, se puede acceder a ellos mediante esta función.

Las descripciones textuales son únicas para una señal determinada dentro de un mensaje específico, por lo que la estructura devuelta contiene la información sobre el identificador único del mensaje y el nombre de la señal, así como las descripciones de los valores reales.

Véase también QCanDbcFileParser::MessageValueDescriptions, QCanDbcFileParser::SignalValueDescriptions y QCanDbcFileParser::ValueDescriptions.

bool QCanDbcFileParser::parse(const QString &fileName)

Analiza el archivo « fileName ». Devuelve « true » si el análisis se ha completado correctamente o « false » en caso contrario.

Si el análisis se ha completado correctamente, llama al método messageDescriptions() para obtener la lista de todas las descripciones de mensajes extraídas.

Si el análisis falla, llama a los métodos error() y errorString() para obtener información sobre el error.

Llama al método ` warnings()` para obtener la lista de advertencias que se registraron durante el análisis.

Nota: Este método espera que el contenido del archivo esté codificado en UTF-8. Si el archivo tiene una codificación diferente, descódificalo primero y utiliza parseData() para extraer la información DBC.

Véanse también messageDescriptions(), error(), warnings() y parseData().

bool QCanDbcFileParser::parse(const QStringList &fileNames)

Analiza una lista de archivos fileNames. Devuelve true si el análisis se ha completado correctamente o false en caso contrario.

Si el análisis se ha completado correctamente, llama al método messageDescriptions() para obtener la lista de todas las descripciones de mensajes extraídas.

El análisis se detiene ante el primer error. Llama a los métodos error() y errorString() para obtener información sobre el error.

Llama al método ` warnings()` para obtener la lista de advertencias que se registraron durante el análisis.

Nota: Este método espera que el contenido del archivo esté codificado en UTF-8. Si el archivo tiene una codificación diferente, descódificalo primero y utiliza parseData() para extraer la información DBC.

Esta es una función sobrecargada.

Véase también messageDescriptions(), error(), warnings() y parseData().

[since 6.7] bool QCanDbcFileParser::parseData(QStringView data)

Analiza los datos de entrada data y devuelve true si el análisis se ha completado correctamente o false en caso contrario.

Si el análisis se ha completado correctamente, llama al método messageDescriptions() para obtener la lista de todas las descripciones de mensajes extraídas.

Si el análisis ha fallado, llama a los métodos error() y errorString() para obtener la información sobre el error.

Llama al método ` warnings()` para obtener la lista de advertencias que se registraron durante el análisis.

El método espera que ` data ` sea el contenido de un archivo DBC válido, convertido correctamente a ` QStringView`.

Utiliza este método cuando el archivo de entrada tenga una codificación distinta de UTF-8.

// Read the data from a DBC file with custom encoding
const QByteArray initialData = ...;
// Convert to UTF-16 using QStringDecoder or some other way
const QString decodedData = ...;
QCanDbcFileParser parser;
const bool result = parser.parseData(decodedData);

Esta función se introdujo en Qt 6.7.

Véase también messageDescriptions(), error(), warnings() y parse().

[static] QCanUniqueIdDescription QCanDbcFileParser::uniqueIdDescription()

Devuelve una descripción del identificador único. El protocolo DBC siempre utiliza el ID de trama como identificador, por lo que la descripción del identificador único es siempre la misma.

Utiliza este método para obtener una instancia de ` QCanUniqueIdDescription ` y pásala a ` QCanFrameProcessor`.

Véase también QCanFrameProcessor::setUniqueIdDescription().

QStringList QCanDbcFileParser::warnings() const

Devuelve la lista de problemas no críticos que se han producido durante el análisis sintáctico.

Un problema típico puede ser un mensaje o una descripción de señal con formato incorrecto. En tales casos, se omite el mensaje o la señal con formato incorrecto, pero el resto del archivo se puede procesar con normalidad.

Véanse también error() y parse().

© 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.