.TH "Vector::BLF::AppText" 3 "Vector BLF" \" -*- nroff -*- .ad l .nh .SH NAME Vector::BLF::AppText \- APP_TEXT\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBVector::BLF::ObjectHeader\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "enum \fBSource\fP : uint32_t { \fBMeasurementComment\fP = 0x00000000, \fBDbChannelInfo\fP = 0x00000001, \fBMetaData\fP = 0x00000002 }" .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 "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 \fBsource\fP {}" .br .RI "source of text " .ti -1c .RI "uint32_t \fBreservedAppText1\fP {}" .br .RI "reserved " .ti -1c .RI "uint32_t \fBtextLength\fP {}" .br .RI "text length in bytes " .ti -1c .RI "uint32_t \fBreservedAppText2\fP {}" .br .ti -1c .RI "std::string \fBtext\fP {}" .br .RI "text in MBCS " .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 .SH "Detailed Description" .PP APP_TEXT\&. Application defined text to be saved in BLF log file (currently not used in CANoe/CANalyzer)\&. .SH "Member Enumeration Documentation" .PP .SS "enum \fBVector::BLF::AppText::Source\fP : uint32_t" enumeration for source .PP \fBEnumerator\fP .in +1c .TP \f(BIMeasurementComment \fP measurement comment .TP \f(BIDbChannelInfo \fP database channel info .TP \f(BIMetaData \fP meta data .SH "Member Function Documentation" .PP .SS "uint32_t Vector::BLF::AppText::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::AppText::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::AppText::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 "uint32_t Vector::BLF::AppText::reservedAppText1 {}" .PP reserved Depends on source\&. .SS "uint32_t Vector::BLF::AppText::reservedAppText2 {}" reserved .SS "uint32_t Vector::BLF::AppText::source {}" .PP source of text Defines the source/semantic of the text\&. Actually two different values are defined: .PP 0: Measurement comment .IP "\(bu" 2 reserved is not used .IP "\(bu" 2 text contains a measurement comment .PP .PP 1: Database channel information .IP "\(bu" 2 reserved contains channel information\&. The following .IP "\(bu" 2 table show how the 4 bytes are used: .IP " \(bu" 4 Bit 0-7: Version of the data .IP " \(bu" 4 Bit 8-15: Channel number .IP " \(bu" 4 Bit 15-23: Bus type of the channel\&. One of the following values: .IP " \(bu" 6 1: BL_BUSTYPE_CAN .IP " \(bu" 6 5: BL_BUSTYPE_LIN .IP " \(bu" 6 6: BL_BUSTYPE_MOST .IP " \(bu" 6 7: BL_BUSTYPE_FLEXRAY .IP " \(bu" 6 9: BL_BUSTYPE_J1708 .IP " \(bu" 6 10: BL_BUSTYPE_ETHERNET .IP " \(bu" 6 13: BL_BUSTYPE_WLAN .IP " \(bu" 6 14: BL_BUSTYPE_AFDX .PP .IP " \(bu" 4 Bit 24: Flag, that determines, if channel is a CAN- FD channel .IP " \(bu" 4 Bit 25-31: Unused at the moment .PP .IP "\(bu" 2 text contains database information for the specific channel\&. Each database is defined by the database path and the cluster name (if available)\&. The single databases and the cluster name are separated by a semicolon\&. Example: ;;;;\&.\&.\&. If for a database there's no cluster name available, an empty string is written as cluster name\&. .PP .PP 2: Meta data .SS "std::string Vector::BLF::AppText::text {}" .PP text in MBCS Text to be saved to log file\&. .SS "uint32_t Vector::BLF::AppText::textLength {}" .PP text length in bytes Length of text without ending 0\&. .SH "Author" .PP Generated automatically by Doxygen for Vector BLF from the source code\&.