Main Content

coder.descriptor.FunctionInterface クラス

名前空間: coder.descriptor

エントリポイント関数に関する情報を返す

このページをすべて展開する

説明

関数インターフェイスは、生成されたコードのエントリポイント関数です。coder.descriptor.FunctionInterface オブジェクトは、指定された関数インターフェイスのさまざまなプロパティを示します。さまざまな種類の関数インターフェイスは次のとおりです。

  • Allocation: モデルのターゲットに基づいてメモリ割り当てコードを含めます。model_initialize を参照してください。

  • Initialize: モデルの初期化コードが含まれ、アプリケーション コードの開始時に一度呼び出されます。model_initialize を参照してください。

  • Output: モデルのブロックのための出力コードが含まれています。model_step を参照してください。

  • Update: モデルのブロックのための更新コードが含まれています。model_step を参照してください。

  • Terminate: モデルの終了コードが含まれ、システム シャットダウンの一部として呼び出されます。model_terminate を参照してください。

作成

functionInterface = getFunctionInterfaces(codeDescObj, functionInterfaceName) は、coder.descriptor.FunctionInterface オブジェクトを作成します。codeDescObj は、関数 getCodeDescriptor を使用することで、モデル用に作成された coder.codedescriptor.CodeDescriptor オブジェクトです。

入力引数

すべて展開する

指定された関数インターフェイスの名前。

例: 'Output'

データ型: string

プロパティ

すべて展開する

関数の戻り値、名前、引数、ヘッダーおよびソース ファイルなどを含む関数プロトタイプの記述。coder.descriptor.Prototype オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
public

関数の戻り引数。coder.descriptor.DataInterface オブジェクトとして指定します。関数からデータが返されない場合、このフィールドは空です。

属性:

GetAccess
public
SetAccess
public

関数インターフェイスと対話するモデルのバリアント条件。coder.descriptor.VariantInfo オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
public

関数が属するクラスの関数オーナー。coder.descriptor.TypedRegion オブジェクトとして指定します。C コードの生成では、このプロパティは空です。

属性:

GetAccess
public
SetAccess
public

ターゲット環境での関数アクセス レート。coder.descriptor.TimingInterface オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
public

関数への入力引数。coder.descriptor.DataInterfaceList オブジェクトとして指定します。関数に引数として渡されるデータがない場合、このプロパティは空です。

属性:

GetAccess
public

例

すべて折りたたむ

  1. モデルを開きます。

    openExample(‘CustomCodeComments’)

  2. モデルをビルドします。

    slbuild('CustomCodeComments')

  3. 必要なモデルの coder.codedescriptor.CodeDescriptor オブジェクトを作成します。

    codeDescObj = coder.getCodeDescriptor('rtwdemo_comments')

  4. 生成されたコードのすべての関数インターフェイスの種類のリストを返します。

    functionInterfaceTypes = getFunctionInterfaceTypes(codeDescObj)
        {'Initialize'}
    {'Output'    }

  5. 生成されたコードの指定された関数インターフェイスのプロパティを返します。

    functionInterface = getFunctionInterfaces(codeDescObj, 'Output')
            Prototype: [1×1 coder.descriptor.types.Prototype]
     ActualReturn: [0×0 coder.descriptor.DataInterface]
      VariantInfo: [0×0 coder.descriptor.VariantInfo]
           Timing: [1×1 coder.descriptor.TimingInterface]
       ActualArgs: [1x0 coder.descriptor.DataInterface List]

バージョン履歴

R2018a で導入

参考

| | |

トピック