DataTypeWorkflow.ProposalSettings class

Package: DataTypeWorkflow

Proposal settings object for data type proposals

Description

The DataTypeWorkflow.ProposalSettings class manages the properties related to how data types are proposed for a model.

Construction

propSettings = DataTypeWorkflow.ProposalSettings creates a proposal settings object. A proposal settings object manages properties related to how data types are proposed for a model, including default floating point data type, and safety margins for the proposed data types.

Properties

DefaultWordLength — Default word length for floating point signals

16 | scalar

Default word length for floating-point signals, specified as a double. Use this setting when the ProposeFractionLength property is set to true.

Data Types: double

DefaultFractionLength — Default fraction length for floating-point signals

4 | scalar

Default fraction length for floating-point signals, specified as a double. Use this setting when the ProposeWordLength property is set to true.

Data Types: double

ProposeFractionLength — Propose fraction lengths for specified word length

true (default) | false

Set to true to propose fraction lengths for the default word length specified in the DefaultWordLength property. Setting this property to true automatically sets the ProposeWordLength property to false.

Data Types: logical

ProposeForInherited — Propose fixed-point data types for objects with an inherited output data type

true (default) | false

Specify whether to propose fixed-point data types for objects in the system with inherited output data types.

Data Types: logical

ProposeForFloatingPoint — Propose fixed-point data types for objects with a floating-point output data type

true (default) | false

Specify whether to propose fixed-point data types for objects in the system with floating-point output data types.

Data Types: logical

ProposeSignedness — Propose signedness for objects in the system

true (default) | false

Specify whether to propose signedness for objects in the system.

The software bases the signedness proposal on collected range information and block constraints. Signals that are always strictly positive get an unsigned data type proposal, gaining an additional bit of precision. If you set this property to false, the software proposes a signed data type for all results that currently specify a floating-point or an inherited output data type unless other constraints are present. If a result specifies a fixed-point output data type, the software will propose a data type with the same signedness as the currently specified data type unless other constraints are present.

Data Types: logical

ProposeWordLength — Propose word lengths for specified default fraction lengths

false (default) | true

Set to true to propose word lengths for the default fraction length specified in the DefaultFractionLength property. Setting this property to true automatically sets the ProposeFractionLength property to false.

Data Types: logical

SafetyMargin — Safety margin for simulation minimum and maximum values

0 (default) | scalar

The simulation minimum and maximum values are adjusted by the percentage designated by this parameter. This allows you to specify a range different from that obtained from the simulation run.

Example: A value of 55 specifies that a range at least 55 percent larger is desired. A value of –15 specifies that a range of up to 15 percent smaller is acceptable.

Data Types: double

UseDerivedMinMax — Whether to use derived ranges to propose data types

true (default) | false

Specify whether to use derived ranges for data type proposals.

Data Types: logical

UseSimMinMax — Whether to use simulation ranges to propose data types

true (default) | false

Specify whether to use simulation ranges for data type proposals.

Data Types: logical

Copy Semantics

Value. To learn how value classes affect copy operations, see Copying Objects (MATLAB).

Alternatives

The properties of the DataTypeWorkflow.ProposalSettings class can also be controlled from the Automatic data typing for selected system pane in the Fixed-Point Tool. See fxptdlg for more information.