Main Content

このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

MATLAB クラスに対応する C++ クラスの生成

C++ コードを生成する場合、コード ジェネレーターの既定の動作では、MATLAB® コード内のクラスに対応する C++ クラスが生成されます。これには、値クラス、ハンドル クラス、System object などのすべての MATLAB クラスが含まれます。

コード ジェネレーターの既定の動作を変更して、MATLAB クラスに対応する構造体を生成できます。この選択を行う場合、次のいずれか 1 つを行います。

  • コード構成オブジェクトで、TargetLang'C++' に、CppPreserveClassesfalse に設定します。

  • MATLAB Coder™ アプリの [生成] ステップで、[言語][C++] に設定します。プロジェクトのビルド設定の [コード外観] タブで、[MATLAB クラスから C++ クラスを生成] チェック ボックスをオフにします。

以下の例では、MATLAB クラスを C++ クラスにマッピングする際にコード ジェネレーターが従う特定の規則を示します。

例: プライベート メンバーとパブリック メンバーをもつハンドル クラスのコード生成

MATLAB ハンドル クラス MyClass を定義します。

classdef MyClass < handle
    properties
        publicProp = 1;
    end
    properties(Access = private)
        privateProp
    end
    methods
        function obj = MyClass(value)
            obj.privateProp = value;
        end
        function publicMethod(obj,value)
            obj.privateMethod(value);
        end
        function res = calculateSomeValue(obj)
            res = obj.publicProp*obj.privateProp;
        end
    end
    methods (Access = private)
        function privateMethod(obj,value)
            obj.publicProp = obj.publicProp + value;
            obj.privateProp = obj.privateProp + obj.doubleThisValue(value);
        end
    end
    methods(Static)
        function res = doubleThisValue(val)
            res = 2 * val;
        end
    end
end

MyClass を使用する MATLAB 関数 foo を定義します。

function out = foo(x,y)
obj = MyClass(x);
obj.publicMethod(y);
out = obj.calculateSomeValue;
end

foo の C++ スタティック ライブラリを生成します。入力引数を double スカラーに指定します。

codegen -config:lib -lang:c++ foo -args {0,0} -report
Code generation successful: View report

コード生成レポートを開き、生成されたコードを検査します。ファイル MyClass.h には、生成された C++ クラス MyClass の定義が含まれています。

class MyClass
{
 public:
  MyClass *init(double value);
  void publicMethod(double value);
  static double doubleThisValue(double val);
  double calculateSomeValue() const;
  double publicProp;
 private:
  double privateProp;
};

関数 foo に対して生成されたコードは次のとおりです。

double foo(double x, double y)
{
  MyClass obj;
  obj.init(x);
  obj.publicMethod(y);
  return obj.calculateSomeValue();
}

次の表に、C++ クラスを生成する際にコード ジェネレーターが従ういくつかの規則と、MyClass に対して生成されたコードの対応するスニペットを示します。

ルールコード スニペット

MATLAB のクラス コンストラクターは init メソッドにマッピングされています。クラスのインスタンスが作成されると、生成されたコードによって init メソッドが明示的に呼び出されます。

ファイル MyClass.cpp には init の定義が含まれています。

MyClass *MyClass::init(double value)
{
  MyClass *obj;
  obj = this;
  obj->publicProp = 1.0;
  obj->privateProp = value;
  return obj;
}

多くの場合、MATLAB でプライベートとして設定されているクラス メンバーは、生成された C++ コードでもプライベートとして設定されます。

場合によっては、MATLAB のプライベート プロパティが、生成されたコードでパブリックに変更されることがあります。たとえば、MATLAB でオブジェクトのプライベート プロパティ prop を使用するパブリック メソッド myMethod がエントリポイント関数によって呼び出されるとします。また、myMethod に、生成されたコードで myMethod を強制的にインライン化する coder.inline('always') 命令が含まれていると仮定します。つまり、生成されたコードでは、プロパティ prop はオブジェクトの外部から認識されなければならず、パブリックに変更されなければなりません。

この現象の発生を制限するために、コード ジェネレーターは、メソッドに coder.inline('always') 命令が含まれていない限り、パブリック メソッドをインライン化しません。

生成された C++ クラス MyClass の定義は次のとおりです。

class MyClass
{
 public:
  MyClass *init(double value);
  void publicMethod(double value);
  static double doubleThisValue(double val);
  double calculateSomeValue() const;
  double publicProp;
 private:
  double privateProp;
};

すべてのデータおよびメンバー関数の可視性は、MATLAB と生成されたコードの間で維持されます。

プライベート メソッド privateMethod はこの定義には表示されません。privateMethodpublicMethod の定義でインライン化されています (ファイル MyClass.cpp 内を参照)。

void MyClass::publicMethod(double value)
{
  this->publicProp += value;
  this->privateProp += MyClass::doubleThisValue((value));
}

MATLAB の静的メソッドは C++ 静的メソッドにマッピングされています。

静的メソッド doubleThisValue の生成されたコードには次のシグネチャがあります。

static double doubleThisValue(double val);

生成されたコードでは、オブジェクトを変更しないメソッドは const 修飾子でマークされます。

パブリック メソッド calculateSomeValue はオブジェクトを変更しません。生成されたメソッドには次のシグネチャがあります。

double calculateSomeValue() const;

その他の使用上の注意事項および制限事項

MATLAB クラスからの C++ クラスの生成については、その他にも使用上の注意事項および制限事項がいくつかあります。

  • MyClass のクラスのプロトタイプはヘッダー ファイル MyClass.h に含まれています。クラスのメソッドの実装はファイル MyClass.cpp に含まれています。

  • 生成されたコードでは、クラス階層はフラットになります。たとえば、MATLAB コードで、クラス B がクラス A から継承されるとします。生成された C++ コードでは、クラス B とクラス A の間に継承関係はありません。生成されたコードでは、クラス A のすべてのプロパティおよびメソッドがクラス B の定義で再現されます。

  • MATLAB クラスがそのプロパティに対して異なる型を使用する場合、コード ジェネレーターは型の使用ごとに個別の C++ クラスを生成します。

  • MATLAB クラス メンバーの GetAccess 属性と SetAccess 属性が異なる場合、生成されたクラスの対応するメンバーは、2 つの属性のうち許容性が高い方をもちます。たとえば、プロパティ prop が属性 (GetAccess = public, SetAccess = private) をもつ場合、生成されたコードでは、prop はパブリックに定義されます。

  • MATLAB クラスに対応する C++ クラスを含むスタンドアロン コードを生成しようとしたときに、以下の両方の条件に該当する場合は、警告メッセージが表示されることがあります。

    • コード構成オブジェクトで MultiInstanceCode パラメーターを有効にするか、MATLAB Coder アプリで [再呼び出し可能なコードを生成] パラメーターを有効にすることで、再呼び出し可能なコードを生成するように選択した。

    • MATLAB コード内のクラスのデストラクターが永続変数をもつか、永続変数を宣言して使用する別の関数を呼び出す。

    このような状況で、MATLAB クラスに対応する C++ クラスを含むコードを生成するには、MultiInstanceCode パラメーターまたは [再呼び出し可能なコードを生成] パラメーターを無効にします。

参考

| |

関連するトピック