Insert Variable (Report Generator)

Component

Insert Variable

Category

MATLAB

Description

The Insert Variable component takes one of the following variables and inserts its value (and name, if you choose to do so) into the report:

A variable from the MATLAB workspace
A variable from a MAT-file
A global variable

Attributes

This is the Insert Variable 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 Chapter 4 for a discussion on how to add a component to the outline.

Variable to Include

Variable location

Select one of the following options:

Workspace - this options gets a variable from the MATLAB workspace.
MAT-file - this option gets a variable from a binary file with a .MAT extension.
Global variable - this option gets a global variable.

Variable name

Enter the name of the variable in this field.

You can use %<VariableName> to insert the value of a variable from the MATLAB workspace. For example, if you enter the following expression in this field:

    %<my_variable>

And you have the following in your MATLAB workspace:

    my_variable='velocity'
    velocity=50

Then your report will contain the following:

If you enter %<velocity> in this field, and your MATLAB workspace contains the same information, then your report will also contain 50.

Render Options

Name display

Select one of the options listed below to display the variable in the report:

Value - displays the value of the variable only (e.g., if the variable is velocity, and its value is 25, only 25 is displayed).
Name: Value - displays the variable name, followed by the value of the variable (e.g., Velocity: 25)
NAME Value - displays the variable name in italics, followed by the value of the variable (e.g., Velocity 25)

You can choose how the variable appears in the report in the first drop box in this section:

Choose Render variable as single-line text only to display the variable as text. If you select this option, this component will act like the Text component, and should have the Paragraph component as its parent.
Choose Render 1xN structures and non-character arrays as tables to display the variables that are in one of these forms as tables.

You can choose how a variable array appears in the report in the second drop box in this section:

Choose Show entire array to display the entire array in the report.
Choose Show large arrays as "[MxN CLASS]" to display large variable arrays as "[MxN CLASS]". For example, if you have a 300-by-200 double array, it will display in the report as [300x200 DOUBLE].

Insert anything into report?

Yes. Text.

Filename

cmlvariable

[ Previous | Help Desk | Next ]