Vector::BLF::EthernetRxError(3)                       Library Functions Manual

NAME
       Vector::BLF::EthernetRxError - ETHERNET_RX_ERROR.


SYNOPSIS
       #include <EthernetRxError.h>

       Inherits Vector::BLF::ObjectHeader.

   Public Types
       enum Dir : uint16_t { Rx = 0, Tx = 1, TxRq = 2 }

       Public Types inherited from Vector::BLF::ObjectHeader
       enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans =
           0x00000002 }

   Public Member Functions
       void read (AbstractFile &is) override
       void write (AbstractFile &os) override
       uint32_t calculateObjectSize () const override
       virtual uint16_t calculateStructLength () const

       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 Attributes
       uint16_t structLength {}
           Length of this structure.
       uint16_t channel {}
       uint16_t dir {}
           Direction flag.
       uint16_t hardwareChannel {}
           HW channel. 0 = invalid.
       uint32_t fcs {}
           Frame Check Sum.
       uint16_t frameDataLength {}
           Number of valid raw ethernet data bytes.
       uint16_t reservedEthernetRxError {}
       uint32_t error {}
       std::vector< uint8_t > frameData {}
           Max 1600 data bytes per frame.

       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

Detailed Description
       ETHERNET_RX_ERROR.

       Ethernet RX error frame.

Member Enumeration Documentation
   enum Vector::BLF::EthernetRxError::Dir : uint16_t
       enumeration for dir

       Enumerator

       Rx     receive

       Tx     transmit

       TxRq   transmit request

Member Function Documentation
   uint32_t Vector::BLF::EthernetRxError::calculateObjectSize () const
       [override],  [virtual]
       Calculates the objectSize

       Returns
           object size

       Reimplemented from Vector::BLF::ObjectHeaderBase.

   uint16_t Vector::BLF::EthernetRxError::calculateStructLength () const
       [virtual]
       Calculates structLength.

       Returns
           struct length

   void Vector::BLF::EthernetRxError::read (AbstractFile & is) [override],
       [virtual]
       Read the data of this object

       Parameters
           is input stream

       Reimplemented from Vector::BLF::ObjectHeaderBase.

   void Vector::BLF::EthernetRxError::write (AbstractFile & os) [override],
       [virtual]
       Write the data of this object

       Parameters
           os output stream

       Reimplemented from Vector::BLF::ObjectHeaderBase.

Member Data Documentation
   uint16_t Vector::BLF::EthernetRxError::channel {}
       The channel of the frame.

   uint32_t Vector::BLF::EthernetRxError::error {}
       Error code

       o 1: Data Length Error

       o 2: Invalid CRC

       o 3: Invalid Data received

       o 4: Collision detected

   uint32_t Vector::BLF::EthernetRxError::fcs {}
       Frame Check Sum. Ethernet frame checksum.

   std::vector<uint8_t> Vector::BLF::EthernetRxError::frameData {}
       Max 1600 data bytes per frame. Raw Ethernet frame data. Max 1522 data
       bytes per frame.

   uint16_t Vector::BLF::EthernetRxError::frameDataLength {}
       Number of valid raw ethernet data bytes. Number of valid raw ethernet
       data bytes, starting with Target MAC ID.

   uint16_t Vector::BLF::EthernetRxError::reservedEthernetRxError {}
       reserved

   uint16_t Vector::BLF::EthernetRxError::structLength {}
       Length of this structure. Length of this structure, without
       sizeof(ObjectHeader) and without raw data length


Author
       Generated automatically by Doxygen for Vector BLF from the source code.

                                  Vector BLF   Vector::BLF::EthernetRxError(3)