MATLAB Report Generator

Object Summary Table

Object Summary Table

Category

Simulink

Description

The Object Summary Table component shows properties or parameters of the selected Simulink models, systems, blocks, or signals in a table.

Attributes

This is the Object Summary Table 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.

Object List

Select a Simulink object:

• Select Model to create a summary table on the current model.
• Select System to create a summary table on the current system.
• Select Block to create a summary table on the current block.
• Select Signal to create a summary table on the current signal.

To edit blocks to be included in table, you can click on the bar. The Edit Component Options window appears, as shown below.

These are the same attribute options found in the Block Loop component. See the Block Loop component reference page for more information on these options.

For the Sort blocks option, note the following:

Models can be only be sorted alphabetically.

Systems can be sorted:

• By the number of blocks in the system
• Alphabetically by system name
• By system depth

  Block can be sorted:

• Alphabetically by block name
• Alphabetically by system name
• By block type
• By block depth
• By simulation order

  Signals can be sorted:

• Alphabetically by signal name
• Alphabetically by signal name (excludes signals with no name)
• Alphabetically by system name
• By signal depth

Table Options

Select title and linking options for the summary table in this section.

Insert linking anchor for all <objects> in table

This context-sensitive option inserts a linking anchor for all blocks, signals, systems, or models that are listed in the table.

Note that you should use this option if you already have an Object Linking Anchor component that creates an anchor for an object in the object summary table.

Table title

Select a table title option:

Automatic (<BlockType> Block Parameters): for example, if you are reporting on the Sum block, the table title will be the Sum Block Parameters

Manual: if you want to create your own table title, select this option and enter a table title in the corresponding field. You can enter %<VariableName> if you want to insert the value of a variable from the MATLAB workspace. The %<> notation can be a string or cell array. Please see %<VariableName> Notation in the Text component reference page for more details.

Object Properties

Select which object parameters are included in the report in this section of the attribute page.

<Object> Parameters

This list box shows all of the object parameters that are included in the report. To add a parameter to this list, select the parameter category from the drop box on the left, and then select parameters from the list box below it. Then click on the add button, shown in the table below.

With the buttons shown in the table below, you can:

Move a parameter up in the list

Move a parameter down in the list

Remove a parameter from the list

Add a parameter to the list

Use this button	To do this
	To move a parameter up in the list
	To move a parameter down in the list
	To remove a parameter from the list
	To add a parameter to the list

Note that if you do not have Real-Time Workshop, Summary Properties (req RTW) will not be listed in this drop box, since summary properties require Real-Time Workshop. If you are using a setup file that contains a summary property, then the property name appears in the report, but the property value does not.

The %<SplitDialogParameters> and the dialogparameters Properties

The %<SplitDialogParameters> property creates columns with the dialog parameter names as headings (one column for each parameter), and the dialog parameter values listed in the table cells below it. This property is valid for blocks only and creates multiple tables, one for each block type.

The dialogparameters property creates one column with dialogparameters as a heading and lists the dialog parameter names in the table cells below it.

For example, if your reported properties are Name and dialogparameters, then you will get the following object summary table

Name	dialogparameters
Gain1	Gain
Gain2	Gain
Sum3	IconShape Inputs SaturateOnIntegerOverflow
T-Fcn1	Numerator Denominator

.

If you choose to report on the same blocks summarized in the table above but choose Name and %<SplitDialogParameters> as your reported properties, then you will get the following three object summary tables, one for each blocktype.

Name	Gain
Gain1	Mz
Gain2	5

Name	IconShape	Inputs	SaturdateOnIntegerOverflow
Sum3	round	|++	0

Name	Numerator	Denominator
Sum3	1	[1, -Mq]

Example

If you are reporting on the demo model F14, and you choose the following options, then summary table shown on the next page is generated:

Sort on systems by system depth

Name and Blocks are the System parameters to be included in the table

Name	Blocks
f14	u, Actuator Model, Aircraft Dynamics Model, Angle of Attack, Controller, Dryden Wind Gust Models, Gain, Gain1, Gain2, Gain5, More Info, More Info1, Nz pilot calculation, Pilot, Pilot G force Scope, Stick Input, Sum, Sum1, alpha (rad), Nz Pilot (g)
Aircraft Dynamics Model	Elevator Deflection d (deg), Vertical Gust wGust (ft/sec), Rotary Gust qGust (rad/sec), Gain3, Gain4, Gain5, Gain6, Sum1, Sum2, Transfer Fcn.1, Transfer Fcn.2, Vertical Velocity w (ft/sec), Pitch Rate q (rad/sec)
Controller	Stick Input (in), alpha (rad), q (rad/sec), Alpha-sensor Low-pass Filter, Gain, Gain2, Gain3, Pitch Rate Lead Filter, Proportional plus integral compensator, Stick Prefilter, Sum, Sum1, Sum2, Elevator Command (deg)
Dryden Wind Gust Models	Band-Limited White Noise, Q-gust model, W-gust model, Wg, Qg
More Info
More Info1
Nz pilot calculation	w, q, Constant, Derivative, Derivative1, Gain1, Gain2, Product, Sum1, Pilot g force (g)

Insert anything into report?

Yes. Table.

Filename

csl_summ_table

Object Property

Signal Loop