Documentation

DataTypeWorkflow.Converter class

Package: DataTypeWorkflow

Create fixed-point converter object

Description

A DataTypeWorkflow.Converter object contains the methods and parameters needed to collect simulation and derived data, propose and apply data types to the model, and analyze results. This class performs the same fixed-point conversion tasks as the Fixed-Point Tool.

Construction

Converter = DataTypeWorkflow.Converter(systemToScale) creates a converter object for the systemToScale. The converter object contains the methods and parameters needed to collect simulation and derived data, propose and apply data types to the model, and analyze results.

Converter = DataTypeWorkflow.Converter(referencedModelSystem, 'TopModel', topModel)creates a converter object with referenced model referencedModel specified as the system to scale. The top model topModel is used during the range collection phase of conversion.

Input Arguments

expand all

The name of the model or subsystem to scale, specified as a character vector.

Example: converter = DataTypeWorkflow.Converter('ex_fixed_point_workflow');

The name of the referenced model or the subsystem within a referenced model to convert to fixed point, specified as a character vector.

The name of the top-level model which references referencedModel, specified as a character vector. topModel is used during the range collection phase of conversion.

Properties

expand all

Name of the current run stored in the converter object, specified as a character vector.

Example: converter.CurrentRunName = 'FixedPointRun'

Data Types: char

Names of runs stored in the converter object, specified as a cell array of character vectors.

Data Types: cell

Name of the model or subsystem to scale, specified as a character vector.

Data Types: char

Names of the system settings shortcuts available for the selected system, specified as a cell array of character vectors. You can create additional configurations from within the Fixed-Point Tool. For more information, see Use Shortcuts to Manage Runs.

Data Types: cell

Methods

applyDataTypesApply proposed data types to model
applySettingsFromRunApply system settings used in previous run to model
applySettingsFromShortcutApply settings from shortcut to model
compareResultsCompare two DataTypeWorkflow.Result objects
compareRunsCompare two runs of converter’s selected system
deriveMinMaxDerive range information for model
proposalIssuesGet results which have comments associated with them
proposeDataTypesPropose data types for system
resultsFind results for selected system in converter object
saturationOverflowsGet results where saturation occurred
simulateSystemSimulate converter’s system
wrapOverflowsGet results where wrapping occurred

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects (MATLAB).

Alternatives

The DataTypeWorkflow.Converter class offers a command-line approach to using the Fixed-Point Tool. See fxptdlg for more information.

Was this topic helpful?