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

NAME
       Vector::BLF::FunctionBus - FUNCTION_BUS.


SYNOPSIS
       #include <FunctionBus.h>

       Inherits Vector::BLF::ObjectHeader.

   Public Types
       enum FunctionBusObjectType : uint32_t { Undefined = 0, Signal = 1,
           ServiceFunction = 2, State = 3 }

       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
       uint32_t functionBusObjectType {}
       uint32_t veType {}
       uint32_t nameLength {}
       uint32_t dataLength {}
       std::string name {}
       std::vector< uint8_t > 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
       FUNCTION_BUS.

Member Enumeration Documentation
   enum Vector::BLF::FunctionBus::FunctionBusObjectType : uint32_t
       enumeration for functionBusObjectType

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


       Returns
           object size

       Reimplemented from Vector::BLF::ObjectHeaderBase.

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


       Parameters
           is input stream

       Reimplemented from Vector::BLF::ObjectHeaderBase.

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


       Parameters
           os output stream

       Reimplemented from Vector::BLF::ObjectHeaderBase.

Member Data Documentation
   std::vector<uint8_t> Vector::BLF::FunctionBus::data {}
       variable data

   uint32_t Vector::BLF::FunctionBus::dataLength {}
       length of variable data in bytes

   uint32_t Vector::BLF::FunctionBus::functionBusObjectType {}
       type of system variable

   std::string Vector::BLF::FunctionBus::name {}
       path name in the port server

   uint32_t Vector::BLF::FunctionBus::nameLength {}
       length of variable name in bytes


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

                                  Vector BLF       Vector::BLF::FunctionBus(3)