value

R2026b

Return array of numeric values converted into specified unit

Syntax

A = value(V,unit)

A = value(V,unit,conversiontype)

A = value(V)

Description

A = value(V,unit) returns an array of numeric values of the simscape.Value object, V, converted into the specified unit, unit, by applying the appropriate scaling factor. unit must be commensurate with the unit of V.

A = value(V,unit,conversiontype) lets you select whether to apply affine or linear conversion to thermal units. Affine conversion is the default.

A = value(V) strips the associated unit and returns the array of numeric values contained in simscape.Value object, V. This syntax is equivalent to A = value(V,unit(V)).

Use this function when working with simscape.Value objects. You cannot use it in the equations section of a Simscape™ file. For information on how to convert a variable or parameter into a scalar value in Simscape language, see value.

Examples

Extract Array of Numeric Values of simscape.Value Object in Different Units

Create a simscape.Value object in meters:

V = simscape.Value([1 10 5], 'm')

V = 

     1    10     5

    (m)

Get the object value in the unit of the object, that is, in meters:

 value(V)

ans =

    1    10     5

Get the object value in centimeters:

 value(V, 'cm')

ans =

         100        1000         500

Get the object value in inches:

 value(V, 'in')

ans =
   39.3701  393.7008  196.8504

Perform Affine or Linear Conversion

Thermal units often require an affine conversion, that is, a conversion that performs both multiplication and addition. For more information, see About Affine Units. When you extract values from a simscape.Value object that has affine units, you can specify the desired conversion type.

Create a simscape.Value object in degrees Celsius:

T = simscape.Value(10, 'degC')

T = 

    10 (degC)

Get the object value in Kelvin by performing affine conversion:

 value(T, 'K', 'affine')

ans =

    283.1500

Tip

Affine conversion is the default, therefore value(T, 'K') also returns 283.1500.

Get the object value in Kelvin by performing linear conversion:

 value(T, 'K', 'linear')

ans =

    10

Input Arguments

V — Array of numeric values with unit

simscape.Value object

Array of numeric values with unit, specified as a simscape.Value object.

Example: 10 (m/s^2)

unit — Physical unit expression

character vector | nonmissing string scalar | scalar simscape.Unit object

Physical unit expression, specified as a character vector, nonmissing string scalar, or a scalar simscape.Unit object. The string or character vector expression can consist of valid physical unit names, numbers, math operators, such as +, -, *, /, and ^, and parentheses to specify the order of operations. unit must be commensurate with the unit of V.

Example: 'mm/s^2'

conversiontype — Conversion type for thermal units

'affine' (default) | 'linear'

Thermal units often require an affine conversion, that is, a conversion that performs both multiplication and addition. For more information, see About Affine Units. When you extract values from a simscape.Value object that has affine units, you can specify the type of conversion:

• 'affine' — Perform unit conversion that uses both multiplication and addition.

• 'linear' — Perform unit conversion by applying just the linear term.

Data Types: char | string

Output Arguments

A — Array of numeric values

scalar | vector | matrix

Array of numeric values extracted from the simscape.Value object by applying the specified unit conversion factor and returned as a scalar, vector, or matrix.

Data Types: double

Version History

Introduced in R2021b

R2024a: Compact display of simscape.Value and simscape.Unit objects

When you place simscape.Value and simscape.Unit objects in table, cell, and structure arrays, the Command Window displays their values and units explicitly if they fit into the available width of the Command Window. For row vectors greater than maximum width, empty vectors, and for single line display of matrices and row vectors, you can still see only the object member dimensions and type.

In previous releases, the value and unit in a simscape.Value object were separated by a colon. Now, the unit is shown in parentheses after the value.