Vector::BL...rorFrame64(3)

πŸ“¦ version 2.4.2, in arch rolling

πŸ’– Vector::BLF::CanFdErrorFrame64 πŸ’–

okay bestie, welcome to the Library Functions Manual page for Vector::BLF::CanFdErrorFrame64 β€” yes, the whole name, we're not abbreviating, periodt. It's giving CAN FD error frame energy and I'm obsessed. πŸ¦‹


🌸 NAME 🌸

Vector::BLF::CanFdErrorFrame64 β€” CAN_FD_ERROR_64. That's it, short and iconic. πŸ’…

✨ SYNOPSIS ✨

#include <CanFdErrorFrame64.h>

It inherits Vector::BLF::ObjectHeader, and Vector::BLF::CanFdExtFrameData. Lowkey a whole family tree, but slay. 🫢

πŸ’… Public Member Functions πŸ’…

  • void read (AbstractFile &is) override β€” reads the data of this object.
  • void write (AbstractFile &os) override β€” writes the data of this object.
  • uint32_t calculateObjectSize () const override β€” calculates the objectSize.
  • virtual bool hasExtData () const β€” no extra description on the page, it's just there being mysterious.

🫢 Public Member Functions inherited from Vector::BLF::ObjectHeader 🫢

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0)
  • void read (AbstractFile &is) override
  • void write (AbstractFile &os) override
  • uint16_t calculateHeaderSize () const override
  • uint32_t calculateObjectSize () const override

🫢 Public Member Functions inherited from Vector::BLF::ObjectHeaderBase 🫢

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType)
  • ObjectHeaderBase (const ObjectHeaderBase &)=default
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default
  • ObjectHeaderBase (ObjectHeaderBase &&)=default
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default

🫢 Public Member Functions inherited from Vector::BLF::CanFdExtFrameData 🫢

  • CanFdExtFrameData (const CanFdExtFrameData &)=default
  • CanFdExtFrameData & operator= (const CanFdExtFrameData &)=default
  • CanFdExtFrameData (CanFdExtFrameData &&)=default
  • CanFdExtFrameData & operator= (CanFdExtFrameData &&)=default

πŸŽ€ Public Attributes πŸŽ€

  • uint8_t channel {} β€” application channel
  • uint8_t dlc {} β€” CAN dlc.
  • uint8_t validDataBytes {} β€” Valid payload length of data.
  • uint8_t ecc {}
  • uint16_t flags {}
  • uint16_t errorCodeExt {}
  • uint16_t extFlags {} β€” FD specific flags.
  • uint8_t extDataOffset {}
  • uint8_t reservedCanFdErrorFrame1 {}
  • uint32_t id {} β€” CAN ID.
  • uint32_t frameLength {} β€” message length in ns
  • uint32_t btrCfgArb {} β€” bit rate used in arbitration phase
  • uint32_t btrCfgData {} β€” bit rate used in data phase
  • uint32_t timeOffsetBrsNs {} β€” time offset of brs field
  • uint32_t timeOffsetCrcDelNs {} β€” time offset of brs field
  • uint32_t crc {}
  • uint16_t errorPosition {} β€” error position as bit offset
  • uint16_t reservedCanFdErrorFrame2 {}
  • std::vector< uint8_t > data {} β€” CAN FD data.
  • std::vector< uint8_t > reservedCanFdErrorFrame64 {}

🫢 Public Attributes inherited from Vector::BLF::ObjectHeader 🫢

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} β€” object flags
  • uint16_t clientIndex {} β€” client index of send node
  • uint16_t objectVersion {0} β€” object specific version
  • uint64_t objectTimeStamp {} β€” object timestamp

🫢 Public Attributes inherited from Vector::BLF::ObjectHeaderBase 🫢

  • uint32_t signature {ObjectSignature} β€” signature (ObjectSignature)
  • uint16_t headerSize {} β€” sizeof object header
  • uint16_t headerVersion {} β€” header version (1)
  • uint32_t objectSize {} β€” object size
  • ObjectType objectType {ObjectType::UNKNOWN} β€” object type

🫢 Public Attributes inherited from Vector::BLF::CanFdExtFrameData 🫢

  • uint32_t btrExtArb {}
  • uint32_t btrExtData {}
  • std::vector< uint8_t > reservedCanFdExtFrameData {}

πŸ¦‹ Additional Inherited Members πŸ¦‹

πŸ‘‘ Public Types inherited from Vector::BLF::ObjectHeader πŸ‘‘

enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans =
    0x00000002 }

πŸ’œ Detailed Description πŸ’œ

CAN_FD_ERROR_64.

CAN-FD error frame received or transmitted on a CAN-FD channel. no cap. ✨

πŸ”₯ Member Function Documentation πŸ”₯

πŸ’… uint32_t Vector::BLF::CanFdErrorFrame64::calculateObjectSize () const πŸ’…

Tags: [override], [virtual].

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ’… void Vector::BLF::CanFdErrorFrame64::read (AbstractFile & is) [override], [virtual] πŸ’…

Read the data of this object.

Parameters: is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ’… void Vector::BLF::CanFdErrorFrame64::write (AbstractFile & os) [override], [virtual] πŸ’…

Write the data of this object.

Parameters: os output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ“ Member Data Documentation πŸ“

πŸŽ€ uint32_t Vector::BLF::CanFdErrorFrame64::btrCfgArb {} πŸŽ€

bit rate used in arbitration phase. CAN-FD bit timing configuration for arbiration phase, may be 0, if not supported by hardware/driver.

  • Bit 0-7: Quartz Frequency
  • Bit 8-15: Prescaler
  • Bit 16-23: BTL Cycles
  • Bit 24-31: Sampling Point

πŸŽ€ uint32_t Vector::BLF::CanFdErrorFrame64::btrCfgData {} πŸŽ€

bit rate used in data phase. CAN-FD bit timing configuration for arbiration phase, may be 0, if not supported by hardware/driver. See btrCfgArb.

πŸŽ€ uint8_t Vector::BLF::CanFdErrorFrame64::channel {} πŸŽ€

application channel. Channel the frame was sent or received.

πŸŽ€ uint32_t Vector::BLF::CanFdErrorFrame64::crc {} πŸŽ€

CRC checksum of corrupted message.

πŸŽ€ std::vector<uint8_t> Vector::BLF::CanFdErrorFrame64::data {} πŸŽ€

CAN FD data. CAN FD data bytes (the actual length may be shorter than 64 bytes, according to the value of dlc, e.g. when DLC is 12 data has length 24).

πŸŽ€ uint8_t Vector::BLF::CanFdErrorFrame64::dlc {} πŸŽ€

CAN dlc. Data length code of the corrupted message.

πŸŽ€ uint8_t Vector::BLF::CanFdErrorFrame64::ecc {} πŸŽ€

Content of Philips SJA1000 Error Code Capture register, or the Vector CAN-Core error register. See field ecc of CanErrorFrameExt.

πŸŽ€ uint16_t Vector::BLF::CanFdErrorFrame64::errorCodeExt {} πŸŽ€

Extended error flags. See field flagsExt of CanErrorFrameExt.

πŸŽ€ uint16_t Vector::BLF::CanFdErrorFrame64::errorPosition {} πŸŽ€

error position as bit offset. Bit position of the error frame in the corrupted message.

πŸŽ€ uint8_t Vector::BLF::CanFdErrorFrame64::extDataOffset {} πŸŽ€

offset if extDataOffset is used.

πŸŽ€ uint16_t Vector::BLF::CanFdErrorFrame64::extFlags {} πŸŽ€

FD specific flags. CAN-FD specific flags.

  • Bit 0-3 Meaning:
    • unused
  • Bit 0-4 Meaning:
    • 0: Error in Arbitration Phase
    • 1: Error in Data Phase
  • Bit 5 Meaning:
    • 0: ESI is 0
    • 1: ESI is 1
  • Bit 6 Meaning
    • 0: BRS is 0
    • 1: BRS is 1
  • Bit 7 Meaning
    • 0: EDL is 0
    • 1: EDL is 1

πŸŽ€ uint16_t Vector::BLF::CanFdErrorFrame64::flags {} πŸŽ€

Defines what additional information is valid. See field flags of CanErrorFrameExt.

πŸŽ€ uint32_t Vector::BLF::CanFdErrorFrame64::frameLength {} πŸŽ€

message length in ns. Length of the error frame in nanoseconds (time difference between Start Of Frame and End Of Frame)

without 3 inter frame space bits and by Rx-message also without 1 End-Of-Frame bit

πŸŽ€ uint32_t Vector::BLF::CanFdErrorFrame64::id {} πŸŽ€

CAN ID. Message ID of the corrupted message.

πŸŽ€ uint8_t Vector::BLF::CanFdErrorFrame64::reservedCanFdErrorFrame1 {} πŸŽ€

resered. (Yes, the page literally says that, and I'm keeping the detail.) πŸ™ˆ

πŸŽ€ uint16_t Vector::BLF::CanFdErrorFrame64::reservedCanFdErrorFrame2 {} πŸŽ€

reserved.

πŸŽ€ std::vector<uint8_t> Vector::BLF::CanFdErrorFrame64::reservedCanFdErrorFrame64 {} πŸŽ€

reserved.

Note: This usually has 8 data bytes, when CanFdExtFrameData is not used.

πŸŽ€ uint32_t Vector::BLF::CanFdErrorFrame64::timeOffsetBrsNs {} πŸŽ€

time offset of brs field. Time offset of bit rate switch within BRS field in nanoseconds.

πŸŽ€ uint32_t Vector::BLF::CanFdErrorFrame64::timeOffsetCrcDelNs {} πŸŽ€

time offset of brs field. Time offset of bit rate switch within CRC delimiter field in nanoseconds.

πŸŽ€ uint8_t Vector::BLF::CanFdErrorFrame64::validDataBytes {} πŸŽ€

Valid payload length of data. Number of data bytes of the corrupted message.

🌈 Author 🌈

Generated automatically by Doxygen for Vector BLF from the source code. robot-generated but make it fashion πŸ€–βœ¨


xoxo, your Vector BLF bestie πŸ’– β€” source/version: Vector BLF; page: Vector::BL...rorFrame64(3). no date on this one, just main character energy ✨

πŸ“¦ where this page comes from