matlab.lang.OnOffSwitchState クラス

パッケージ: matlab.lang

logical 値でオンおよびオフ状態を表す

説明

matlab.lang.OnOffSwitchState は logical クラスから派生する列挙型クラスです。このクラスを使用して、'on' と 'off' の各値および論理値 true、false、1 または 0 を受け入れるプロパティのデータ型を指定します。

このクラスを使用して、プロパティ値を次のいずれかの値に制約します。

クラス	logical true	logical false
文字ベクトル	`'on'`	`'off'`
string スカラー	`"on"`	`"off"`
論理値	`true`	`false`
論理値および数値	`1`	`0`
列挙型メンバー	`matlab.lang.OnOffSwitchState.on`	`matlab.lang.OnOffSwitchState.off`

OnOffSwitchState は logical クラスから派生するため、これらの列挙型メンバーは論理式で使用できます。

列挙型メンバー

`off`	logical false
`on`	logical true

例

すべて折りたたむ

プロパティ値を論理値または on/off にできるようにする

電力とモニターのオンとオフを個別に切り替えられるコンピューターの状態を表すクラスを作成します。OnOffSwitchState を使用して、これらのプロパティのクラスを定義します。

classdef SystemState
   properties
      Power matlab.lang.OnOffSwitchState = 'off'
      Monitor matlab.lang.OnOffSwitchState = 'off'
   end
   methods
      function val = isOn(obj)
         if ~(obj.Power && obj.Monitor)
            val = matlab.lang.OnOffSwitchState.off;
         else
            val = matlab.lang.OnOffSwitchState.on;
         end
      end
   end
end

SystemState オブジェクトを作成し、プロパティ値を 'on' に設定します。

a = SystemState;
a.Power = 'on';
a.Monitor = 'on';

isOn メソッドを呼び出して、システムの状態を判別します。このメソッドは OnOffSwitchState 列挙により提供される論理値を返します。

if isOn(a)
   ...% System is ready to use
end

詳細

すべて展開する

特化した連結動作

OnOffSwitchState クラスを使用すると、列挙型メンバーを文字ベクトルまたは string と連結することにより、テキスト表現を構成できます。たとえば、Power という名前のオブジェクトプロパティに OnOffSwitchState クラスの列挙型メンバーが含まれている場合、文字ベクトルとプロパティ値をもつ文字配列を形成することができます。

a = SystemState;
a.Power = true;
['The power switch is currently ' a.Power]

ans =

    'The power switch is currently on'

通常、文字ベクトルまたは string を列挙型メンバーと連結して配列を形成する場合、MATLAB^® はテキストを列挙型メンバーのクラスに変換しようと試みます。一方、OnOffSwitchState クラスは、クラスで定義された列挙型メンバーにテキストが対応しない場合に列挙型メンバーとテキストの連結を可能にする、特化した動作を定義します。このような場合、MATLAB はテキストと同じ型の配列を作成します。

以下は、MATLAB が文字ベクトルまたは string を OnOffSwitchState クラスの列挙型メンバーと連結する際に適用する規則です。

すべての配列要素が OnOffSwitchState 列挙型メンバーまたは文字ベクトルである場合、列挙型メンバーはすべて char の等価表現に変換される。結果の配列の型は char です。
すべての配列要素が OnOffSwitchState 列挙型メンバーまたは string である場合、列挙型メンバーはすべて string の等価表現に変換される。結果の配列の型は string です。
すべての配列要素が OnOffSwitchState 列挙型メンバー、string、または文字ベクトルである場合、列挙型メンバーと文字ベクトルはすべて string の等価表現に変換される。結果の配列の型は string です。
それ以外の場合はいずれも、通常の連結規則が適用される。詳細については、異なるクラスのオブジェクトの連結を参照してください。

等価性のテスト

OnOffSwitchState クラスは、列挙型メンバーと、値が 1 または 0 である char、string、logical、または数値型との間で等価性をテストするために、関数 eq (==) と関数 isequal をサポートしています。

バージョン履歴

R2017a で導入

参考

logical | string | char

トピック

プロパティ値の検証