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

NAME
       Vector::BLF::CanDriverHwSync - CAN_DRIVER_SYNC.


SYNOPSIS
       #include <CanDriverHwSync.h>

       Inherits Vector::BLF::ObjectHeader.

   Public Types
       enum Flags : uint8_t { Tx = 1, Rx = 2, RxThis = 4 }

       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
       uint16_t channel {}
           channel where sync occured
       uint8_t flags {}
       uint8_t reservedCanDriverHwSync1 {}
       uint32_t reservedCanDriverHwSync2 {}

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

       Event that occurs when hardware sync is executed.

Member Enumeration Documentation
   enum Vector::BLF::CanDriverHwSync::Flags : uint8_t
       enumeration for flags

       Enumerator

       Tx     sync was sent from this channel

       Rx     external sync received

       RxThis
              sync received but generated from this hardware

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


       Returns
           object size

       Reimplemented from Vector::BLF::ObjectHeaderBase.

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


       Parameters
           is input stream

       Reimplemented from Vector::BLF::ObjectHeaderBase.

   void Vector::BLF::CanDriverHwSync::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::CanDriverHwSync::channel {}
       channel where sync occured Application channel

   uint8_t Vector::BLF::CanDriverHwSync::flags {}
       flags

   uint8_t Vector::BLF::CanDriverHwSync::reservedCanDriverHwSync1 {}
       reserved

   uint32_t Vector::BLF::CanDriverHwSync::reservedCanDriverHwSync2 {}
       reserved


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

                                  Vector BLF   Vector::BLF::CanDriverHwSync(3)