QCanBusDevice Class

Dokumentation der Mitgliedsfunktionen

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

Erstellt ein serielles Busgerät mit dem angegebenen „ parent “.

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

Gibt den aktuellen CAN-Bus-Status zurück. Wenn der Status nicht abgefragt werden kann, wird QCanBusDevice::UnknownStatus zurückgegeben.

Siehe auch „ hasBusStatus()“ und „ resetController()“.

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

Löscht die Eingabe- oder Ausgabepuffer des Geräts, je nach der Einstellung von ` direction`.

Diese Funktion wirkt sich nur auf die Puffer von ` QCanBusDevice ` aus. Frames, die bereits in den CAN-Treiber oder die CAN-Hardware-Schicht geschrieben wurden oder die noch nicht aus diesen Schichten gelesen wurden, werden durch diese Funktion nicht geleert.

Siehe auch framesAvailable(), readFrame(), framesToWrite() und writeFrame().

[protected] void QCanBusDevice::clearError()

Löscht die Fehler-ID und die für Menschen lesbare Beschreibung des letzten Gerätefehlers.

CAN-Bus-Implementierungen müssen diese Funktion verwenden, um den Fehlerstatus des Geräts zu aktualisieren.

Siehe auch error(), errorOccurred() und setError().

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

Diese Funktion ist dafür zuständig, die CAN-Bus-Verbindung zu schließen. Die Implementierung muss sicherstellen, dass die Funktion „ state()“ der Instanz auf „ QCanBusDevice::UnconnectedState “ gesetzt wird.

Die wichtigste Aufgabe dieser Funktion besteht darin, den Socket zum CAN-Gerät zu schließen und ` QCanBusDevice::setState()` aufzurufen.

Siehe auch ` disconnectDevice()`.

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

Gibt die Liste der von der CAN-Bus-Verbindung verwendeten Schlüssel zurück.

Die Bedeutung der Schlüssel entspricht der unter ConfigurationKey beschriebenen. Wird ein Schlüssel nicht ausdrücklich genannt, wird die Standardeinstellung der Plattform für den jeweiligen Schlüssel verwendet.

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

Gibt den aktuellen Wert zurück, der der Variablen „ ConfigurationKey “ zugewiesen ist: key; andernfalls einen ungültigen Wert: QVariant.

Siehe auch setConfigurationParameter() und configurationKeys().

bool QCanBusDevice::connectDevice()

Verbindet das Gerät mit dem CAN-Bus. Gibt bei Erfolg „ true “ zurück; andernfalls „ false “.

Diese Funktion ruft im Rahmen ihrer Implementierung ` open()` auf.

Siehe auch ` disconnectDevice()`.

[protected] QCanBusFrame QCanBusDevice::dequeueOutgoingFrame()

Gibt den nächsten ` QCanBusFrame ` aus der internen Liste der ausgehenden Frames zurück; andernfalls wird ein ungültiger ` QCanBusFrame` zurückgegeben. Der zurückgegebene Frame wird aus der internen Liste entfernt.

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

Gibt ein ` QCanBusDeviceInfo ` für das aktuelle ` QCanBusDevice` zurück. Wenn die Funktion nicht von einer Unterklasse von ` QCanBusDevice` implementiert wird, wird ein standardkonstruiertes Objekt zurückgegeben.

Diese Funktion wurde in Qt 6.2 eingeführt.

void QCanBusDevice::disconnectDevice()

Trennt das Gerät vom CAN-Bus.

Diese Funktion ruft im Rahmen ihrer Implementierung die Funktion „ close()“ auf.

Siehe auch ` connectDevice()`.

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

Fügt „ newFrame “ zur internen Liste der ausgehenden Frames hinzu, auf die über „ writeFrame()“ zugegriffen werden kann.

Unterklassen müssen diese Funktion aufrufen, wenn sie einen neuen Frame schreiben.

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

Fügt „ newFrames “ zur internen Liste der Frames hinzu, auf die über „ readFrame()“ zugegriffen werden kann, und löst das Signal „ framesReceived()“ aus.

Unterklassen müssen diese Funktion aufrufen, wenn sie Frames empfangen.

QCanBusDevice::CanBusError QCanBusDevice::error() const

Gibt den zuletzt aufgetretenen Fehler zurück. Der Fehlerwert wird immer auf den zuletzt aufgetretenen Fehler gesetzt und niemals zurückgesetzt.

Siehe auch setError() und errorString().

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

Dieses Signal wird ausgegeben, wenn ein Fehler auftritt.

QString QCanBusDevice::errorString() const

Gibt eine für Menschen lesbare Beschreibung des zuletzt aufgetretenen Gerätefehlers zurück.

Siehe auch „ error()“.

qint64 QCanBusDevice::framesAvailable() const

Gibt die Anzahl der verfügbaren Frames zurück. Sind keine Frames verfügbar, gibt diese Funktion 0 zurück.

Siehe auch clear(), readFrame() und readAllFrames().

[signal] void QCanBusDevice::framesReceived()

Dieses Signal wird ausgegeben, wenn ein oder mehrere Frames empfangen wurden. Die Frames sollten mit den Funktionen „ readFrame()“ und „ framesAvailable()“ ausgelesen werden.

qint64 QCanBusDevice::framesToWrite() const

Bei gepufferten Geräten gibt diese Funktion die Anzahl der Frames zurück, die noch geschrieben werden müssen. Bei ungepufferten Geräten gibt diese Funktion immer Null zurück.

Siehe auch clear() und writeFrame().

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

Dieses Signal wird jedes Mal ausgesendet, wenn eine Nutzlast aus Frames auf den CAN-Bus geschrieben wurde. Das Argument „ framesCount “ wird auf die Anzahl der Frames gesetzt, die in dieser Nutzlast geschrieben wurden.

[virtual] bool QCanBusDevice::hasBusStatus() const

Gibt „true“ zurück, wenn das CAN-Plugin die Abfrage des CAN-Bus-Status unterstützt.

Siehe auch busStatus().

[protected] bool QCanBusDevice::hasOutgoingFrames() const

Gibt „ true “ zurück, wenn die interne Liste der ausgehenden Frames nicht leer ist; andernfalls wird „ false “ zurückgegeben.

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

Interpretiert „ frame “ als Fehlerrahmen und gibt eine für Menschen lesbare Beschreibung des Fehlers zurück.

Wenn frame kein Fehler-Frame ist, ist die zurückgegebene Zeichenkette leer.

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

Diese Funktion wird von ` connectDevice()` aufgerufen. Unterklassen müssen eine Implementierung bereitstellen, die ` true ` zurückgibt, wenn die CAN-Bus-Verbindung hergestellt werden konnte; andernfalls ` false`. Die Implementierung von ` QCanBusDevice ` stellt beim Aufruf dieser Funktion sicher, dass die Methode ` state()` des Geräts bereits auf ` QCanBusDevice::ConnectingState ` gesetzt ist.

Die Implementierung muss sicherstellen, dass bei Erfolg die Methode ` state()` der Instanz auf ` QCanBusDevice::ConnectedState` gesetzt wird; andernfalls auf ` QCanBusDevice::UnconnectedState`. Die Methode ` setState()` muss verwendet werden, um den neuen Gerätestatus festzulegen.

Die benutzerdefinierte Implementierung ist für das Öffnen des Sockets, die Instanziierung eines möglicherweise erforderlichen ` QSocketNotifier ` sowie die Anwendung benutzerdefinierter und standardmäßiger ` QCanBusDevice::configurationParameter()` verantwortlich.

Siehe auch ` connectDevice()`.

QList<QCanBusFrame> QCanBusDevice::readAllFrames()

Gibt alle „ QCanBusFrame“ aus der Warteschlange zurück; andernfalls wird ein leeres „ QList “ zurückgegeben. Die zurückgegebenen Frames werden aus der Warteschlange entfernt.

Die Warteschlange arbeitet nach dem FIFO-Prinzip.

Siehe auch „ clear()“, „ framesAvailable()“ und „ readFrame()“.

QCanBusFrame QCanBusDevice::readFrame()

Gibt den nächsten „ QCanBusFrame “ aus der Warteschlange zurück; andernfalls wird ein leerer „ QCanBusFrame “ zurückgegeben. Der zurückgegebene Frame wird aus der Warteschlange entfernt.

Die Warteschlange arbeitet nach dem FIFO-Prinzip.

Siehe auch „ clear()“, „ framesAvailable()“ und „ readAllFrames()“.

[virtual] void QCanBusDevice::resetController()

Führt einen Reset des CAN-Controllers durch, um diesen, sofern möglich, aus dem Bus-Off-Zustand zu befreien.

Siehe auch „ busStatus“ ().

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

Setzt den Konfigurationsparameter „ key “ für die CAN-Bus-Verbindung auf „ value “. Die möglichen Schlüssel sind unter „ ConfigurationKey “ aufgeführt.

Ein Parameter kann durch die Angabe eines ungültigen „ QVariant “ zurückgesetzt werden. Das Zurücksetzen eines Parameters bedeutet, dass die Konfiguration auf ihre Standardeinstellung zurückgesetzt wird.

Siehe auch configurationParameter().

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

Setzt die für Menschen lesbare Beschreibung des letzten Gerätefehlers auf „ errorText “. „ errorId “ kategorisiert die Art des Fehlers.

CAN-Bus-Implementierungen müssen diese Funktion verwenden, um den Fehlerstatus des Geräts zu aktualisieren.

Siehe auch error(), errorOccurred() und clearError().

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

Setzt den Status des Geräts auf „ newState “. CAN-Bus-Implementierungen müssen diese Funktion verwenden, um den Gerätestatus zu aktualisieren.

Siehe auch „ state()“.

QCanBusDevice::CanBusDeviceState QCanBusDevice::state() const

Gibt den aktuellen Status des Geräts zurück.

Siehe auch setState() und stateChanged().

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

Dieses Signal wird jedes Mal ausgesendet, wenn sich der Zustand des Geräts ändert. Der neue Zustand wird durch state dargestellt.

Siehe auch „ setState()“ und „ state()“.

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

Die Funktion wartet, bis neue Frames zum Lesen verfügbar sind und das Signal „ framesReceived()“ ausgelöst wurde, oder bis msecs Millisekunden verstrichen sind. Wenn „ msecs “ auf „ -1 “ gesetzt ist, läuft diese Funktion nicht ab.

Gibt „ true “ zurück, wenn neue Frames zum Lesen verfügbar sind und das Signal „ framesReceived()“ ausgelöst wird; andernfalls wird „ false “ zurückgegeben (wenn die Operation abgelaufen ist oder ein Fehler aufgetreten ist).

Siehe auch ` waitForFramesWritten()`.

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

Bei gepufferten Geräten wartet diese Funktion, bis alle gepufferten Frames auf das Gerät geschrieben wurden und das Signal „ framesWritten()“ ausgegeben wurde, oder bis msecs Millisekunden verstrichen sind. Ist msecs gleich -1, läuft diese Funktion ohne Zeitüberschreitung ab. Bei ungepufferten Geräten kehrt sie sofort mit dem Wert „ false “ zurück, da „ writeFrame()“ keinen Schreibpuffer benötigt.

Gibt „ true “ zurück, wenn das Signal „ framesWritten()“ ausgelöst wird; andernfalls gibt sie „ false “ zurück (d. h. wenn die Operation ein Timeout erreicht hat oder ein Fehler aufgetreten ist).

Siehe auch ` waitForFramesReceived()`.

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

Schreibt „ frame “ an den CAN-Bus und gibt bei Erfolg „ true “ zurück; andernfalls „ false “.

Auf einigen Plattformen wird der Frame möglicherweise in eine Warteschlange gestellt, und der Rückgabewert zeigt möglicherweise nur an, dass der Frame erfolgreich in die Warteschlange eingefügt wurde. Der eigentliche Frame wird erst später gesendet. Daher ist das Signal „ framesWritten()“ die endgültige Bestätigung dafür, dass der Frame an die Transportschicht übergeben wurde. Tritt ein Fehler auf, wird „ errorOccurred()“ ausgegeben.

Gemäß der CAN-Bus-Spezifikation haben Frames vom Typ „ remote transfer request (RTR) “ keine Nutzlast, sondern eine Länge von 0 bis 8 (einschließlich). Diese Länge gibt die erwartete Länge der Antwort-Nutzlast der Gegenstelle an. Daher kann es beim Senden eines RTR-Frames mit dieser Funktion dennoch erforderlich sein, eine beliebige Nutzlast für „ frame “ festzulegen. Die Länge dieser beliebigen Nutzlast entspricht der als erwartete Größe für den RTR-Frame festgelegten Wert.

Siehe auch „ QCanBusFrame::setPayload()“.