MATLAB 検証関数

MATLAB^® はプロパティ検証で使用する関数を定義します。これらの関数は、検証のための一般的な使用パターンをサポートし、説明的なエラー メッセージを提供します。以下の表で、MATLAB 検証関数を分類し、その使用方法を説明しています。

関数を使用したプロパティの検証

クラス定義でプロパティの検証関数を使用して、プロパティ値に特定の制限を課します。関数によって課される特定の要件をプロパティ値が満たさない場合、検証関数は潜在的なプロパティ値を引数として受け入れ、エラーを発行します。

検証プロセス中、MATLAB はクラス定義にリストされている各検証関数に値を渡します。MATLAB は各関数を左から右の順序で呼び出し、最初に見つかったエラーをスローします。検証関数に渡される値は、クラスとサイズの指定によって適用された変換の結果です。クラスとサイズの検証の詳細については、プロパティのクラスとサイズの検証を参照してください。

MATLAB 検証関数の一覧については、MATLAB 検証関数を参照してください。

classdef MyClass
   properties
      Prop {fcn1,fcn2} = defaultValue
   end
end

properties
   Prop {mustBeGreaterThan(Prop,10)}
end

classdef ValidatorFunction
   properties
      Data {mustBeNumeric, mustBeFinite}
      Interp {mustBeMember(Interp,{'linear','cubic','spline'})} = 'linear'
   end
end

a = ValidatorFunction

a = 

  ValidatorFunction with properties:

      Data: []
    Interp: 'linear'

a.Data = 'cubic'

Error setting property 'Data' of class 'ValidatorFunction':
Value must be numeric.

properties
   Data double {mustBeNumeric, mustBeFinite}
end

a.Data = 'cubic'

a = 

  ValidatorFunction with properties:

      Data: [99 117 98 105 99]
    Interp: 'linear'

a = ValidatorFunction;
a.Interp = 'cu'

Error setting property 'Interp' of class 'ValidatorFunction':
Value must be a member of this set
    linear
    cubic
    spline

classdef InterpMethod
   enumeration
      linear
      cubic
      spline
   end
end

classdef ValidatorFunction
   properties
      Data {mustBeNumeric, mustBeFinite}
      Interp InterpMethod
   end
end

a = ValidatorFunction;
a.Interp = 'cu'

a = 

  ValidatorFunction with properties:

      Data: []
    Interp: cubic

検証関数の定義

検証関数は、プロパティ値と関数の引数値を検証するという特定の目的のために設計された通常の MATLAB 関数です。プロパティの検証に使用される関数は、次を行います。

MATLAB 検証関数を使用して実行できない特定の検証を行う場合、独自の検証関数を作成すると便利です。ローカル関数をクラス ファイル内に作成したり、任意のクラスで使用できるように関数を MATLAB パス上に配置することができます。

たとえば、ImgData クラスはローカル関数を使用して、サブクラスを除く Data プロパティを uint8 または uint16 の値のみに制限し、他の数値クラスからの変換を許可しない検証関数を定義します。事前定義された検証関数 mustBeInRange は、使用可能な値の範囲を制限します。

classdef ImgData
    properties
        Data {mustBeImData(Data),mustBeInRange(Data,0,255)} = uint8(0)
    end
end
function mustBeImData(a)
    if ~(isa(a,'uint8') || isa(a,'uint16'))
        error("Value of Data property must be uint8 or uint16 data.")
    end
end

ImgData クラスのインスタンスを作成するときに、MATLAB は既定値が 0...255 の範囲にあり、空でない uint8 または uint16 の値であることを検証します。この既定値は、プロパティに代入する他の値と同様に、検証の要件を満たさなければならない点に注意してください。

a = ImgData

a = 

  ImgData with properties:

    Data: 0

プロパティへの代入を行うと、検証関数が左から右の順序で呼び出されます。char ベクトルを Data プロパティに代入すると、mustBeImData によってエラーがスローされます。

a.Data = 'red';

Error setting property 'Data' of class 'ImgData'.
Value of Data property must be uint8 or uint16 data.

範囲外の数値を代入すると、mustBeInRange によってエラーがスローされます。

a.Data = uint16(312);

Error setting property 'Data' of class 'ImgData'. Value must be greater
than or equal to 0, and less than or equal to 255.

関連する関数については、mustBeInteger、mustBeNumeric および mustBePositive を参照してください。