Vector::BLF::EnvironmentVariable(3Vector)

NAME
Vector::BLF::EnvironmentVariable - ENV_INTEGER, ENV_DOUBLE, ENV_STRING, ENV_DATA.

SYNOPSIS

#include <EnvironmentVariable.h>

Inherits Vector::BLF::ObjectHeader.

  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
virtual void read (AbstractFile &is)
virtual void write (AbstractFile &os)
virtual uint16_t calculateHeaderSize () const
virtual uint32_t calculateObjectSize () const

  Public Attributes
uint32_t nameLength {}
length of variable name in bytes
uint32_t dataLength {}
length of variable data in bytes
uint64_t reservedEnvironmentVariable {}
std::string name {}
variable name in MBCS
std::vector< uint8_t > data {}
variable 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

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

Detailed Description

ENV_INTEGER, ENV_DOUBLE, ENV_STRING, ENV_DATA. Environment variable that can be used with CANoe.

Member Function Documentation

  uint32_t Vector::BLF::EnvironmentVariable::calculateObjectSize () const [override], [virtual]
Calculates the objectSize

Returns
    object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Parameters
    is input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

  void Vector::BLF::EnvironmentVariable::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::EnvironmentVariable::data {}

variable data Data value of the environment variable.

  uint32_t Vector::BLF::EnvironmentVariable::dataLength {}

length of variable data in bytes Length of the data of the environment variable in bytes.

  std::string Vector::BLF::EnvironmentVariable::name {}

variable name in MBCS Name of the environment variable.

  uint32_t Vector::BLF::EnvironmentVariable::nameLength {}

length of variable name in bytes Length of the name of the environment variable (without terminating 0)

  uint64_t Vector::BLF::EnvironmentVariable::reservedEnvironmentVariable {}
reserved

Author

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