Embedded MATLAB Function Editor

Customizing the Embedded MATLAB Editor

Use the toolbar icons to customize the appearance of the Embedded MATLAB Editor in the same manner as the MATLAB editor. See Arranging the Desktop in the MATLAB documentation.

Back to Top

Embedded MATLAB Editor Tools

The following tools are specific to Embedded MATLAB:

See Defining Inputs and Outputs for an example of defining an input argument for an Embedded MATLAB Function block.

Back to Top

Editing and Debugging Embedded MATLAB Code

Commenting Out a Block of Code

To comment out a block of code in the Embedded MATLAB editor:

1. Highlight the text that you would like to comment out.

2. Hold the mouse over the highlighted text and then right-click and select Comment from the context menu. (Alternatively, select Comment from the Text menu).

Note   To uncomment a block of code, follow the same steps, but select Uncomment instead of Comment.

For more information, refer to Adding Comments in the MATLAB Desktop Tools and Development Environment documentation.

Manual Indenting

To indent a block of code manually:

1. Highlight the text that you would like to indent.

2. Hold the mouse over the highlighted text and then right-click and select one of the following options from the context menu:

   • Smart Indent to indent lines that start with keyword functions or that follow lines containing certain keyword functions. (Alternatively, select Smart Indent from the Text menu).

   • Decrease Indent to move selected lines further to the left. (Alternatively, select Decrease Indent from the Text menu).

   • Increase Indent to move selected lines further to the right. (Alternatively, select Increase Indent from the Text menu).

For more information, refer to Indenting in the MATLAB Desktop Tools and Development Environment documentation.

Opening a Selection

You can open a subfunction, function, file, or variable from within a file in the Embedded MATLAB Function Editor.

To open a selection:

1. Position the cursor in the name of the item you would like to open.

2. Right-click and select Open Selection from the context menu.

The Editor chooses the appropriate tool to open the selection. For more information, refer to in the MATLAB Desktop Tools and Development Environment documentation

Note   If you open an Embedded MATLAB Function block input or output parameter, the Ports and Data Manager opens with the selected parameter highlighted. You can use the Ports and Data Manager to modify parameter attributes. For more information, refer to Ports and Data Manager.

Evaluating a Selection

You can use the Evaluate a Selection menu option to report the value for an Embedded MATLAB function variable or equation in the MATLAB window during simulation.

To evaluate a selection:

1. Highlight the variable or equation that you would like to evaluate.

2. Hold the mouse over the highlighted text and then right-click and select Evaluate Selection from the context menu. (Alternatively, select Evaluate Selection from the Text menu).

   

When you reach a breakpoint, the MATLAB command Window displays the value of the variable or equation at the Command Line Debugger prompt.

debug>> stdev
 
	1.1180

debug>> 

Note   You cannot evaluate a selection while MATLAB is busy, for example, running an M-file.

Setting Data Scope

To set the data scope of an Embedded MATLAB Function block input parameter:

1. Highlight the input parameter that you would like to modify.

2. Hold the mouse over the highlighted text and then right-click and select Data Scope from the context menu.

3. Select:

   • Input if your input data is provided by the Simulink model via an input port to the Embedded MATLAB Function block.

   • Parameter if your input is a variable of the same name in the MATLAB or model workspace or in the workspace of a masked subsystem containing this block.

For more information, refer to Setting General Properties in the Ports and Data Manager documentation.

Back to Top

Ports and Data Manager

The Ports and Data Manager provides a convenient method for defining objects and modifying their properties in an Embedded MATLAB Function block that is open and has focus.

The Ports and Data Manager provides the same data definition capabilities as the Model Explorer, but supports only individual Embedded MATLAB Function blocks. To modify objects and properties for blocks across the model hierarchy, use the The Model Explorer.

Ports and Data Manager Dialog

The Ports and Data Manager dialog allows you to add and define data arguments, input triggers, and function call outputs for Embedded MATLAB Function blocks. Using this dialog, you can also modify properties for the Embedded MATLAB Function block and the objects it contains.

The dialog consists of two panes:

• The Contents pane lists the objects that have been defined for the Embedded MATLAB Function block.

• The Dialog pane displays fields for modifying the properties of the selected object.

Properties vary according to the scope and type of the object. Therefore, the Ports and Data Manager properties dialogs are dynamic, displaying only the property fields that are relevant for the object you add or modify.

When you first open the dialog, it displays the properties of the Embedded MATLAB Function block.

Opening the Ports and Data Manager

To open the Ports and Data Manger from the Embedded MATLAB Editor, select Tools > Edit Data/Ports or click the Edit Data/Ports icon .

The Ports and Data Manager appears for the Embedded MATLAB Function block that is open and has focus.

Ports and Data Manager Tools

The following tools are specific to the Ports and Data Manager:

Setting Embedded MATLAB Function Block Properties

The Dialog pane for an Embedded MATLAB Function block looks like this:

This section describes each property of an Embedded MATLAB Function block.

Name.   Name of the Embedded MATLAB Function block, following the same naming conventions as for Simulink blocks (see Manipulating Block Names).

Update method.   Method for activating the Embedded MATLAB Function block. You can choose from the following update methods:

Saturate on integer overflow.   Option that determines how the Embedded MATLAB Function block handles overflow conditions during integer operations:

Note   The Saturate on integer overflow option is relevant only for integer arithmetic. It has no effect on fixed-point or double-precision arithmetic.

When you enable Saturate on integer overflow, the Embedded MATLAB Function block adds additional checks in the generated code to detect integer overflow or underflow. Therefore, it is more efficient to disable this option if you are sure that integer overflow and underflow will not occur in your Embedded MATLAB function code.

Even when you disable this option, the code for a simulation target checks for integer overflow and underflow. If either condition occurs, simulation stops and an error is generated. If you enabled debugging for the Embedded MATLAB Function block, the debugger displays the error and lets you examine the data.

If you have not enabled debugging for the Embedded MATLAB Function block, the block generates a runtime error, as in this example:

It is important to note that the code for a Real-Time Workshop target does not check for integer overflow or underflow and, therefore, may produce unpredictable results when Saturate on integer overflow is disabled. In this situation, it is recommended that you simulate first to test for overflow and underflow before generating the Real-Time Workshop target.

Lock Editor.   Option for locking the Embedded MATLAB Editor. When enabled, this option prevents users from making changes to the Embedded MATLAB Function block.

Treat these inherited Simulink signal types as fi objects.   Parameter that applies to Embedded MATLAB Function blocks in models that use fixed-point or integer data types. You can control how the Embedded MATLAB Function block handles Simulink input signals using the Treat these inherited Simulink signal types as fi objects parameter.

Embedded MATLAB Function block fimath.   Setting that defines fimath properties for the Embedded MATLAB Function block. The block associates the fimath properties you specify with the following objects:

• All fixed-point and integer input signals to the Embedded MATLAB Function block that you choose to treat as fi objects.

• All fi and fimath objects constructed in the Embedded MATLAB Function block.

You can select one of the following options for the Embedded MATLAB Function block fimath.

Description.   Description of the Embedded MATLAB Function block.

Document link.   Link to documentation for the Embedded MATLAB Function block. To document an Embedded MATLAB Function block, set the Document link property to a Web URL address or MATLAB expression that displays documentation in a suitable format (for example, an HTML file or text in the MATLAB Command Window). The Embedded MATLAB Function block evaluates the expression when you click the blue Document link text.

Adding Data to an Embedded MATLAB Function Block

You can define input and output data arguments for an Embedded MATLAB Function block directly in the script, or by using the Ports and Data Manager or Model Explorer. You can use the Ports and Data Manager to add data arguments to an Embedded MATLAB Function block that is open and has focus. You can also modify the properties of data arguments in the block.

You can define data arguments for Embedded MATLAB Function blocks in the following methods:

Defining Data in the Ports and Data Manager.   To add a data argument and modify its properties, follow these steps:

1. In the Ports and Data Manager, click the Add Data icon .

   The Ports and Data Manager adds a default definition of the data to the Embedded MATLAB Function block and displays the new data argument.

   

2. Select the row containing the new data argument.

3. Select the data property you want to modify, and specify a new value, as in this example:

   

4. Repeat step 3 to specify values for other data properties.

5. Return to the Embedded MATLAB Function block properties at any time by clicking the Show Block Dialog icon .

Defining Data in the Model Explorer.   The Data properties dialog in the Model Explorer allows you to set and modify the properties of data arguments in Embedded MATLAB Function blocks. Properties vary according to the scope and type of the data object. Therefore, the Data properties dialog is dynamic, displaying only the property fields that are relevant for the data argument you are defining.

Open the Data properties dialog by selecting a data argument in the Contents pane.

The Data properties dialog provides a set of tabbed panes, as in this example:

Each tab lets you define different features of your data argument:

• The General tab lets you define the scope, size, complexity, and type of the data argument. See Setting General Properties.

• The Value Attributes tab lets you set a limit range and save data argument values. See Setting Value Attributes Properties.

• The Description tab lets you enter a description and link to documentation about the data argument. See Setting Description Properties.

Setting General Properties.   The General tab of the Data properties dialog looks like this:

Note   If you cannot see the Data Type Assistant, click the Show data type assistant button .

You can set the following properties in the General tab:

Setting Value Attributes Properties.   The Value Attributes tab of the Data properties dialog looks like this:

You can set the following properties on the Value Attributes tab:

Setting Description Properties.   The Description tab of the Data properties dialog looks like this:

You can set the following properties on the Description tab:

Adding Input Triggers to an Embedded MATLAB Function Block

You can use the Ports and Data Manager to add input triggers to an Embedded MATLAB Function block that is open and has focus. You can also modify the properties of input triggers in the block.

To add an input trigger and modify its properties, follow these steps:

1. In the Ports and Data Manager, click the Add Input Trigger icon .

   The Ports and Data Manager adds a default definition of the new input trigger to the Embedded MATLAB Function block and displays the Trigger properties dialog.

   

2. Modify properties for the new input trigger, using one of the following methods:

   • In the Contents pane, select the row that contains the input trigger you want to modify and then edit the property of interest, as in this example:

     

   • Modify fields in the Trigger properties dialog, as described in The Trigger Properties Dialog.

   • Return to the Embedded MATLAB Function block properties at any time by clicking the Show Block Dialog icon .

The Trigger Properties Dialog.   The Trigger properties dialog in the Ports and Data Manager allows you to set and modify the properties of input triggers in Embedded MATLAB Function blocks.

You can open the Trigger properties dialog using one of these methods:

• Select an input trigger in the Contents pane of the Ports and Data Manager to open the Trigger properties dialog in the Dialog pane.

• Right-click an input trigger in the Contents pane and select Properties from the submenu to open the Trigger properties dialog outside the Ports and Data Manager.

The Trigger properties dialog looks like this:

Setting Input Trigger Properties.   You can set the following properties in the Trigger properties dialog:

Adding Function Call Outputs to an Embedded MATLAB Function Block

You can use the Ports and Data Manager to add and modify function call outputs to an Embedded MATLAB Function block that is open and has focus. You can also modify the properties of function call outputs in the block.

To add a function call output and modify its properties, follow these steps:

1. In the Ports and Data Manager, click the Add Function Call Output icon .

   The Ports and Data Manager adds a default definition of the new function call output to the Embedded MATLAB Function block and displays the Function Call properties dialog.

   

2. Modify properties for the new function call output, using one of the following methods:

   • In the Contents pane, select the row that contains the function call output you want to modify and then edit the property of interest, as in this example:

     

   • Modify fields in the Function Call properties dialog, as described in The Function Call Properties Dialog.

   • Return to the Embedded MATLAB Function block properties at any time by clicking the Show Block Dialog icon .

The Function Call Properties Dialog.   The Function Call properties dialog in the Ports and Data Manager allows you to edit the properties of function call outputs in Embedded MATLAB Function blocks.

You can open the Function Call properties dialog in the Dialog pane by selecting a function call output in the Contents pane of the Ports and Data Manager.

The Function Call properties dialog looks like this:

Setting Function Call Output Properties.   You can set the following properties in the Function Call properties dialog:

Back to Top

Debugging an Embedded MATLAB Function Block

Working with Compilation Reports

Related Products & Applications

• Simulink
• Control Design
• Signal Processing & Communications
• Model-Based Design
• Physical Modeling
• Verification & Validation

Get Simulink trial software

Learn more about Simulink through this collection of videos, articles, technical literature and the Getting Started with Simulink Guide.

Get this Simulink Kit