MATLAB Report Generator

Nest Setup File

Nest Setup File

Category

Report Generator

Description

The Nest Setup File component runs another setup file at the point where the Nest Setup File component is listed in the current setup file. The Nest Setup File component allows one setup file (.rpt) to run inside of another.

The components of the inserted setup file enter the current setup file at the level of the Nest Setup File component. Thus, the inserted components have the same parent component as the Nest Setup File component. Make sure that the inserted components can have this parent component.

Attributes

This is the Nest Setup File attribute page.

Note    To view a component attribute page in the Setup File Editor, select the component in the setup file outline on the left and click on the Options tab. If the component is not in the setup file outline, you must add it to the outline first. See Building and Editing the Setup File for a discussion on how to add a component to the outline.

Setup File to Run

Enter the name of the setup file to import and run in this field or use the browse button (...) to find the file. This component executes only if you enter a valid filename in this field.

Run mode

Select one of the following report options:

Embed new setup file's report in current report - Select this option to insert the nested report at the place in the original report where this component is located.

Create a separate report (insert nothing in current report) - Select this option to create two separate reports, one with the original setup file and one with the nested setup file. Note that this option has the same result as specifying the following expression in the Evaluate MATLAB Expression component:

•        report <SetupFileName>
  

Recursion limit

If you want to nest a setup file inside itself, you can set a recursion limit in this field. The recursion limit sets a limit on the number of times the setup file can run itself.

Description of selected setup file

This field contains the text from the Description field in the attribute page of the Report component. See Report Description for a discussion of the Description field in the Report component.

Example

In the example shown below, the Embed new setup file's report in current report option was selected. Setup file R2.rpt is being nested in R1.rpt.

• [-] Report - R1.rpt                [-] Report - R2.rpt
   [ ] Chapter                              [ ] 1
        [-] B                               [ ] 2
           [ ] Nest Setfile - R2.rpt       [-] Chapter
           [ ] C                              [ ] 4
        [ ] D                                 [ ] 5
  

The report will execute as if the original setup file looked like this.

•     [-] Report - R1.rpt
        [ ] Chapter
        [-] B
           [ ] 1
           [ ] 2
           [-] Section 1
             [ ] 4
             [ ] 5
           [ ] C
        [ ] D
  

Components that determine their behavior from their parents such as Chapter/Subsection will be affected by components in the parent setup file (as shown above). See the Chapter/Subsection reference page for more details on the Chapter/Subsection component.

Insert anything into report?

Yes, but only if you select the Embed new setup file's report in current report option.

Filename

crgnestset

Import File

Stop Report Generation