matlab.metadata.FixedDimension Class

Namespace: matlab.metadata
Superclasses: matlab.metadata.ArrayDimension

Fixed dimension in property size specification

Renamed from meta.FixedDimension in R2024a

Description

The matlab.metadata.Validation class Size property uses matlab.metadata.FixedDimension objects to represent the fixed values in a property size specification. The Length property contains the numeric value of the dimension.

Class Attributes

Sealed

true

For information on class attributes, see Class Attributes.

Properties

Length — Fixed dimension

1 (default) | positive integer

Fixed dimension, returned as a scalar uint64.

Attributes:

GetAccess	public
SetAccess	private

Examples

The ValidationExample class specifies the size of the property value as (2,:).

classdef ValidationExample
   properties
      Prop (2,:) double {mustBeReal,mustBeGreaterThan(Prop,10)} = 200;
   end
end

Programmatically determine if the property validation used for Prop has a fixed dimension and to what value that dimension is restricted.

mc = ?ValidationExample;
mp = findobj(mc.PropertyList,'Name','Prop');
sz = mp.Validation.Size;
len = length(sz);
for k = 1:len
  if isa(sz(k),'matlab.metadata.FixedDimension') 
    disp("Dimension " + k + " has a fixed value of " + sz(k).Length + ".")
  end
end

Dimension 1 has a fixed value of 2.

Version History

Introduced in R2018a

R2024a: Renamed from meta.FixedDimension

The namespace of FixedDimension has been changed from meta to matlab.metadata. The behavior remains the same.

MATLAB^® will continue to recognize the old metaclass names in most contexts. However, code that relies on string comparisons to identify metaclasses might need to be updated to continue to work as expected. For example, if mObj in the example below is a matlab.metadata.FixedDimension instance, the code under the case statement for 'meta.FixedDimension' does not execute because class(mObj) returns 'matlab.metadata.FixedDimension'.

switch class(mObj)
   case 'meta.FixedDimension'
       % code to execute if mObj is a meta.FixedDimension instance
   ...
end

To ensure this code continues to work as intended, use an if statement with isa. The isa command recognizes both the old and new names of the class.

if isa(mObj,'meta.FixedDimension') 
       % code to execute if mObj is a 
       % matlab.metadata.FixedDimension instance
   else
       ...
   end

If compatibility with older releases of MATLAB is not a concern, you can update 'meta.FixedDimension' to 'matlab.metadata.FixedDimension'. However, continue to use the old name if your code needs to run on versions of MATLAB before R2024a.