QCanBusDevice Class

Documentación de las funciones miembro

[explicit] QCanBusDevice::QCanBusDevice(QObject *parent = nullptr)

Construye un dispositivo de bus serie con la dirección parent especificada.

[virtual] QCanBusDevice::CanBusStatus QCanBusDevice::busStatus()

Devuelve el estado actual del bus CAN. Si no se puede solicitar el estado, se devuelve QCanBusDevice::UnknownStatus.

Véase también hasBusStatus() y resetController().

void QCanBusDevice::clear(QCanBusDevice::Directions direction = Direction::AllDirections)

Borra los búferes de entrada o salida de los dispositivos, dependiendo de direction.

Esta función sólo opera en las memorias intermedias de QCanBusDevice. Las tramas que ya se han escrito en el controlador CAN o en la capa de hardware CAN, o que aún no se han leído desde estas capas, no se borran con esta función.

Véase también framesAvailable(), readFrame(), framesToWrite() y writeFrame().

[protected] void QCanBusDevice::clearError()

Borra el id de error y la descripción legible por humanos del último error del dispositivo.

Las implementaciones de bus CAN deben utilizar esta función para actualizar el estado de error del dispositivo.

Véase también error(), errorOccurred() y setError().

[pure virtual protected] void QCanBusDevice::close()

Esta función se encarga de cerrar la conexión del bus CAN. La implementación debe asegurarse de que state() de la instancia se establece en QCanBusDevice::UnconnectedState.

La tarea más importante de esta función es cerrar el socket al dispositivo CAN y llamar a QCanBusDevice::setState().

Véase también disconnectDevice().

QList<QCanBusDevice::ConfigurationKey> QCanBusDevice::configurationKeys() const

Devuelve la lista de claves utilizadas por la conexión de bus CAN.

El significado de las claves es equivalente a ConfigurationKey. Si una clave no se menciona explícitamente, se utiliza la configuración predeterminada de la plataforma para la clave correspondiente.

QVariant QCanBusDevice::configurationParameter(QCanBusDevice::ConfigurationKey key) const

Devuelve el valor actual asignado a ConfigurationKey key ; en caso contrario, un valor inválido QVariant.

Véase también setConfigurationParameter() y configurationKeys().

bool QCanBusDevice::connectDevice()

Conecta el dispositivo al bus CAN. Devuelve true en caso de éxito; en caso contrario false.

Esta función llama a open() como parte de su implementación.

Véase también disconnectDevice().

[protected] QCanBusFrame QCanBusDevice::dequeueOutgoingFrame()

Devuelve la siguiente QCanBusFrame de la lista interna de tramas salientes; en caso contrario, devuelve una QCanBusFrame no válida. La trama devuelta se elimina de la lista interna.

[virtual, since 6.2] QCanBusDeviceInfo QCanBusDevice::deviceInfo() const

Devuelve un QCanBusDeviceInfo para el QCanBusDevice actual. Si la función no está implementada por una subclase de QCanBusDevice, se devuelve un objeto construido por defecto.

Esta función se introdujo en Qt 6.2.

void QCanBusDevice::disconnectDevice()

Desconecta el dispositivo del bus CAN.

Esta función llama a close() como parte de su implementación.

Véase también connectDevice().

[protected] void QCanBusDevice::enqueueOutgoingFrame(const QCanBusFrame &newFrame)

Añade newFrame a la lista interna de tramas salientes a la que se puede acceder mediante writeFrame().

Las subclases deben llamar a esta función cuando escriben un nuevo marco.

[protected] void QCanBusDevice::enqueueReceivedFrames(const QList<QCanBusFrame> &newFrames)

Añade newFrames a la lista interna de tramas a las que se puede acceder mediante readFrame() y emite la señal framesReceived().

Las subclases deben llamar a esta función cuando reciben tramas.

QCanBusDevice::CanBusError QCanBusDevice::error() const

Devuelve el último error que se ha producido. El valor del error siempre se establece en el último error que se ha producido y nunca se restablece.

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

[signal] void QCanBusDevice::errorOccurred(QCanBusDevice::CanBusError)

Esta señal se emite cuando se produce un error.

QString QCanBusDevice::errorString() const

Devuelve una descripción legible por humanos del último error de dispositivo que se ha producido.

Véase también error().

qint64 QCanBusDevice::framesAvailable() const

Devuelve el número de fotogramas disponibles. Si no hay fotogramas disponibles, esta función devuelve 0.

Véase también clear(), readFrame() y readAllFrames().

[signal] void QCanBusDevice::framesReceived()

Esta señal se emite cuando se han recibido una o varias tramas. Las tramas deben leerse utilizando readFrame() y framesAvailable().

qint64 QCanBusDevice::framesToWrite() const

Para dispositivos con buffer, esta función devuelve el número de tramas en espera de ser escritas. Para dispositivos sin búfer, esta función siempre devuelve cero.

Véase también clear() y writeFrame().

[signal] void QCanBusDevice::framesWritten(qint64 framesCount)

Esta señal se emite cada vez que se ha escrito una carga útil de tramas en el bus CAN. El argumento framesCount se establece en el número de tramas que se han escrito en esta carga útil.

[virtual] bool QCanBusDevice::hasBusStatus() const

Devuelve true, si el plugin CAN soporta solicitar el estado del bus CAN.

Véase también busStatus().

[protected] bool QCanBusDevice::hasOutgoingFrames() const

Devuelve true si la lista interna de tramas salientes no está vacía; en caso contrario devuelve false.

[pure virtual] QString QCanBusDevice::interpretErrorFrame(const QCanBusFrame &frame)

Interpreta frame como marco de error y devuelve una descripción legible del error.

Si frame no es una trama de error, la cadena devuelta está vacía.

[pure virtual protected] bool QCanBusDevice::open()

Esta función es llamada por connectDevice(). Las subclases deben proporcionar una implementación que devuelva true si se ha podido establecer la conexión de bus CAN; en caso contrario, false. La implementación de QCanBusDevice garantiza que, al entrar en esta función, el valor de state() del dispositivo ya sea QCanBusDevice::ConnectingState.

La implementación debe garantizar que, en caso de éxito, el valor de state() de la instancia sea QCanBusDevice::ConnectedState; en caso contrario, QCanBusDevice::UnconnectedState. setState() para establecer el nuevo estado del dispositivo.

La implementación personalizada es responsable de la apertura del socket, la instanciación de un QSocketNotifier potencialmente necesario y la aplicación de QCanBusDevice::configurationParameter() personalizado y predeterminado.

Véase también connectDevice().

QList<QCanBusFrame> QCanBusDevice::readAllFrames()

Devuelve todas las QCanBusFrames de la cola; en caso contrario, devuelve una QList vacía. Las tramas devueltas se eliminan de la cola.

La cola funciona según el principio FIFO.

Véase también clear(), framesAvailable() y readFrame().

QCanBusFrame QCanBusDevice::readFrame()

Devuelve la siguiente QCanBusFrame de la cola; en caso contrario, devuelve una QCanBusFrame vacía. La trama devuelta se elimina de la cola.

La cola funciona según el principio FIFO.

Véase también clear(), framesAvailable() y readAllFrames().

[virtual] void QCanBusDevice::resetController()

Realiza un reinicio del controlador CAN para liberar el controlador CAN del estado de bus apagado, si es posible.

Véase también busStatus().

[virtual] void QCanBusDevice::setConfigurationParameter(QCanBusDevice::ConfigurationKey key, const QVariant &value)

Establece el parámetro de configuración key para la conexión de bus CAN en value. Las claves potenciales están representadas por ConfigurationKey.

Un parámetro se puede desajustar estableciendo un valor no válido QVariant. Desajustar un parámetro implica que la configuración se restablece a su valor predeterminado.

Véase también configurationParameter().

[protected] void QCanBusDevice::setError(const QString &errorText, QCanBusDevice::CanBusError errorId)

Establece la descripción legible por humanos del último error del dispositivo en errorText. errorId categoriza el tipo de error.

Las implementaciones de bus CAN deben utilizar esta función para actualizar el estado de error del dispositivo.

Véase también error(), errorOccurred() y clearError().

[protected] void QCanBusDevice::setState(QCanBusDevice::CanBusDeviceState newState)

Establece el estado del dispositivo en newState. Las implementaciones de bus CAN deben utilizar esta función para actualizar el estado del dispositivo.

Véase también state().

QCanBusDevice::CanBusDeviceState QCanBusDevice::state() const

Devuelve el estado actual del dispositivo.

Véase también setState() y stateChanged().

[signal] void QCanBusDevice::stateChanged(QCanBusDevice::CanBusDeviceState state)

Esta señal se emite cada vez que cambia el estado del dispositivo. El nuevo estado se representa mediante state.

Véase también setState() y state().

[virtual] bool QCanBusDevice::waitForFramesReceived(int msecs)

Se bloquea hasta que haya nuevos fotogramas disponibles para lectura y se haya emitido la señal framesReceived(), o hasta que hayan transcurrido msecs milisegundos. Si msecs es -1, esta función no agotará el tiempo de espera.

Devuelve true si hay nuevos fotogramas disponibles para la lectura y se emite la señal framesReceived(); en caso contrario, devuelve false (si la operación ha expirado o si se ha producido un error).

Véase también waitForFramesWritten().

[virtual] bool QCanBusDevice::waitForFramesWritten(int msecs)

Para dispositivos con buffer, esta función espera hasta que todas las tramas con buffer han sido escritas en el dispositivo y la señal framesWritten() ha sido emitida, o hasta que msecs milisegundos han pasado. Si msecs es -1, esta función no agotará el tiempo de espera. Para dispositivos sin buffer, retorna inmediatamente con false ya que writeFrame() no requiere un buffer de escritura.

Devuelve true si se emite la señal framesWritten(); en caso contrario, devuelve false (es decir, si la operación ha expirado o si se ha producido un error).

Véase también waitForFramesReceived().

[pure virtual] bool QCanBusDevice::writeFrame(const QCanBusFrame &frame)

Escribe frame en el bus CAN y devuelve true en caso de éxito; en caso contrario false.

En algunas plataformas, es posible que la trama se coloque en una cola y que el valor de retorno sólo indique una inserción correcta en la cola. La trama real se enviará más tarde. Por lo tanto, la señal framesWritten() es la confirmación final de que la trama ha sido entregada a la capa de transporte. Si se produce un error, se emite la señal errorOccurred().

Según la especificación del bus CAN, las tramas del tipo remote transfer request (RTR) no tienen carga útil, sino una longitud de 0 a 8 (inclusive). Esta longitud indica la longitud de la carga útil de respuesta esperada de la parte remota. Por lo tanto, al enviar una trama RTR utilizando esta función, puede ser necesario establecer una carga útil arbitraria en frame. La longitud de la carga útil arbitraria es lo que se establece como tamaño esperado para la trama RTR.

Véase también QCanBusFrame::setPayload().