MATLAB Report Generator

For Loop

For Loop

Category

Logical and Flow

Description

The For Loop component iteratively executes its subcomponents and must have at least one subcomponent to execute properly. This component functions like the for loop in MATLAB, except that instead of executing a statement, it executes its subcomponents while one of the following loops is active

• for varname=x:y:z
  for varname=[a b c ...]
  

where varname must be a string that is valid as a variable name. x, y, z can be scalar numbers or workspace expressions that are evaluated in the workspace as scalar numbers. If any one of these is a string that cannot be evaluated as a scalar number, then the For Loop will not execute.

For example, if red is a workspace variable, the following is a valid for statement.

• for i=1:1:length(red)
  

length(red) is 3, which is a scalar number.

Attributes

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

Loop Type

In this section you can choose the loop type incremented indices or a vector of indices. See the MATLAB documentation for more details on the for loop and indices.

Incremented indices

• Choose this option to execute a for loop of the following form.
  for varname=x:y:z
  Enter the appropriate values in the following fields:
  
  Start: corresponds to x in the for loop shown above
  
  Increment: corresponds to y in the for loop shown above
  
  End: corresponds to z in the for loop shown above
  

Vector of Indices

• Choose this option to execute a for loop of the following form.
  for varname=[a b c ...]
  Enter the appropriate values in the Vector field in the form a b c ...
  

Workspace Variable

Show index value in base workspace

Use this option to place the loop index (the value of the for loop variable) in the workspace while other components are executing.

Variable name

Enter the variable name in this field. The variable name is varname in the for loop forms described above.

Remove variable from workspace when done

Use this option to remove the loop index from the workspace. This option is only available if you selected the Show index value in base workspace option.

Preview

This section shows a schematic representation of how this component will execute when the report is generated.

Insert anything into report?

No.

Filename

clofor

<if> Elseif

Logical If