MATLAB Report Generator

Model Loop

Model Loop

Category

Simulink

Description

The Model Loop component runs its subcomponents for all selected Simulink models and systems. The Model Loop component can run its subcomponents for a specific model, such as the demo model F14, or it can run its subcomponents for all models or the current model.

Because Simulink components are context-sensitive, they should be parented by the Model Loop (although the Model Loop does not have to be the immediate parent of some Simulink components).

Attributes

This is the Model Loop 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.

Choosing Models to Report On

You can report on:

• The current model
• All models that are currently open
• A custom set of models and systems

The Model to Report column shows you what models are reported.

To find out what the current model is, type bdroot in the MATLAB command window.

Reporting on All Models

If you want to report on all models that are currently open, click on the All button.

Reporting on Custom Models

If you want to report on a custom set of models and systems, click on the Custom button.

The Model to Report column, which contains a list of reported models, is initially empty. Type the name of the model in this column. Press the Esc key when you are finished.

To add another model to the list, click on the New button; an empty row will appear.

The following table shows you which button you should use to move a model up or down in the list, or to add or delete a model.

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

Choosing Systems to Report On

For each of the model reporting options (Current, All and Custom), you can select the systems that will be included in the report for each model. You can select the systems that are reported from the Systems to Report column.

Use this button	To do this
	To report on all systems in the current model
	To report on the current system in a model and all of its subsystems
	To report on the current system only
	To report on the current system and all the systems above it

You can also select the reported system through the context menu. To invoke the content menu, click on the right mouse button. The options shown in the table above are available through Set loop type in the context menu.

Specifying the Current System for the Reported Model

You can specify the current system in the reported model for the following reported systems:

• Current system only
• Current system and all the systems above it
• Current system in a model and all of its subsystems

How to specify the current system for:

• The current model: You can choose to report on the Top System or the Current System when you are reporting on the current model. Click on Top System or Current System in the Systems to Report column to toggle between the two systems. You can also choose between the two options by using the context menu.
• All models: The current system for the All Models option is always the top system.
• A custom model: You can choose to report on the top system or any other system when you are reporting on a custom model. You can also choose multiple systems.
• Choosing a system: To select the current system for a custom model, click in the Systems to Report column. The Select "Current" Systems window appears (shown in the example below). You can also invoke this window by using the context menu and choosing Select current system(s).

• Select the system you want to include and click on OK. The system you select is now displayed in the Systems to Report column.

  For example, choose the custom model option and click in the Model to Report column. Type f14 in the Model to Report column. Choose to report on the current system and all the systems above it by clicking on the button shown below.

  

  Click in the Systems to Report column. The Select "Current" Systems window, shown below, lists all of the systems in the f14 model.

  

  Select f14/Controller and then click on Ok. The Systems to Report column now has the following entry: (f14/Controller). F14 and F14/Controller are included in the report.

• Choosing multiple systems: To select multiple systems, hold down the Shift key and select the systems you want to report on. Click on Ok when you are done. The Systems to Report column now has the following entry: (Multiple).

• If you choose to report on multiple systems, and you are reporting on the current system, then the systems you have selected are included in the report.

  If you choose to report on multiple systems, and you are reporting on the current system and all the systems above it, then all the systems you have selected and all the systems above them are included in the report.

  If you choose to report on multiple systems, and you are reporting on the current system and all of its subsystems, then all the systems you have selected and all their subsystems are included in the report. The subsystems that are included in the report depend on the options you choose for following library links and for looking under masks. These two options are discussed in the next two sections.

Following Library Links

Simulink blocks and systems can be linked to a library. See the Simulink documentation for more information about library links.

Invoke the context menu to toggle the Follow library links option on and off.

The following table shows the options for reporting on blocks or systems with library links. Select the option by clicking on the option letter until it changes to the letter of your choice. These options are available if you are reporting on one of the following:

• All systems in a model
• The current system in a model and all of its subsystems

The options shown in the table below are also available through Follow library links in the context menu.

Select this option	To report on these systems
Y	Systems with library links
N	Systems without library links
U	Systems with unique library links (if you have more than one system with the same library link, only one of them is included in the report)

Looking Under Masks

Simulink systems can have masks. The masks can be functional or graphical. See the Simulink documentation for more information about masks.

The following table shows the options for reporting on masked systems. Select the option by clicking on the option letter until it changes to the letter of your choice. These options are available if you are reporting on one of the following:

• All systems in a model
• The current system in a model and all of its subsystems

The options shown in the table below are also available through Look under masks in the context menu

Select this option	To report on these systems
N	Systems with no masks
G	Systems with graphical masks Systems with no masks
F	Systems with functional masks Systems with graphical masks Systems with no masks
A	All systems

.

Note    If you choose Y to report on systems with library links and N to report on systems with no masks, then the report will not include most library blocks, since most library blocks tend to be masked.

Insert anything into report?

No.

Filename

csl_mdl_loop

Model Functions

Model Property Table