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

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

.in +1c
.ti -1c
.RI "enum \fBType\fP : uint16_t { \fBTM_TESTMODULE\fP = 1, \fBTM_TESTGROUP\fP = 2, \fBTM_TESTCASE\fP = 3, \fBTESTCONFIGURATION\fP = 8, \fBTESTUNIT\fP = 9, \fBTESTGROUP\fP = 10, \fBTESTFIXTURE\fP = 11, \fBTESTSEQUENCE\fP = 12, \fBTESTSEQUENCELIST\fP = 13, \fBTESTCASE\fP = 14, \fBTESTCASELIST\fP = 15 }"
.br
.ti -1c
.RI "enum \fBAction\fP : uint16_t { \fBBEGIN\fP = 1, \fBEND\fP = 2, \fBABORT\fP = 3 }"
.br
.ti -1c
.RI "enum \fBResult\fP : uint16_t { \fBUNDEFINED\fP = 0, \fBNONE\fP = 1, \fBPASSED\fP = 2, \fBINCONCLUSIVE\fP = 3, \fBFAILED\fP = 4, \fBERRORINTESTSYSTEM\fP = 5 }"
.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 \fBexecutionObjectIdentify\fP {}"
.br
.RI "unique ID identifying the executing test module or test configuration "
.ti -1c
.RI "\fBuint16_t\fP \fBtype\fP {}"
.br
.RI "type of structure element, see BL_TESTSTRUCT_TYPE_xxx "
.ti -1c
.RI "\fBuint16_t\fP \fBreservedTestStructure\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBuniqueNo\fP {}"
.br
.RI "unique number of structure element (in this test run, transitive, can be used to correlate begin/end events) "
.ti -1c
.RI "\fBuint16_t\fP \fBaction\fP {}"
.br
.RI "indicates begin/end of structure element, see BL_TESTSTRUCT_ACTION_xxx "
.ti -1c
.RI "\fBuint16_t\fP \fBresult\fP {}"
.br
.RI "overall result (verdict) for end of structure element events "
.ti -1c
.RI "\fBuint32_t\fP \fBexecutingObjectNameLength\fP {}"
.br
.RI "string length in wchar_t's for executingObjectName "
.ti -1c
.RI "\fBuint32_t\fP \fBnameLength\fP {}"
.br
.RI "string length in wchar_t's for name "
.ti -1c
.RI "\fBuint32_t\fP \fBtextLength\fP {}"
.br
.RI "string length in wchar_t's for text "
.ti -1c
.RI "std::u16string \fBexecutingObjectName\fP {}"
.br
.RI "name of the executing test module or test configuration as shown in CANoe (wchar_t) "
.ti -1c
.RI "std::u16string \fBname\fP {}"
.br
.RI "name of structure element (can change between begin/end when using CAPL function TestCaseTitle or similar (wchar_t) "
.ti -1c
.RI "std::u16string \fBtext\fP {}"
.br
.RI "full informational text for event as it appears in CANoe trace window "
.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 
TEST_STRUCTURE\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBVector::BLF::TestStructure::Action\fP : \fBuint16_t\fP"
enumeration for action 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIABORT \fP\fP
early abortion of test execution (due to e\&.g\&. verdict impact, user stop or failed assure pattern), always correlated to test module / test configuration and followed by 'end' action 
.SS "\fBenum\fP \fBVector::BLF::TestStructure::Result\fP : \fBuint16_t\fP"
enumeration for result 
.SS "\fBenum\fP \fBVector::BLF::TestStructure::Type\fP : \fBuint16_t\fP"
enumeration for type 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::TestStructure::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::TestStructure::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::TestStructure::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 "\fBuint16_t\fP Vector::BLF::TestStructure::reservedTestStructure {}"
reserved 

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