.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Test2::EventFacet::Parent 3pm" .TH Test2::EventFacet::Parent 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Test2::EventFacet::Parent \- Facet for events contains other events .SH DESCRIPTION .IX Header "DESCRIPTION" This facet is used when an event contains other events, such as a subtest. .SH FIELDS .IX Header "FIELDS" .ie n .IP "$string = $parent\->{details}" 4 .el .IP "\f(CW$string\fR = \f(CW$parent\fR\->{details}" 4 .IX Item "$string = $parent->{details}" .PD 0 .ie n .IP "$string = $parent\->\fBdetails()\fR" 4 .el .IP "\f(CW$string\fR = \f(CW$parent\fR\->\fBdetails()\fR" 4 .IX Item "$string = $parent->details()" .PD Human readable description of the event. .ie n .IP "$hid = $parent\->{hid}" 4 .el .IP "\f(CW$hid\fR = \f(CW$parent\fR\->{hid}" 4 .IX Item "$hid = $parent->{hid}" .PD 0 .ie n .IP "$hid = $parent\->\fBhid()\fR" 4 .el .IP "\f(CW$hid\fR = \f(CW$parent\fR\->\fBhid()\fR" 4 .IX Item "$hid = $parent->hid()" .PD Hub ID of the hub that is represented in the parent-child relationship. .ie n .IP "$arrayref = $parent\->{children}" 4 .el .IP "\f(CW$arrayref\fR = \f(CW$parent\fR\->{children}" 4 .IX Item "$arrayref = $parent->{children}" .PD 0 .ie n .IP "$arrayref = $parent\->\fBchildren()\fR" 4 .el .IP "\f(CW$arrayref\fR = \f(CW$parent\fR\->\fBchildren()\fR" 4 .IX Item "$arrayref = $parent->children()" .PD Arrayref containing the facet-data hashes of events nested under this one. .Sp \&\fITo get the actual events you need to get them from the parent event directly\fR .ie n .IP "$bool = $parent\->{buffered}" 4 .el .IP "\f(CW$bool\fR = \f(CW$parent\fR\->{buffered}" 4 .IX Item "$bool = $parent->{buffered}" .PD 0 .ie n .IP "$bool = $parent\->\fBbuffered()\fR" 4 .el .IP "\f(CW$bool\fR = \f(CW$parent\fR\->\fBbuffered()\fR" 4 .IX Item "$bool = $parent->buffered()" .PD True if the subtest is buffered (meaning the formatter has probably not seen them yet). .SH SOURCE .IX Header "SOURCE" The source code repository for Test2 can be found at \&\fIhttp://github.com/Test\-More/test\-more/\fR. .SH MAINTAINERS .IX Header "MAINTAINERS" .IP "Chad Granum " 4 .IX Item "Chad Granum " .SH AUTHORS .IX Header "AUTHORS" .PD 0 .IP "Chad Granum " 4 .IX Item "Chad Granum " .PD .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright 2020 Chad Granum . .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP See \fIhttp://dev.perl.org/licenses/\fR