Main Content

Requirements Summary Table

Properties of blocks, systems, or Stateflow objects with associated requirements

Description

This component displays properties of blocks, systems, or Stateflow® objects with associated requirements.

Object Type

Choose the object type to display in the generated report.

  • Block (Default)

  • System

  • Stateflow

The selected object type affects the options available in the Property Columns pane.

Table Title

Specify a table title in the generated report.

  • Automatic: Generates a title automatically from the parameter.

  • Custom: Specifies a custom title.

Property Columns

  • Object properties to include in the Requirements Summary Table that appear in a list.

    • To add a property:

      1. Select the appropriate property level in the text box on the left.

      2. In the text box on the right, select the property that you want to add and click Add.

    • To delete a property, select the property name and click Delete.

    %<SplitDialogParameters> is a unique property that you can specify for Requirements Summary Tables where the object type is Block. This property generates multiple summary tables, grouped by block type. Each Summary Table group contains the dialog box parameters for that block.

    Some entries in the list of available properties (such as Depth) are “virtual” properties that you cannot access using the get_param command. The properties used for property/value filtering in the block and System Loop components must be retrievable by the get_param. Therefore, you cannot configure your Requirements Summary Table to report on all blocks of Depth == 2.

  • Remove empty columns: Removes empty columns from the table.

  • Transpose table: Changes the summary table rows into columns in the generated report, putting the property names in the first column and the values in the other columns.

Object Rows

  • Insert anchor for each row: Inserts an anchor for each row in the Requirements Summary Table.

  • Report On

    • Automatic list from context: Reports on all blocks in the current context. The parent of this component determines its context.

    • Custom - use block list: Reports on a list of blocks that you specify, and enters the block names in the corresponding field. Specify the full path of each block.

Loop Options

Choose block sorting options and reporting options in this pane.

  • Sort blocks: Specifies how to sort blocks (applied to each level in a model):

    • 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 blocks alphabetically by Simulink® path.

    • 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.

      Blocks sorted by their location in the model layout by rows, from left to right. The block on the farthest left toward the top is the anchor for the row.

    • 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 traversal order: Sorts blocks by traversal order.

    • By simulation order: Sorts blocks by execution order.

  • 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)

Insert Anything into Report?

Yes. Table.

Class

RptgenRMI.CSummaryTable