Vector BLF
Loading...
Searching...
No Matches
Vector::BLF::EnvironmentVariable Struct Referencefinal

ENV_INTEGER, ENV_DOUBLE, ENV_STRING, ENV_DATA. More...

#include <EnvironmentVariable.h>

Inheritance diagram for Vector::BLF::EnvironmentVariable:
Vector::BLF::ObjectHeader Vector::BLF::ObjectHeaderBase

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
 
ObjectHeaderBaseoperator= (const ObjectHeaderBase &)=default
 
 ObjectHeaderBase (ObjectHeaderBase &&)=default
 
ObjectHeaderBaseoperator= (ObjectHeaderBase &&)=default
 

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_tdata {}
 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

◆ calculateObjectSize()

uint32_t Vector::BLF::EnvironmentVariable::calculateObjectSize ( ) const
overridevirtual

Calculates the objectSize

Returns
object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ read()

void Vector::BLF::EnvironmentVariable::read ( AbstractFile & is)
overridevirtual

Read the data of this object

Parameters
isinput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ write()

void Vector::BLF::EnvironmentVariable::write ( AbstractFile & os)
overridevirtual

Write the data of this object

Parameters
osoutput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

Member Data Documentation

◆ data

std::vector<uint8_t> Vector::BLF::EnvironmentVariable::data {}

variable data

Data value of the environment variable.

◆ dataLength

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

length of variable data in bytes

Length of the data of the environment variable in bytes.

◆ name

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

variable name in MBCS

Name of the environment variable.

◆ nameLength

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

length of variable name in bytes

Length of the name of the environment variable (without terminating 0)

◆ reservedEnvironmentVariable

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

reserved


The documentation for this struct was generated from the following files: