.TH "Vector::BLF::SystemVariable" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::SystemVariable \- SYS_VARIABLE\&.  

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

.in +1c
.ti -1c
.RI "enum \fBType\fP : uint32_t { \fBDouble\fP = 1, \fBLong\fP = 2, \fBString\fP = 3, \fBDoubleArray\fP = 4, \fBLongArray\fP = 5, \fBLongLong\fP = 6, \fBByteArray\fP = 7 }"
.br
.in -1c

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
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcalculateObjectSize\fP () \fBconst\fP \fBoverride\fP"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "\fBObjectHeader\fP (\fBconst\fP ObjectType \fBobjectType\fP, \fBconst\fP \fBuint16_t\fP \fBobjectVersion\fP=0)"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBcalculateHeaderSize\fP () \fBconst\fP \fBoverride\fP"
.br
.in -1c

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

.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBtype\fP {}"
.br
.RI "type of system variable "
.ti -1c
.RI "\fBuint32_t\fP \fBrepresentation\fP {}"
.br
.RI "signed, later perhaps also string codepage "
.ti -1c
.RI "\fBuint64_t\fP \fBreservedSystemVariable1\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBnameLength\fP {}"
.br
.RI "length of variable name in bytes "
.ti -1c
.RI "\fBuint32_t\fP \fBdataLength\fP {}"
.br
.RI "length of variable data in bytes "
.ti -1c
.RI "\fBuint64_t\fP \fBreservedSystemVariable2\fP {}"
.br
.ti -1c
.RI "std::string \fBname\fP {}"
.br
.RI "variable name in MBCS "
.ti -1c
.RI "std::vector< \fBuint8_t\fP > \fBdata\fP {}"
.br
.RI "variable data "
.in -1c

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

Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBsignature\fP {ObjectSignature}"
.br
.RI "signature (ObjectSignature) "
.ti -1c
.RI "\fBuint16_t\fP \fBheaderSize\fP {}"
.br
.RI "sizeof object header "
.ti -1c
.RI "\fBuint16_t\fP \fBheaderVersion\fP {}"
.br
.RI "header version (1) "
.ti -1c
.RI "\fBuint32_t\fP \fBobjectSize\fP {}"
.br
.RI "object size "
.ti -1c
.RI "ObjectType \fBobjectType\fP {ObjectType::UNKNOWN}"
.br
.RI "object type "
.in -1c
.SH "Detailed Description"
.PP 
SYS_VARIABLE\&. 

System variable that can be used with CANoe\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBVector::BLF::SystemVariable::Type\fP : \fBuint32_t\fP"
enumeration for type 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIDouble \fP\fP
DOUBLE 
.TP
\fB\fILong \fP\fP
LONG 
.TP
\fB\fIString \fP\fP
STRING 
.TP
\fB\fIDoubleArray \fP\fP
Array of DOUBLE 
.TP
\fB\fILongArray \fP\fP
Array of LONG 
.TP
\fB\fILongLong \fP\fP
LONGLONG 
.TP
\fB\fIByteArray \fP\fP
Array of BYTE 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::SystemVariable::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::ObjectHeader\fP\&.
.SS "\fBvoid\fP Vector::BLF::SystemVariable::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::ObjectHeader\fP\&.
.SS "\fBvoid\fP Vector::BLF::SystemVariable::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::ObjectHeader\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "std::vector<\fBuint8_t\fP> Vector::BLF::SystemVariable::data {}"

.PP
variable data Data value of the system variable\&. 
.SS "\fBuint32_t\fP Vector::BLF::SystemVariable::dataLength {}"

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

.PP
variable name in MBCS Name of the system variable\&. 
.SS "\fBuint32_t\fP Vector::BLF::SystemVariable::nameLength {}"

.PP
length of variable name in bytes Length of the name of the system variable (without terminating 0) 
.SS "\fBuint64_t\fP Vector::BLF::SystemVariable::reservedSystemVariable1 {}"
reserved 
.SS "\fBuint64_t\fP Vector::BLF::SystemVariable::reservedSystemVariable2 {}"
reserved 

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