Documentation

Run Management

By default, the Fixed-Point Tool creates a run for range collection and a run for verification. These runs are named Ranges (Double) and Embedded respectively.

The tool creates a range collection run when you click the Collect Ranges button; It creates a verification run when you click the Simulate Using Embedded Types button. The Fixed-Point Tool automatically configures the settings for the runs and overwrites previous runs unless you specify a new run name and configure the settings manually. The default behavior of the range collection run is to override your model with double-precision types to avoid quantization affects and collect idealized ranges either through simulation or range analysis. The verification run simulates your model using the currently specified data types.

The Fixed-Point Tool also provides additional configurations for the range collection and verification runs. You can edit which settings the tool uses by clicking the Collect Ranges arrow button and selecting a configuration. You can edit the default names for the run by typing a new name in the Run name field. The tool overwrites previous runs unless they specify a unique name.

Using the Fixed-Point Tool you can also:

  • Store multiple runs.

  • Specify custom run names.

  • Propose data types based on the results in any run.

  • Apply data type proposals based on any run.

  • Compare the results of any two runs.

  • Rename runs directly in the Fixed-Point Tool spreadsheet.

You can easily switch between different run setups using the factory default configuration settings. Alternatively, you can manually manage runs. For more information, see Manual Run Management.

Each run with a unique run name is displayed in the Run Browser in the lower left corner of the tool. For information about how to filter runs from the spreadsheet, see Control Views in the Fixed-Point Tool.

Manual Run Management

You can manually manage runs. To edit the default run settings, click the Collect Ranges or the Simulate with Embedded Types arrow button. Select from the list of configurations, or click Edit shortcuts to open the Advanced Settings dialog box.

  • Enter a unique Run name in the field.

    If you do not specify a unique run name, the tool overwrites runs with the same name. Provide a new run name if you do not want to lose existing runs.

  • In the Advanced Settings dialog box, under Configure model settings, edit the following settings:

    • Fixed-point instrumentation mode

      To log ranges, this setting must be set to Minimums, maximums and overflows.

    • Data type override

    • Data type override applies to

Use Shortcuts to Manage Runs

You can use shortcuts prior to simulation to configure the run name as well as to configure model-wide data type override and instrumentation settings. The Fixed-Point Tool provides:

  • Frequently used factory default configurations, such as Range collection using double override, which sets up your model so that you can override all data types with double-precision numbers and logs the simulation minimum and maximum values and overflows.

    Note

    You can set up user-defined shortcuts across referenced model boundaries. The factory default shortcuts apply only to the top-level model and so do not affect the settings of any referenced model.

  • The ability to add and edit custom shortcuts. The shortcuts are saved with the model so that you define them once and then reuse them multiple times. Use the Shortcut Editor in the Advanced Settings dialog box to create or edit shortcuts.

    Note

    You can use user-defined shortcuts across referenced model boundaries.

Why Use Shortcuts to Manage Runs

Shortcuts provide a quick and easy way to set up data type override and fixed-point instrumentation settings that are not part of the default configurations prior to simulation or range derivation. You can associate a run name with each shortcut. When you apply a shortcut, you change the data type override and fixed-point instrumentation settings of multiple systems in your hierarchy simultaneously.

Shortcuts:

  • Enable you to configure data type override and instrumentation settings on multiple subsystems in the model hierarchy at the same time. This capability is useful for models that have a complicated hierarchy.

  • Are a convenient way to store frequently used settings and reuse them. This capability is useful when switching between different settings during debugging.

  • Provide a way to store the original fixed-point instrumentation and data type override settings for the model. Preserving these settings in a shortcut provides a backup in case of failure and a baseline for testing and validation.

When to Use Shortcuts to Manage Runs

To ...Use...

Autoscale your entire model

The factory default model configuration. The defaults provide an efficient way to override the model with floating-point data types and collect ranges. For more information, see Propose Fraction Lengths Using Simulation Range Data.

Debug a model

Configurations to switch between different data type override and fixed-point instrumentation modes. For more information, see Debug a Fixed-Point Model.

Manage the settings on multiple systems in a model. For example, if you are converting your model to fixed point one subsystem at a time.

The Advanced Settings Shortcuts tab to define your own shortcuts so that you can switch between different settings without manually changing individual settings each time.

Capture the initial settings of the model before making any changes to it.

The Advanced Settings Shortcuts tab to capture the model settings and save them in a named run. For more information, see Capture Model Settings Using the Shortcut Editor.

Add Shortcuts

  1. In the Fixed-Point Tool, click the Collect Ranges or Simulate with Embedded Types arrow button, select Edit shortcuts to open the Advanced Settings dialog box.

  2. For each subsystem that you want to specify a shortcut for, on the Shortcuts tab, in the Model Hierarchy pane, select the subsystem:

    1. In the Name of shortcut field, enter the shortcut name.

      By default, if Allow modification of run name is selected, the software sets the Run name to the shortcut name. You can manually override the name.

    2. Edit the shortcut properties.

Edit Shortcuts

  1. In the Fixed-Point Tool, click the Collect Ranges or Simulate with Embedded Types arrow button, select Edit shortcuts to open the Advanced Settings dialog box.

  2. In the Shortcuts tab, from the Name of shortcut list, select the shortcut that you want to edit.

    The editor displays the run name, fixed-point instrumentation settings, and data type override settings defined by the shortcut.

    Note

    You cannot modify the factory default configurations.

  3. If you do not want this shortcut to modify the existing fixed-point instrumentation settings on the model, clear Allow modification of fixed-point instrumentation settings.

  4. If you do not want this shortcut to modify the existing data type override settings on the model, clear Allow modification of data type override settings.

  5. If you do not want this shortcut to modify the run name on the model, clear Allow modification of run name.

  6. If you want to modify the shortcut for a subsystem:

    1. Select the subsystem.

    2. If applicable, set the Fixed-point instrumentation mode to use when you apply this shortcut.

    3. If applicable, set the Data type override mode to use when you apply this shortcut.

    4. If applicable, set the Run name to use when you apply this shortcut.

    5. Click Apply.

  7. Repeat step 6 to modify any subsystem shortcuts that you want.

  8. Optionally, if you want the Fixed-Point Tool to display a button for this new shortcut, under Manage shortcuts, use the right arrow to move the shortcut to the list of shortcuts to display. Use the up and down arrows to change the order of the shortcut buttons.

  9. Save the model to store the shortcut with the model.

Delete Shortcuts

To delete a shortcut from a model:

  1. In the Fixed-Point Tool, click the Collect Ranges or Simulate with Embedded Typesarrow button, select Edit shortcuts to open the Advanced Settings dialog box.

  2. On the Shortcuts tab, under Manage shortcuts, in the Shortcuts table, select the shortcut that you want to delete.

  3. Click the Delete selected shortcut button, .

Note

You can only delete shortcuts that you created. You cannot delete any of the default shortcuts.

Capture Model Settings Using the Shortcut Editor

  1. In the Fixed-Point Tool, click the Collect Ranges or Simulate with Embedded Typesarrow button, select Edit shortcuts to open the Advanced Settings dialog box.

  2. In the Shortcuts tab, create a new shortcut, for example, Initial subsystem settings.

    By default, if Allow modification of run name is selected, the software sets the Run name to the shortcut name. You can manually override the name.

  3. Verify that Allow modification of fixed-point instrumentation settings and Allow modification of data type override settings are selected.

  4. Click Capture system settings.

    The software sets the Fixed-point instrumentation mode, Data type override, and, if appropriate, Data type override applies to for the systems in the model hierarchy.

  5. Click Apply.

  6. Save the model to store the shortcut with the model.

Was this topic helpful?