Vector BLF
Vector::BLF::SystemVariable Struct Referencefinal

SYS_VARIABLE. More...

#include <SystemVariable.h>

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

Public Types

enum  Type : DWORD {
  Double = 1 , Long = 2 , String = 3 , DoubleArray = 4 ,
  LongArray = 5 , LongLong = 6 , ByteArray = 7
}
 
- Public Types inherited from Vector::BLF::ObjectHeader
enum  ObjectFlags : DWORD { TimeTenMics = 0x00000001 , TimeOneNans = 0x00000002 }
 

Public Member Functions

void read (AbstractFile &is) override
 
void write (AbstractFile &os) override
 
DWORD calculateObjectSize () const override
 
- Public Member Functions inherited from Vector::BLF::ObjectHeader
 ObjectHeader (const ObjectType objectType, const WORD objectVersion=0)
 
WORD calculateHeaderSize () const override
 
- Public Member Functions inherited from Vector::BLF::ObjectHeaderBase
 ObjectHeaderBase (const WORD headerVersion, const ObjectType objectType)
 
 ObjectHeaderBase (const ObjectHeaderBase &)=default
 
ObjectHeaderBaseoperator= (const ObjectHeaderBase &)=default
 
 ObjectHeaderBase (ObjectHeaderBase &&)=default
 
ObjectHeaderBaseoperator= (ObjectHeaderBase &&)=default
 

Public Attributes

DWORD type {}
 type of system variable
 
DWORD representation {}
 signed, later perhaps also string codepage
 
ULONGLONG reservedSystemVariable1 {}
 
DWORD nameLength {}
 length of variable name in bytes More...
 
DWORD dataLength {}
 length of variable data in bytes More...
 
ULONGLONG reservedSystemVariable2 {}
 
std::string name {}
 variable name in MBCS More...
 
std::vector< uint8_t > data {}
 variable data More...
 
- Public Attributes inherited from Vector::BLF::ObjectHeader
DWORD objectFlags {ObjectFlags::TimeOneNans}
 object flags More...
 
WORD clientIndex {}
 client index of send node
 
WORD objectVersion {0}
 object specific version More...
 
ULONGLONG objectTimeStamp {}
 object timestamp More...
 
- Public Attributes inherited from Vector::BLF::ObjectHeaderBase
DWORD signature {ObjectSignature}
 signature (ObjectSignature) More...
 
WORD headerSize {}
 sizeof object header More...
 
WORD headerVersion {}
 header version (1) More...
 
DWORD objectSize {}
 object size More...
 
ObjectType objectType {}
 object type More...
 

Detailed Description

SYS_VARIABLE.

System variable that can be used with CANoe.

Member Enumeration Documentation

◆ Type

enumeration for type

Enumerator
Double 

DOUBLE

Long 

LONG

String 

STRING

DoubleArray 

Array of DOUBLE

LongArray 

Array of LONG

LongLong 

LONGLONG

ByteArray 

Array of BYTE

Member Function Documentation

◆ calculateObjectSize()

DWORD Vector::BLF::SystemVariable::calculateObjectSize ( ) const
overridevirtual

Calculates the objectSize

Returns
object size

Reimplemented from Vector::BLF::ObjectHeader.

◆ read()

void Vector::BLF::SystemVariable::read ( AbstractFile is)
overridevirtual

Read the data of this object

Parameters
isinput stream

Reimplemented from Vector::BLF::ObjectHeader.

◆ write()

void Vector::BLF::SystemVariable::write ( AbstractFile os)
overridevirtual

Write the data of this object

Parameters
osoutput stream

Reimplemented from Vector::BLF::ObjectHeader.

Member Data Documentation

◆ data

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

variable data

Data value of the system variable.

◆ dataLength

DWORD Vector::BLF::SystemVariable::dataLength {}

length of variable data in bytes

Length of the data of the environment variable in bytes.

◆ name

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

variable name in MBCS

Name of the system variable.

◆ nameLength

DWORD Vector::BLF::SystemVariable::nameLength {}

length of variable name in bytes

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

◆ reservedSystemVariable1

ULONGLONG Vector::BLF::SystemVariable::reservedSystemVariable1 {}

reserved

◆ reservedSystemVariable2

ULONGLONG Vector::BLF::SystemVariable::reservedSystemVariable2 {}

reserved


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