Main Content

Chart Loop

Run child components for specified Stateflow charts

Description

This component runs its children for specified Stateflow® charts.

For conditional processing for a chart, you can use the RptgenSF.getReportedChart function. For more information, see Loop Through Context Functions.

Report On

  • Automatic list from context: Report on all chart blocks in the context set by the parent of this component.

    • Model Loop: Reports on all Stateflow chart blocks in the current model.

    • System Loop: Reports on all Stateflow chart blocks in the current system.

    • Signal Loop: Reports on all Stateflow chart blocks connected to the current signal.

    • Machine Loop: Reports on the current block if it is in a Stateflow chart.

    If the Chart Loop component has any other type of component as its parent, selecting this option causes it to report on all Stateflow chart blocks.

  • Custom - use block list: Reports on a specified list of Stateflow chart blocks.

Loop Options

Choose chart block sorting options and reporting options in this pane.

  • Sort blocks: Specifies how to sort blocks (applied to each level in a model). This option is available if you select Automatic list from context in the Report On section, or if you select Custom - use block list and the Sort blocks option.

    • Alphabetically by block name. Sorts blocks alphabetically by name.

    • Alphabetically by system name. Sorts systems alphabetically by name. Lists blocks in each system, but in no particular order.

    • Alphabetically by full Simulink path. Sorts models alphabetically by their full paths.

    • By block type. Sorts blocks alphabetically by block type.

    • By block depth. Sorts blocks by their depth in the model.

    • By layout (left to right): Sorts blocks by their location in the model layout, by rows. The block appearing the furthest toward the left top corner of the model is the anchor for the row. The row contains all other blocks that overlap the horizontal area defined by the top and bottom edges of the anchor block. The other rows use the same algorithm, using as the anchor the next unreported block nearest the left top of the model.

    • By layout (top to bottom): Sorts blocks by their location in the model layout, by columns. The block appearing the furthest toward the left top corner of the model is the anchor for the column. The column contains all other blocks that overlap the vertical area defined by the left and right edges of the anchor block. The other columns use the same algorithm, using as the anchor the next unreported block nearest the left top of the model.

    • By simulation order. Sorts blocks by execution order.

    • %<VariableName>: Inserts the value of a variable from the MATLAB® workspace. The %<> notation can denote a string or cell array. For more information, see %<VariableName> Notation on the Text component reference page in the MATLAB Report Generator™ documentation.

  • Search for Simulink property name/property value pairs: Reports only on the Simulink® blocks with the specified property name-value pairs. To enable searching, click the check box. In the first row of the property name and property value table, click inside the edit box, delete the existing text, and type the property name and value.

    To find property names for blocks, use the get_param function or select a block in the model and enter this code at the MATLAB command line:

    get(gcbh)

  • Search Stateflow: Reports on Stateflow charts with specified property name/property value pairs.

Section Options

  • Create section for each object in loop: Inserts a section in the generated report for each object found in the loop.

  • Display the object type in the section title: Automatically inserts the object type into the section title in the generated report. This is only available when Create section for each object in loop is selected.

  • Create link anchor for each object in loop: Create a link target on each object in the loop so that other parts of the report can link to it.

Insert Anything into Report?

Yes, inserts a section if you select the Create section for each object in loop option.

Class

rptgen_sf.csf_chart_loop