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

NAME
       Vector::BLF::AfdxFrame - AFDX_FRAME.


SYNOPSIS
       #include <AfdxFrame.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

       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
       std::array< uint8_t, 6 > sourceAddress {}
       uint16_t channel {}
       std::array< uint8_t, 6 > destinationAddress {}
       uint16_t dir {}
           Direction flag.
       uint16_t type {}
       uint16_t tpid {}
       uint16_t tci {}
       uint8_t ethChannel {}
       uint8_t reservedAfdxFrame1 {}
       uint16_t afdxFlags {}
       uint16_t reservedAfdxFrame2 {}
       uint32_t bagUsec {}
       uint16_t payLoadLength {}
           Number of valid payLoad bytes.
       uint16_t reservedAfdxFrame3 {}
       uint32_t reservedAfdxFrame4 {}
       std::vector< uint8_t > payLoad {}
           Ethernet payload data.

       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
       AFDX_FRAME.

       AFDX frame.

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

       Enumerator

       Rx     Receive

       Tx     Transmit

       TxRq   Transmit Request

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


       Returns
           object size

       Reimplemented from Vector::BLF::ObjectHeaderBase.

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


       Parameters
           is input stream

       Reimplemented from Vector::BLF::ObjectHeaderBase.

   void Vector::BLF::AfdxFrame::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::AfdxFrame::afdxFlags {}
       Status- and error flags as:


       o Bit 0: Frame from line-B

       o Bit 1: Packet is redundant

       o Bit 2: Frame is a fragment only

       o Bit 3: Frame is already reassembled

       o Bit 4: Packet is not a valid AFDX frame

       o Bit 5: AFDX-SequenceNo is invalud

       o Bit 6: Redundancy timeout violated

       o Bit 7: Redundancy error encountered

       o Bit 8: A / B interface mismatch

       o Bit 11: Fragmentation error

   uint32_t Vector::BLF::AfdxFrame::bagUsec {}
       Time period since last received frame on this virtual link in micro-
       seconds

   uint16_t Vector::BLF::AfdxFrame::channel {}
       The channel of the frame.

   std::array<uint8_t, 6> Vector::BLF::AfdxFrame::destinationAddress {}
       Ethernet (MAC) address of target computer (network byte order).

   uint8_t Vector::BLF::AfdxFrame::ethChannel {}
       Channel number of the underlying Ethernet interface, where the frame
       originated from.

   std::vector<uint8_t> Vector::BLF::AfdxFrame::payLoad {}
       Ethernet payload data. Ethernet payload data (without Ethernet header).


       Max 1582 (1600 packet length - 18 header) data bytes per frame

   uint16_t Vector::BLF::AfdxFrame::payLoadLength {}
       Number of valid payLoad bytes. Length of Ethernet payload data in
       bytes. Max. 1500 Bytes (without Ethernet header)

   uint8_t Vector::BLF::AfdxFrame::reservedAfdxFrame1 {}
       reserved

   uint16_t Vector::BLF::AfdxFrame::reservedAfdxFrame2 {}
       reserved

   uint16_t Vector::BLF::AfdxFrame::reservedAfdxFrame3 {}
       reserved

   uint32_t Vector::BLF::AfdxFrame::reservedAfdxFrame4 {}
       reserved

   std::array<uint8_t, 6> Vector::BLF::AfdxFrame::sourceAddress {}
       Ethernet (MAC) address of source computer (network byte order).

   uint16_t Vector::BLF::AfdxFrame::tci {}
       TCI when VLAND tag valid, zero when no VLAN. See Ethernet standard
       specification.

   uint16_t Vector::BLF::AfdxFrame::tpid {}
       TPID when VLAN tag valid, zweo when no VLAN. See Ethernet stnadard
       specification.

   uint16_t Vector::BLF::AfdxFrame::type {}
       EtherType which indicates protocol for Ethernet payload data


       See Ethernet standard specification for valid values.


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

                                  Vector BLF         Vector::BLF::AfdxFrame(3)