QCanBusFrame Class

Documentation des fonctions membres

[explicit noexcept] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameType type = DataFrame)

Crée une trame CAN à partir de l'type spécifiée.

Voir également QCanBusFrame::FrameType et setFrameType().

[explicit] QCanBusFrame::QCanBusFrame(QCanBusFrame::FrameId identifier, const QByteArray &data)

Crée une trame CAN en utilisant identifier comme identifiant de trame et data comme charge utile.

Voir également QCanBusFrame::FrameId.

[constexpr noexcept] QCanBusFrame::FrameErrors QCanBusFrame::error() const

Renvoie l'erreur de la trame d'erreur actuelle. Si la trame n'est pas de type ` ErrorFrame`, cette fonction renvoie ` NoError`.

Voir également ` QCanBusFrame::FrameError ` et ` setError()`.

[constexpr noexcept] QCanBusFrame::FrameId QCanBusFrame::frameId() const

Renvoie l'identifiant de la trame CAN. Si la trame CAN utilise le format de trame étendu, l'identifiant comporte au maximum 29 bits ; sinon, il en comporte 11.

Si la trame est de type « ErrorFrame », cet identifiant est toujours égal à 0.

Voir également QCanBusFrame::FrameId, setFrameId() et hasExtendedFrameFormat().

[constexpr noexcept] QCanBusFrame::FrameType QCanBusFrame::frameType() const

Renvoie le type de la trame.

Voir également QCanBusFrame::FrameType et setFrameType().

[constexpr noexcept] bool QCanBusFrame::hasBitrateSwitch() const

Renvoie « true » si le réseau CAN utilise le mode « Flexible Data-Rate with Bitrate Switch » pour transférer les données utiles à un débit binaire plus élevé.

Voir également setBitrateSwitch() et QCanBusDevice::DataBitRateKey.

[constexpr noexcept] bool QCanBusFrame::hasErrorStateIndicator() const

Renvoie « true » si le CAN utilise le débit de données flexible (Flexible Data-Rate ) et que l'indicateur d'état d'erreur est activé.

Cet indicateur est activé par le matériel CAN FD de l’émetteur pour signaler l’état d’erreur de ce dernier.

Voir également setErrorStateIndicator().

[constexpr noexcept] bool QCanBusFrame::hasExtendedFrameFormat() const

Renvoie « true » si la trame CAN utilise un identifiant de 29 bits ; sinon, « false », ce qui implique un identifiant de 11 bits.

Voir également setExtendedFrameFormat() et frameId().

[constexpr noexcept] bool QCanBusFrame::hasFlexibleDataRateFormat() const

Renvoie « true » si la trame CAN utilise le débit de données flexible (Flexible Data-Rate), qui autorise jusqu'à 64 octets de données ; sinon, « false », ce qui implique une charge utile maximale de 8 octets.

Voir également setFlexibleDataRateFormat() et payload().

[constexpr noexcept] bool QCanBusFrame::hasLocalEcho() const

Renvoie « true » si la trame est une trame d'écho locale, c'est-à-dire une trame reçue en écho après l'envoi réussi d'une trame au même contenu sur le bus CAN. Cet indicateur est activé pour les trames envoyées par l'application elle-même ainsi que pour celles envoyées par d'autres applications s'exécutant sur le même système.

QCanBusDevice::ReceiveOwnKey Doit être défini sur `true` pour recevoir des trames d'écho.

Voir également setLocalEcho(), QCanBusDevice::ReceiveOwnKey et QCanBusDevice::LoopbackKey.

[noexcept] bool QCanBusFrame::isValid() const

Renvoie « false » si la valeur de « frameType() » est « InvalidFrame », si « hasExtendedFrameFormat() » n’est pas défini alors que « frameId() » est supérieur à 11 bits, ou si la charge utile dépasse la longueur maximale autorisée de 64 octets lorsque le mode « Flexible Data-Rate » est activé, ou de 8 octets lorsqu’il est désactivé. Si frameType() vaut RemoteRequestFrame et que le mode « Flexible Data-Rate » est activé, false est également renvoyé.

Dans le cas contraire, cette fonction renvoie « true ».

QByteArray QCanBusFrame::payload() const

Renvoie la charge utile de données de la trame.

Voir aussi setPayload().

[constexpr noexcept] void QCanBusFrame::setBitrateSwitch(bool bitrateSwitch)

Définissez l'indicateur « Flexible Data-Rate » (Débit de données flexible) sur « Bitrate Switch » (Commutation de débit) à l'adresse bitrateSwitch. Le champ de données des trames comportant cet indicateur est transféré à un débit de données plus élevé.

Voir également « hasBitrateSwitch() » et « QCanBusDevice::DataBitRateKey ».

[constexpr] void QCanBusFrame::setError(QCanBusFrame::FrameErrors error)

Définit le type d'error s du cadre. Cette fonction ne fait rien si frameType() n'est pas un ErrorFrame.

Voir également QCanBusFrame::FrameError et error().

[constexpr noexcept] void QCanBusFrame::setErrorStateIndicator(bool errorStateIndicator)

Définissez l'indicateur d'état d'erreur du drapeau « Flexible Data-Rate » sur « errorStateIndicator ».

Lors de l'envoi de trames CAN FD, cet indicateur est automatiquement activé par le matériel CAN FD. La valeur « QCanBusFrame::setErrorStateIndicator() » ne doit être utilisée que pour les tests d'application, par exemple sur des bus CAN FD virtuels.

Voir également « hasErrorStateIndicator » ().

[constexpr noexcept] void QCanBusFrame::setExtendedFrameFormat(bool isExtended)

Définit l'indicateur de format d'image étendu sur « isExtended ».

Voir également hasExtendedFrameFormat().

[constexpr noexcept] void QCanBusFrame::setFlexibleDataRateFormat(bool isFlexibleData)

Active l'indicateur « Flexible Data-Rate » (débit de données flexible) sur la valeur « isFlexibleData ». Ces trames peuvent être transmises à un débit plus élevé sur les contrôleurs compatibles. De plus, la limite de longueur de la charge utile est portée à 64 octets.

Voir également hasFlexibleDataRateFormat().

[constexpr] void QCanBusFrame::setFrameId(QCanBusFrame::FrameId newFrameId)

Définit l'identifiant de la trame CAN sur « newFrameId ».

La taille maximale d’un identifiant de trame CAN est de 11 bits ; elle peut être étendue jusqu’à 29 bits grâce à la prise en charge du format de trame CAN étendu. Le paramètre de format de trame CAN étendu est automatiquement activé lorsqu’un newFrameId de plus de 11 bits est fourni.

Lorsque le format est étendu et qu’un identifiant de trame CAN ( newFrameId ) de 11 bits ou moins est transmis, le paramètre du format de trame CAN étendu n’ est pas modifié.

Voir également QCanBusFrame::FrameId, frameId() et hasExtendedFrameFormat().

[constexpr noexcept] void QCanBusFrame::setFrameType(QCanBusFrame::FrameType newType)

Définit le type du cadre sur « newType ».

Voir également QCanBusFrame::FrameType et frameType().

[constexpr noexcept] void QCanBusFrame::setLocalEcho(bool echo)

Activez l'indicateur « Local Echo » sur « echo ».

Lors de l'envoi de trames CAN avec l'option « QCanBusDevice::ReceiveOwnKey » activée, toutes les trames envoyées avec succès sont renvoyées vers la file d'attente de réception et marquées comme trames d'écho local. L'option « QCanBusFrame::setLocalEcho » ne doit donc être utilisée que pour les tests d'application, par exemple sur des bus CAN virtuels.

Voir également hasLocalEcho().

void QCanBusFrame::setPayload(const QByteArray &data)

Définit « data » comme charge utile de la trame CAN. La taille maximale de la charge utile est de 8 octets ; elle peut être étendue jusqu’à 64 octets grâce à la prise en charge du débit de données flexible. Si « data » contient plus de 8 octets, l’indicateur de débit de données flexible est automatiquement activé. La fonction « Flexible Data-Rate » doit être activée sur l’ QCanBusDevice e en configurant l’ QCanBusDevice::CanFdKey.

Les trames de type « RemoteRequestFrame » (RTR) ne contiennent pas de charge utile. Elles doivent toutefois fournir une indication de la longueur attendue de la charge utile de la réponse. Pour définir cette longueur attendue, il est nécessaire de définir une fausse charge utile dont la longueur correspond à celle attendue pour la réponse. Voici une méthode possible pour y parvenir :

QCanBusFrame frame(QCanBusFrame::RemoteRequestFrame);
int expectedResponseLength = ...;
frame.setPayload(QByteArray(expectedResponseLength, 0));

Voir également payload() et hasFlexibleDataRateFormat().

[constexpr noexcept] void QCanBusFrame::setTimeStamp(QCanBusFrame::TimeStamp ts)

Définit ts comme horodatage de la trame CAN. En général, cette fonction n'est pas nécessaire, car l'horodatage est créé lors de l'opération de lecture et n'est pas requis lors de l'opération d'écriture.

Voir également timeStamp() et QCanBusFrame::TimeStamp.

[constexpr noexcept] QCanBusFrame::TimeStamp QCanBusFrame::timeStamp() const

Renvoie l'horodatage de l'image.

Voir également ` QCanBusFrame::TimeStamp ` et ` QCanBusFrame::setTimeStamp()`.

QString QCanBusFrame::toString() const

Renvoie la trame CAN sous forme de chaîne formatée.

La sortie contient l'identifiant CAN au format hexadécimal, aligné à droite sur 32 bits, suivi de la longueur des données entre crochets et de la charge utile au format hexadécimal.

Les identifiants standard sont complétés par des espaces, tandis que les identifiants étendus sont complétés par des zéros.

Exemples de résultats :

(Error)                                  - error frame
     7FF   [1]  01                       - data frame with standard identifier
1FFFFFFF   [8]  01 23 45 67 89 AB CD EF  - data frame with extended identifier
     400  [10]  01 23 45 67 ... EF 01 23 - CAN FD frame
     123   [5]  Remote Request           - remote frame with standard identifier
00000234   [0]  Remote Request           - remote frame with extended identifier