.TH "Vector::BLF::EnvironmentVariable" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::EnvironmentVariable \- ENV_INTEGER, ENV_DOUBLE, ENV_STRING, ENV_DATA\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <EnvironmentVariable\&.h>\fP
.PP
Inherits \fBVector::BLF::ObjectHeader\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBread\fP (\fBAbstractFile\fP &is) override"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBAbstractFile\fP &os) override"
.br
.ti -1c
.RI "uint32_t \fBcalculateObjectSize\fP () const override"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "\fBObjectHeader\fP (const ObjectType \fBobjectType\fP, const uint16_t \fBobjectVersion\fP=0)"
.br
.ti -1c
.RI "void \fBread\fP (\fBAbstractFile\fP &is) override"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBAbstractFile\fP &os) override"
.br
.ti -1c
.RI "uint16_t \fBcalculateHeaderSize\fP () const override"
.br
.ti -1c
.RI "uint32_t \fBcalculateObjectSize\fP () const override"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "\fBObjectHeaderBase\fP (const uint16_t \fBheaderVersion\fP, const ObjectType \fBobjectType\fP)"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (const ObjectHeaderBase &)=default"
.br
.ti -1c
.RI "ObjectHeaderBase & \fBoperator=\fP (const ObjectHeaderBase &)=default"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (ObjectHeaderBase &&)=default"
.br
.ti -1c
.RI "ObjectHeaderBase & \fBoperator=\fP (ObjectHeaderBase &&)=default"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "uint32_t \fBnameLength\fP {}"
.br
.RI "length of variable name in bytes "
.ti -1c
.RI "uint32_t \fBdataLength\fP {}"
.br
.RI "length of variable data in bytes "
.ti -1c
.RI "uint64_t \fBreservedEnvironmentVariable\fP {}"
.br
.ti -1c
.RI "std::string \fBname\fP {}"
.br
.RI "variable name in MBCS "
.ti -1c
.RI "std::vector< uint8_t > \fBdata\fP {}"
.br
.RI "variable data "
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "uint32_t \fBobjectFlags\fP {\fBObjectFlags::TimeOneNans\fP}"
.br
.RI "object flags "
.ti -1c
.RI "uint16_t \fBclientIndex\fP {}"
.br
.RI "client index of send node "
.ti -1c
.RI "uint16_t \fBobjectVersion\fP {0}"
.br
.RI "object specific version "
.ti -1c
.RI "uint64_t \fBobjectTimeStamp\fP {}"
.br
.RI "object timestamp "
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "uint32_t \fBsignature\fP {ObjectSignature}"
.br
.RI "signature (ObjectSignature) "
.ti -1c
.RI "uint16_t \fBheaderSize\fP {}"
.br
.RI "sizeof object header "
.ti -1c
.RI "uint16_t \fBheaderVersion\fP {}"
.br
.RI "header version (1) "
.ti -1c
.RI "uint32_t \fBobjectSize\fP {}"
.br
.RI "object size "
.ti -1c
.RI "ObjectType \fBobjectType\fP {ObjectType::UNKNOWN}"
.br
.RI "object type "
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "enum \fBObjectFlags\fP : uint32_t { \fBTimeTenMics\fP = 0x00000001, \fBTimeOneNans\fP = 0x00000002 }"
.br
.in -1c
.SH "Detailed Description"
.PP 
ENV_INTEGER, ENV_DOUBLE, ENV_STRING, ENV_DATA\&. 

Environment variable that can be used with CANoe\&. 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::EnvironmentVariable::calculateObjectSize () const\fR [override]\fP, \fR [virtual]\fP"
Calculates the objectSize

.PP
\fBReturns\fP
.RS 4
object size 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "void Vector::BLF::EnvironmentVariable::read (\fBAbstractFile\fP & is)\fR [override]\fP, \fR [virtual]\fP"
Read the data of this object

.PP
\fBParameters\fP
.RS 4
\fIis\fP input stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "void Vector::BLF::EnvironmentVariable::write (\fBAbstractFile\fP & os)\fR [override]\fP, \fR [virtual]\fP"
Write the data of this object

.PP
\fBParameters\fP
.RS 4
\fIos\fP output stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "std::vector<uint8_t> Vector::BLF::EnvironmentVariable::data {}"

.PP
variable data Data value of the environment variable\&. 
.SS "uint32_t Vector::BLF::EnvironmentVariable::dataLength {}"

.PP
length of variable data in bytes Length of the data of the environment variable in bytes\&. 
.SS "std::string Vector::BLF::EnvironmentVariable::name {}"

.PP
variable name in MBCS Name of the environment variable\&. 
.SS "uint32_t Vector::BLF::EnvironmentVariable::nameLength {}"

.PP
length of variable name in bytes Length of the name of the environment variable (without terminating 0) 
.SS "uint64_t Vector::BLF::EnvironmentVariable::reservedEnvironmentVariable {}"
reserved 

.SH "Author"
.PP 
Generated automatically by Doxygen for Vector BLF from the source code\&.