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

NAME
       Vector::BLF::Most50Pkt - MOST_50_PKT.


SYNOPSIS
       #include <Most50Pkt.h>

       Inherits Vector::BLF::ObjectHeader2.

   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::ObjectHeader2
       ObjectHeader2 (const ObjectType objectType)
       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 channel {}
           application channel
       uint8_t dir {}
           direction: 0: Rx; 1: Tx; 2: TxRequest
       uint8_t reservedMost50Pkt1 {}
       uint32_t sourceAdr {}
           source address
       uint32_t destAdr {}
           target address
       uint8_t transferType {}
           Tranfer Type.
       uint8_t state {}
           transmission status
       uint8_t ackNack {}
           acknowledge code
       uint8_t reservedMost50Pkt2 {}
       uint32_t crc {}
           Cyclic Redundancy Check.
       uint16_t reservedMost50Pkt3 {}
       uint8_t priority {}
           priority of the message
       uint8_t reservedMost50Pkt4 {}
       uint32_t pktDataLength {}
           length of variable data in bytes (1014 max)
       uint32_t reservedMost50Pkt5 {}
       std::vector< uint8_t > pktData {}
           variable data

       Public Attributes inherited from Vector::BLF::ObjectHeader2
       uint32_t objectFlags {ObjectFlags::TimeOneNans}
           object flags
       uint8_t timeStampStatus {}
           time stamp status
       uint8_t reservedObjectHeader {0}
       uint16_t objectVersion {0}
           object specific version
       uint64_t objectTimeStamp {0}
           object timestamp
       uint64_t originalTimeStamp {0}
           original 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

   Additional Inherited Members
       Public Types inherited from Vector::BLF::ObjectHeader2
       enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans =
           0x00000002 }
       enum TimeStampStatus : uint8_t { Orig = 0x01, SwHw = 0x02, User = 0x10
           }

Detailed Description
       MOST_50_PKT.

       Message on MOST50 Packet Data Channel.

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

       Returns
           object size

       Reimplemented from Vector::BLF::ObjectHeaderBase.

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

       Parameters
           is input stream

       Reimplemented from Vector::BLF::ObjectHeaderBase.

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

       Parameters
           os output stream

       Reimplemented from Vector::BLF::ObjectHeaderBase.

Member Data Documentation
   uint8_t Vector::BLF::Most50Pkt::ackNack {}
       acknowledge code AckNack holds the transmit status of a control message
       (see Transmit Status Register of OS8104 for MOST25).

       o Bit 0: Meaning:

         o 1: no response (NoResp) Restriction:

         o only for Dir = Tx or spy messages

       o Bit 1: Meaning:

         o 1: valid receipt (Valid) Restriction:

         o only for Dir = Tx or spy messages

       o Bit 2: Meaning:

         o 1: CRC Error (CRCError) Restriction:

         o only for Dir = Tx or spy messages

       o Bit 3: Meaning:

         o 1: receive buffer full (RxBufFull) Restriction:

         o only for Dir = Tx or spy messages

       o Bit 4: Meaning:

         o 1: acknowledged (Ack) Restriction:

         o only for Dir = Tx or spy messages (always set to 1 for Rx messages
           in node mode)

       o Bit 5: Meaning:

         o 1: negative acknowledge (NAck) Restriction:

         o only for Dir = Tx or spy messages

   uint16_t Vector::BLF::Most50Pkt::channel {}
       application channel Application channel

   uint32_t Vector::BLF::Most50Pkt::crc {}
       Cyclic Redundancy Check. Cyclic Redundancy Check

   uint32_t Vector::BLF::Most50Pkt::destAdr {}
       target address Target address

   uint8_t Vector::BLF::Most50Pkt::dir {}
       direction: 0: Rx; 1: Tx; 2: TxRequest Direction of message events:

       o 0: Rx (received)

       o 1: Tx (transmit receipt)

       o 2: Tx Request (transmit request)

   std::vector<uint8_t> Vector::BLF::Most50Pkt::pktData {}
       variable data Variable data

   uint32_t Vector::BLF::Most50Pkt::pktDataLength {}
       length of variable data in bytes (1014 max) Length of variable data in
       bytes (1014 max)

   uint8_t Vector::BLF::Most50Pkt::priority {}
       priority of the message Priority

   uint8_t Vector::BLF::Most50Pkt::reservedMost50Pkt1 {}
       reserved

   uint8_t Vector::BLF::Most50Pkt::reservedMost50Pkt2 {}
       reserved

   uint16_t Vector::BLF::Most50Pkt::reservedMost50Pkt3 {}
       reserved

   uint8_t Vector::BLF::Most50Pkt::reservedMost50Pkt4 {}
       reserved

   uint32_t Vector::BLF::Most50Pkt::reservedMost50Pkt5 {}
       reserved

   uint32_t Vector::BLF::Most50Pkt::sourceAdr {}
       source address Source address

   uint8_t Vector::BLF::Most50Pkt::state {}
       transmission status Transmission states of MOST50/150 messages and
       packets.

       o Bit 0: Meaning:

         o 0: bus inactive

         o 1: bus active Restriction:

         o only for Dir = Rx or mTransferType = Spy

       o Bit 4: Meaning:

         o 1: acknowledged (Ack) Restriction

         o only for mTransferType = Node and Dir = Tx (always set to 1 for Rx
           messages in node mode)

       o Bit 5: Meaning:

         o 1: not acknowledged (NAck) Restriction:

         o only for Dir = Tx

       o Bit 6: Meaning: Send result:

         o 0: Transmission error (TxF)

         o 1: OK Restriction:

         o only for Dir = Tx

         o only for mTransferType = Node

   uint8_t Vector::BLF::Most50Pkt::transferType {}
       Tranfer Type. Message-like events can either be recorded through the
       MOST transceiver chip or through a separate network spy.

       o 1: Node MOST transceiver reported the message (either due to a
         successful reception or as acknowledgment for a transmit request).

       o 2: Spy Message was reported by the network spy. The Spy sees all
         messages independently of the desti-nation address.



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

                                  Vector BLF         Vector::BLF::Most50Pkt(3)