En esta página

QCanSignalDescription Class

La clase QCanSignalDescription describe las reglas para extraer un valor de la trama CAN y representarlo en un formato definido por la aplicación. Más información...

Encabezado: #include <QCanSignalDescription>
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

Funciones públicas

QCanSignalDescription()
QCanSignalDescription(const QCanSignalDescription &other)
QCanSignalDescription(QCanSignalDescription &&other)
~QCanSignalDescription()
void addMultiplexSignal(const QString &name, const QCanSignalDescription::MultiplexValues &ranges)
void addMultiplexSignal(const QString &name, const QVariant &value)
quint16 bitLength() const
void clearMultiplexSignals()
QString comment() const
QSysInfo::Endian dataEndian() const
QtCanBus::DataFormat dataFormat() const
QtCanBus::DataSource dataSource() const
double factor() const
bool isValid() const
double maximum() const
double minimum() const
QCanSignalDescription::MultiplexSignalValues multiplexSignals() const
QtCanBus::MultiplexState multiplexState() const
QString name() const
double offset() const
QString physicalUnit() const
QString receiver() const
double scaling() const
void setBitLength(quint16 length)
void setComment(const QString &text)
void setDataEndian(QSysInfo::Endian endian)
void setDataFormat(QtCanBus::DataFormat format)
void setDataSource(QtCanBus::DataSource source)
void setFactor(double factor)
void setMultiplexSignals(const QCanSignalDescription::MultiplexSignalValues &multiplexorSignals)
void setMultiplexState(QtCanBus::MultiplexState state)
void setName(const QString &name)
void setOffset(double offset)
void setPhysicalUnit(const QString &unit)
void setRange(double minimum, double maximum)
void setReceiver(const QString &receiver)
void setScaling(double scaling)
void setStartBit(quint16 bit)
quint16 startBit() const
QCanSignalDescription &operator=(QCanSignalDescription &&other)
QCanSignalDescription &operator=(const QCanSignalDescription &other)

Descripción detallada

La clase QCanSignalDescription se puede utilizar para proporcionar una descripción de una señal y, posteriormente, utilizarla para decodificar una « QCanBusFrame » recibida o codificar los datos de entrada en una « QCanBusFrame » que se pueda enviar al receptor.

Descripción general

Cada trama CAN puede contener varios valores. Las reglas para extraer los valores de una trama CAN incluyen lo siguiente:

  • Fuente de datos (ID de trama o carga útil).
  • Endianidad de los datos. Consulte la sección « Data Endianness Processing » para obtener más detalles.
  • Formato de los datos.
  • Posición del bit de inicio.
  • Longitud de los datos en bits.
  • Opciones de multiplexación.

La posición del bit de inicio se especifica en relación con la fuente de datos seleccionada. Los bits se cuentan a partir del LSB.

Una vez extraídos los datos, puede ser necesario convertirlos a un formato definido por la aplicación. Para ello, se pueden utilizar los siguientes parámetros:

  • Varios parámetros para convertir el valor extraído en un valor físico (factor, desplazamiento, escala).
  • Rango de datos esperado.
  • Unidades de datos.

La clase QCanSignalDescription proporciona métodos para controlar todos esos parámetros.

Procesamiento del orden de los bytes

Los datos «little endian» y «big endian» se codifican de forma diferente. En el caso de los valores «big endian», las posiciones de los bits iniciales corresponden al bit más significativo. En el caso de los valores «little endian», la posición inicial es la del bit menos significativo.

Veamos dos ejemplos. En ambos casos codificaremos dos valores de 12 bits en la carga útil de 3 bytes.

Little endian

En el caso «little endian», la disposición de los datos puede representarse mediante la siguiente imagen:

Disposición de los bits de señal CAN en formato «little endian»: bloques azules y naranjas que muestran dos valores en los bytes 0-2 con las posiciones del bit menos significativo (LSB) y del bit más significativo (MSB)

Aquí, las columnas representan los números de bits y las filas, los números de bytes. LSB marca el primer bit (menos significativo) del valor, y MSB marca el último bit (más significativo) del valor. El color azul marca el primer valor y el color naranja, el segundo.

La información sobre estos valores se codificará en QCanSignalDescription de la siguiente manera:

QCanSignalDescription signal1;
signal1.setDataEndian(QSysInfo::Endian::LittleEndian);
signal1.setStartBit(0);
signal1.setBitLength(12);
// other parameters for signal1

QCanSignalDescription signal2;
signal2.setDataEndian(QSysInfo::Endian::LittleEndian);
signal2.setStartBit(12);
signal2.setBitLength(12);
// other parameters for signal2
Big Endian

La siguiente imagen muestra la disposición de los valores en el caso «big endian»:

Disposición de los bits de la señal CAN en formato «big endian»: bloques azules y naranjas que muestran dos valores en los bytes 0-2 con las posiciones del bit más significativo (MSB) y del bit menos significativo (LSB)

Los valores pueden representarse en QCanSignalDescription de la siguiente manera:

QCanSignalDescription signal1;
signal1.setDataEndian(QSysInfo::Endian::BigEndian);
signal1.setStartBit(7);
signal1.setBitLength(12);
// other parameters for signal1

QCanSignalDescription signal2;
signal2.setDataEndian(QSysInfo::Endian::BigEndian);
signal2.setStartBit(11);
signal2.setBitLength(12);
// other parameters for signal2

Obsérvese cómo los bits iniciales difieren de los del caso «little endian». Además, los valores están alineados de forma diferente.

Explicación de las señales multiplexadas

Existen dos formas habituales de codificar los datos en la carga útil CAN:

  • Cada rango de bits representa siempre la misma señal. Por ejemplo, Bytes 0-1 en una carga útil puede representar la velocidad del motor (en rpm), y Bytes 2-3 puede representar la velocidad del vehículo (en km/h).
  • La misma secuencia de bits puede representar datos diferentes, dependiendo de los valores de otros bits de la carga útil. Por ejemplo, si Byte 0 tiene el valor 0, el Bytes 1-2 representa la velocidad del motor (en rpm), y si Byte 0 tiene el valor 1, el mismo Bytes 1-2 representa la velocidad del vehículo (en km/h).

El segundo caso utiliza la multiplexación de señales. En el ejemplo proporcionado tendremos tres señales. La primera señal representa el valor de Byte 0 y actúa como una señal de multiplexor. Las otras dos señales representan, respectivamente, el régimen del motor y la velocidad del vehículo, pero solo se puede extraer una de ellas de la carga útil CAN a la vez. La señal que se debe extraer viene definida por el valor de la señal del multiplexor.

En casos más complejos, la carga útil puede contener varias señales de multiplexor. En tales casos, la señal solo puede extraerse de la carga útil cuando todos los multiplexores contengan los valores esperados.

Conversiones de valores

En muchos casos, las señales transmitidas a través del bus CAN no pueden abarcar todo el rango de los valores físicos que representan. Para superar estas limitaciones, los valores físicos se convierten a un rango más reducido antes de la transmisión y pueden restaurarse en el extremo receptor.

Se utilizan las siguientes fórmulas para realizar la conversión entre el valor físico y el valor de la señal:

physicalValue = scaling * (signalValue * factor + offset);
signalValue = (physicalValue / scaling - offset) / factor;

El factor y los parámetros de escalado no pueden ser iguales a 0.

Si alguno de los parámetros es igual a qQNaN(), no se utiliza durante la conversión. Si todos los parámetros son iguales a qQNaN() (que es el valor por defecto), no se realiza la conversión.

Documentación sobre los tipos de miembro

[alias] QCanSignalDescription::MultiplexSignalValues

[alias] QCanSignalDescription::MultiplexValues

Documentación sobre funciones de miembro

QCanSignalDescription::QCanSignalDescription()

Crea una descripción de señal vacía.

QCanSignalDescription::QCanSignalDescription(const QCanSignalDescription &other)

Crea una descripción de la señal con los valores copiados de other.

[constexpr noexcept default] QCanSignalDescription::QCanSignalDescription(QCanSignalDescription &&other)

Crea una descripción de señal a partir de other.

Nota: El objeto `QCanSignalDescription` del que se ha realizado la migración solo puede ser destruido o asignado. El efecto de llamar a otras funciones que no sean el destructor o uno de los operadores de asignación es indefinido.

[constexpr noexcept default] QCanSignalDescription::~QCanSignalDescription()

Elimina esta descripción de la señal.

void QCanSignalDescription::addMultiplexSignal(const QString &name, const QCanSignalDescription::MultiplexValues &ranges)

Añade un nuevo « multiplexor signal » para esta señal. El parámetro « name » contiene el nombre de la señal del multiplexor, y el parámetro « ranges » contiene los rangos de valores deseados.

Si esta señal ya tiene rangos de valores deseados para la señal del multiplexor name, dichos rangos se sobrescriben.

Véanse también multiplexState(), multiplexSignals(), clearMultiplexSignals() y setMultiplexSignals().

void QCanSignalDescription::addMultiplexSignal(const QString &name, const QVariant &value)

Se trata de una sobrecarga de conveniencia para el caso en el que se espera que la señal del multiplexor tenga solo un valor específico, y no un rango de valores.

El parámetro « name » contiene el nombre de la señal del multiplexor, y el parámetro « value » contiene el valor deseado.

Si esta señal ya tiene rangos de valores deseados para la señal del multiplexor name, dichos rangos se sobrescriben.

Esta es una función sobrecargada.

Véanse también multiplexState(), multiplexSignals(), clearMultiplexSignals() y setMultiplexSignals().

quint16 QCanSignalDescription::bitLength() const

Devuelve la longitud en bits del valor de la señal.

Véase también setBitLength(), startBit() y setStartBit().

void QCanSignalDescription::clearMultiplexSignals()

Elimina todos los « multiplexor signals » de esta señal.

Véanse también multiplexSignals(), setMultiplexSignals() y addMultiplexSignal().

QString QCanSignalDescription::comment() const

Devuelve el comentario correspondiente a la señal.

Este parámetro se incluye únicamente a modo de descripción adicional. No se utiliza durante el procesamiento de señales.

Véase también setComment().

QSysInfo::Endian QCanSignalDescription::dataEndian() const

Devuelve el endianismo de los datos del valor de la señal.

Por defecto, se utiliza « BigEndian ».

Nota: El endianismo de los datos se ignora si la función ` dataFormat()` está establecida en ` AsciiString`.

Véase también setDataEndian() y QSysInfo::Endian.

QtCanBus::DataFormat QCanSignalDescription::dataFormat() const

Devuelve el formato de datos del valor de la señal.

Por defecto, se utiliza « SignedInteger ».

Véase también setDataFormat() y QtCanBus::DataFormat.

QtCanBus::DataSource QCanSignalDescription::dataSource() const

Devuelve la fuente de datos del valor de la señal.

Por defecto, se utiliza Payload.

Véase también setDataSource() y QtCanBus::DataSource.

double QCanSignalDescription::factor() const

Devuelve el factor que se utiliza para convertir el valor de la señal en un valor físico y viceversa.

Por defecto, la función devuelve ` qQNaN()`, lo que significa que no se utiliza ningún factor.

En la sección « Value Conversions » se explica cómo se utiliza este parámetro.

Véase también setFactor(), offset() y scaling().

bool QCanSignalDescription::isValid() const

Devuelve ` true ` cuando la descripción de la señal es válida y ` false ` en caso contrario.

Una descripción de señal válida debe cumplir las siguientes condiciones:

Véanse también bitLength(), dataFormat() y name().

double QCanSignalDescription::maximum() const

Devuelve el valor máximo admitido para la señal.

Por defecto, la función devuelve qQNaN(), lo que significa que no hay ningún valor máximo.

Véase también ` setRange()` y ` minimum()`.

double QCanSignalDescription::minimum() const

Devuelve el valor mínimo admitido para la señal.

Por defecto, la función devuelve qQNaN(), lo que significa que no hay ningún valor mínimo.

Véase también setRange() y maximum().

QCanSignalDescription::MultiplexSignalValues QCanSignalDescription::multiplexSignals() const

Devuelve los « multiplexor signals » y sus valores deseados, que se utilizan para identificar correctamente esta señal.

El hash devuelto contiene los nombres de las señales como claves y los rangos de valores deseados correspondientes como valores.

El valor de esta señal solo se puede extraer de la carga útil cuando todas las señales del hash tienen los valores esperados.

Véanse también multiplexState(), clearMultiplexSignals(), setMultiplexSignals() y addMultiplexSignal().

QtCanBus::MultiplexState QCanSignalDescription::multiplexState() const

Devuelve el estado de multiplexación de la señal.

Consulta la sección « Multiplexed Signals Explained » para obtener más detalles sobre las señales multiplexadas.

Por defecto, este método devuelve « None ».

Véase también « setMultiplexState()» y « QtCanBus::MultiplexState ».

QString QCanSignalDescription::name() const

Devuelve el nombre de la señal.

Véase también setName() y isValid().

double QCanSignalDescription::offset() const

Devuelve el desplazamiento que se utiliza para convertir el valor de la señal en un valor físico y viceversa.

Por defecto, la función devuelve ` qQNaN()`, lo que significa que no se utiliza ningún desplazamiento.

En la sección « Value Conversions » se explica cómo se utiliza este parámetro.

Véanse también setOffset(), factor() y scaling().

QString QCanSignalDescription::physicalUnit() const

Devuelve la unidad física (por ejemplo, km/h) del valor de la señal o una cadena vacía si no se ha establecido la unidad.

Este parámetro se incluye únicamente a título informativo. No se utiliza durante el procesamiento de la señal.

Véase también setPhysicalUnit().

QString QCanSignalDescription::receiver() const

Devuelve el nodo receptor de esta señal.

Este parámetro se incluye únicamente a título informativo. No se utiliza durante el procesamiento de la señal.

Véase también setReceiver().

double QCanSignalDescription::scaling() const

Devuelve el factor de escala que se utiliza para convertir el valor de la señal en un valor físico y viceversa.

Por defecto, la función devuelve ` qQNaN()`, lo que significa que no se utiliza ninguna escala.

En la sección « Value Conversions » se explica cómo se utiliza este parámetro.

Véase también setScaling(), offset() y factor().

void QCanSignalDescription::setBitLength(quint16 length)

Establece la longitud en bits del valor de la señal en length.

Véase también bitLength(), startBit() y setStartBit().

void QCanSignalDescription::setComment(const QString &text)

Establece el comentario de la señal en « text ».

Este parámetro se incluye únicamente a modo de descripción adicional. No se utiliza durante el procesamiento de la señal.

Véase también ` comment()`.

void QCanSignalDescription::setDataEndian(QSysInfo::Endian endian)

Establece el endianismo de los datos del valor de la señal en « endian ».

Véase también dataEndian() y QSysInfo::Endian.

void QCanSignalDescription::setDataFormat(QtCanBus::DataFormat format)

Establece el formato de datos del valor de la señal en « format ».

Véase también dataFormat() y QtCanBus::DataFormat.

void QCanSignalDescription::setDataSource(QtCanBus::DataSource source)

Establece la fuente de datos del valor de la señal en source.

Véase también dataSource() y QtCanBus::DataSource.

void QCanSignalDescription::setFactor(double factor)

Establece el factor que se utiliza para convertir el valor de la señal en un valor físico y viceversa, utilizando ` factor`.

Pasa qQNaN() a este método para omitir este parámetro durante la conversión.

El factor no puede ser 0. Intentar establecer un factor igual a cero equivale a establecerlo en ` qQNaN()`.

En la sección « Value Conversions » se explica cómo se utiliza este parámetro.

Véase también factor(), setOffset() y setScaling().

void QCanSignalDescription::setMultiplexSignals(const QCanSignalDescription::MultiplexSignalValues &multiplexorSignals)

Establece el « multiplexor signals » de esta señal en « multiplexorSignals ».

El hash « multiplexorSignals » debe contener los nombres de las señales como claves y los respectivos rangos de valores deseados como valores.

Véanse también multiplexState(), multiplexSignals(), clearMultiplexSignals() y addMultiplexSignal().

void QCanSignalDescription::setMultiplexState(QtCanBus::MultiplexState state)

Establece el estado de multiplexación de la señal en « state ».

Consulte la sección « Multiplexed Signals Explained » para obtener más detalles sobre las señales multiplexadas.

Véanse también « multiplexState()» y « QtCanBus::MultiplexState ».

void QCanSignalDescription::setName(const QString &name)

Establece el nombre de la señal como « name ».

El nombre de la señal debe ser único dentro de un mensaje CAN.

Véase también name().

void QCanSignalDescription::setOffset(double offset)

Establece el desplazamiento que se utiliza para convertir el valor de la señal en un valor físico y, a la inversa, en un valor de « offset ».

Pasa ` qQNaN()` a este método para omitir este parámetro durante la conversión.

En la sección « Value Conversions » se explica cómo se utiliza este parámetro.

Véase también ` offset()`, ` setFactor()` y ` setScaling()`.

void QCanSignalDescription::setPhysicalUnit(const QString &unit)

Establece la unidad física unit (p. ej., km/h) del valor de la señal.

Este parámetro se incluye únicamente a título descriptivo. No se utiliza durante el procesamiento de la señal.

Véase también physicalUnit().

void QCanSignalDescription::setRange(double minimum, double maximum)

Establece los valores de ` minimum ` y ` maximum ` para el valor de la señal.

Si se establece uno o ambos parámetros en qQNaN(), el límite correspondiente no se aplicará.

Véase también minimum() y maximum().

void QCanSignalDescription::setReceiver(const QString &receiver)

Establece el nodo « receiver » para esta señal.

Este parámetro se incluye únicamente a título informativo. No se utiliza durante el procesamiento de la señal.

Véase también receiver().

void QCanSignalDescription::setScaling(double scaling)

Establece la escala que se utiliza para convertir el valor de la señal en un valor físico y viceversa, utilizando ` scaling`.

Pasa qQNaN() a este método para omitir este parámetro durante la conversión.

La escala no puede ser 0. Intentar establecer una escala de cero equivale a establecerla en qQNaN().

En la sección Value Conversions se explica cómo se utiliza este parámetro.

Véanse también scaling(), setOffset() y setFactor().

void QCanSignalDescription::setStartBit(quint16 bit)

Establece el bit de inicio del valor de la señal en la función dataSource() en bit.

Véanse también startBit(), bitLength() y setBitLength().

quint16 QCanSignalDescription::startBit() const

Devuelve el bit inicial del valor de la señal en la función dataSource().

Véase también setStartBit(), bitLength() y setBitLength().

[noexcept] QCanSignalDescription &QCanSignalDescription::operator=(QCanSignalDescription &&other)

Asigna por movimiento los valores de other a esta descripción de señal.

Nota: El objeto de « QCanSignalDescription » del que se han extraído los valores solo puede ser destruido o asignado. El efecto de llamar a otras funciones que no sean el destructor o uno de los operadores de asignación es indefinido.

QCanSignalDescription &QCanSignalDescription::operator=(const QCanSignalDescription &other)

Asigna los valores de other a la descripción de esta señal.

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