compiler.build.standaloneApplication

MATLAB の外部でデプロイするスタンドアロンアプリケーションを作成

R2020b 以降

ページ内をすべて折りたたむ

構文

compiler.build.standaloneApplication(AppFile)

compiler.build.standaloneApplication(AppFile,Name,Value)

compiler.build.standaloneApplication(opts)

results = compiler.build.standaloneApplication(___)

説明

例

compiler.build.standaloneApplication(AppFile) は、MATLAB^® 関数、クラス、または AppFile で指定したアプリを使用して、デプロイ可能なスタンドアロンアプリケーションを作成します。実行可能ファイルのタイプは、オペレーティングシステムにより決定されます。生成された実行可能ファイルには MATLAB Runtime やインストーラーが含まれていません。

例

compiler.build.standaloneApplication(AppFile,Name,Value) は、名前と値の引数を 1 つ以上使って指定した追加オプションを用いて、スタンドアロンアプリケーションを作成します。オプションには実行可能ファイルの名前、ヘルプテキスト、アイコンイメージがあります。

例

compiler.build.standaloneApplication(opts) は、compiler.build.StandaloneApplicationOptions オブジェクト opts を使って指定した追加オプションを用いて、スタンドアロンアプリケーションを作成します。名前と値の引数を使用して他のオプションを指定することはできません。

例

results = compiler.build.standaloneApplication(___) は、前述の構文にある引数の任意の組み合わせを使用して、ビルド情報を compiler.build.Results オブジェクトとして返します。ビルド情報は、ビルドタイプ、コンパイル済みファイルへのパス、およびビルドオプションで構成されます。

例

すべて折りたたむ

スタンドアロンアプリケーションの作成

魔方陣を生成する関数ファイルを使用してスタンドアロンアプリケーションを作成します。

MATLAB で、スタンドアロンアプリケーションとしてデプロイする MATLAB コードを見つけます。この例では、ファイル magicsquare.m を使用してコンパイルします。

appFile = fullfile(which('magicsquare.m'));

compiler.build.standaloneApplication コマンドを使用して、スタンドアロンアプリケーションをビルドします。

compiler.build.standaloneApplication(appFile);

この構文により、現在の作業ディレクトリの magicsquarestandaloneApplication という名前のフォルダー内に以下のファイルが生成されます。

includedSupportPackages.txt — アプリケーションに含まれている、すべてのサポートされるファイルをリストしたテキストファイル。
magicsquare.exe または magicsquare — Windows^® システムでコンパイルされた場合は .exe 拡張子をもつ実行可能ファイル、Linux^® システムまたは macOS システムでコンパイルされた場合は拡張子のない実行可能ファイル。
run_magicsquare.sh — ライブラリパスを設定し、アプリケーションを実行するシェルスクリプトファイル。このファイルは Linux システムおよび macOS システムでのみ生成されます。
mccExcludedFiles.log — アプリケーションに含まれていないすべてのツールボックス関数のリストが含まれるログファイル。サポートされていない関数の詳細については、MATLAB Compiler の制限を参照してください。
readme.txt — デプロイの前提条件に関する情報と、デプロイ用にパッケージ化するファイルのリストが含まれるテキストファイル。
requiredMCRProducts.txt — MATLAB Runtime がアプリケーションを実行するために必要な製品の製品 ID が含まれるテキストファイル。
unresolvedSymbols.txt — 未解決のシンボルに関する情報が含まれるテキストファイル。

入力引数 4 を指定して MATLAB から magicsquare を実行するには、magicsquarestandaloneApplication フォルダーに移動し、オペレーティングシステムに基づいて以下のコマンドのいずれかを実行します。

オペレーティングシステム	MATLAB コマンドウィンドウでのテスト
Windows	`!magicsquare 4`
macOS	`system(['./run_magicsquare.sh ',matlabroot,' 4']);`
Linux	`!./magicsquare 4`

アプリケーションにより 4 行 4 列の魔方陣が出力されます。

    16     2     3    13
     5    11    10     8
     9     7     6    12
     4    14    15     1

MATLAB 外でスタンドアロンアプリケーションを実行するには、Run Standalone Application を参照してください。

スタンドアロンアプリケーションのカスタマイズ

スタンドアロンアプリケーションを作成し、名前と値の引数を使用してカスタマイズします。

サブ関数を使用して魔方陣の対角要素を計算する MATLAB 関数を記述します。これらの関数を mymagicdiag.m および mydiag.m という名前のファイルに保存します。

function out = mymagicdiag(in)
X = magic(in);
out = mydiag(X);

function out = mydiag(in)
out = [diag(in)]';

mymagicdiag.m を使用してスタンドアロンアプリケーションをビルドします。名前と値のペアの引数を使用して実行可能ファイル名を指定し、関数ファイル mydiag.m を追加して、コマンドライン入力を double の数値として解釈します。

compiler.build.standaloneApplication('mymagicdiag.m',...
    'ExecutableName','MagicDiagApp',...
    'AdditionalFiles','mydiag.m',...
    'TreatInputsAsNumeric','On')

入力引数 4 を指定して MATLAB から MagicDiagApp を実行するには、MagicDiagAppstandaloneApplication フォルダーに移動し、オペレーティングシステムに基づいて以下のコマンドのいずれかを実行します。

オペレーティングシステム	MATLAB コマンドウィンドウでのテスト
Windows	`!MagicDiagApp 4`
macOS	`system(['./run_MagicDiagApp.sh ',matlabroot,' 4']);`
Linux	`!./MagicDiagApp 4`

アプリケーションにより、4 行 4 列の魔方陣の対角要素が出力されます。

    16     11     6    1

オプションオブジェクトを使用した複数のアプリケーションの作成

compiler.build.StandaloneApplicationOptions オブジェクトを使用して、Windows システム上で複数のスタンドアロンアプリケーションを作成します。

ファイル magicsquare.m を使用してスタンドアロンアプリケーションを作成します。

appFile = fullfile(which('magicsquare'));

appFile を使用して StandaloneApplicationOptions オブジェクトを作成します。名前と値の引数を使用して共通の出力ディレクトリを指定し、コマンドライン入力を double の数値として解釈し、ビルドプロセス中に進行状況の情報を表示します。

opts = compiler.build.StandaloneApplicationOptions(appFile,...
    'OutputDir','D:\Documents\MATLAB\work\MagicBatch',...
    'TreatInputsAsNumeric','On',...
    'Verbose','On')

opts =

  StandaloneApplicationOptions with properties:

            CustomHelpTextFile: ''
              EmbedArchive: on
            ExecutableIcon: 'C:\Program Files\MATLAB\R2023b\toolbox\compiler\packagingResources\default_icon_48.png'
            ExecutableName: 'magicsquare'
    ExecutableSplashScreen: 'C:\Program Files\MATLAB\R2023b\toolbox\compiler\packagingResources\default_splash.png'
         ExecutableVersion: '1.0.0.0'
                   AppFile: 'C:\Program Files\MATLAB\R2023b\extern\examples\compiler\magicsquare.m'
      TreatInputsAsNumeric: on
           AdditionalFiles: {}
       AutoDetectDataFiles: on
          ObfuscateArchive: off
           SupportPackages: {'autodetect'}
                   Verbose: on
                 OutputDir: 'D:\Documents\MATLAB\work\MagicBatch'

StandaloneApplicationOptions オブジェクトを入力としてビルド関数に渡すことで、スタンドアロンアプリケーションをビルドします。

compiler.build.standaloneApplication(opts);

同じオプションをもつ関数ファイル example2.m を使用して新しいスタンドアロンアプリケーションを作成するには、ビルド関数を再度実行する前に、ドット表記を使用して既存の StandaloneApplicationOptions オブジェクトの AppFile を変更します。

opts.AppFile = 'example2.m';
compiler.build.standaloneApplication(opts);

AppFile 引数を変更して再コンパイルすることにより、同じオプションオブジェクトを使用して複数のアプリケーションを作成できます。

スタンドアロンアプリケーションからのビルド情報の取得

スタンドアロンアプリケーションを作成し、ビルドタイプ、生成ファイル、含まれるサポートパッケージ、およびビルドオプションに関する情報を compiler.build.Results オブジェクトに保存します。

ファイル magicsquare.m を使用してコンパイルします。

results = compiler.build.standaloneApplication('magicsquare.m')

results = 

              BuildType: 'standaloneApplication'
                  Files: {2×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.StandaloneApplicationOptions]

Files プロパティには、magicsquare スタンドアロン実行可能ファイルと readme.txt ファイルへのパスが格納されます。

入力引数

すべて折りたたむ

`AppFile` — メインファイルへのパス
文字ベクトル | string スカラー

アプリケーションのビルドに使用するメインファイルへのパス。行の文字ベクトルまたは string スカラーとして指定します。このファイルは、MATLAB 関数、クラス、またはアプリで、タイプは .m、.p、.mlx、.mlapp、あるいは有効な MEX ファイルでなければなりません。

例: 'mymagic.m'

データ型: char | string

`opts` — スタンドアロンアプリケーションのビルドオプション
`StandaloneApplicationOptions` オブジェクト

スタンドアロンアプリケーションのビルドオプション。compiler.build.StandaloneApplicationOptions オブジェクトとして指定します。

名前と値の引数

オプションのペアの引数を Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定する必要がありますが、ペアの順序は考慮されません。

R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name を引用符で囲みます。

例: OutputDir='D:\work\myproject'

`AdditionalFiles` — 追加ファイル
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

スタンドアロンアプリケーションに含める追加のファイルとフォルダー。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

例: 'AdditionalFiles',["myvars.mat","myfunc.m"]

データ型: char | string | cell

`AutoDetectDataFiles` — データファイルを自動的に含めるためのフラグ
`'on'` (既定値) | on/off logical 値

データファイルを自動的に含めるためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティを 'on' に設定した場合、特定の関数 (load や fopen など) の入力として指定されるデータファイルは自動的にスタンドアロンアプリケーションに含められます。これは既定の動作です。
このプロパティを 'off' に設定した場合、データファイルは AdditionalFiles プロパティを使用してアプリケーションに追加しなければなりません。

例: 'AutoDetectDataFiles','Off'

データ型: logical

`CustomHelpTextFile` — ヘルプファイルへのパス
文字ベクトル | string スカラー

アプリケーションのエンドユーザー向けヘルプテキストが含まれるヘルプファイルへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

例: 'CustomHelpTextFile','D:\Documents\MATLAB\work\help.txt'

データ型: char | string

`EmbedArchive` — デプロイ可能なアーカイブを組み込むためのフラグ
`'on'` (既定値) | on/off logical 値

デプロイ可能なアーカイブを組み込むためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティを 'on' に設定した場合、関数はアーカイブをデプロイ可能な実行可能ファイルに組み込みます。
このプロパティを 'off' に設定した場合、関数はデプロイ可能なアーカイブを別個のファイルとして生成します。

例: 'EmbedArchive','Off'

データ型: logical

`ExecutableIcon` — アイコンイメージへのパス
文字ベクトル | string スカラー

アイコンイメージへのパス。文字ベクトルまたは string スカラーとして指定します。イメージは、スタンドアロン実行可能ファイルのアイコンとして使用されます。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。使用可能なイメージのタイプは .jpg、.jpeg、.png、.bmp、.gif です。

既定のパスは次のとおりです。

'matlabroot\toolbox\compiler\packagingResources\default_icon_48.png'

例: 'ExecutableIcon','D:\Documents\MATLAB\work\images\myIcon.png'

データ型: char | string

`ExecutableName` — 生成されるアプリケーションの名前
文字ベクトル | string スカラー

生成されるアプリケーションの名前。文字ベクトルまたは string スカラーとして指定します。既定値は AppFile のファイル名です。ターゲットの出力名は英字またはアンダースコアで始まっていなければならず、また英数字とアンダースコアのみ使用できます。

例: 'ExecutableName','MagicSquare'

データ型: char | string

`ExecutableSplashScreen` — スプラッシュスクリーンイメージへのパス
文字ベクトル | string スカラー

スプラッシュスクリーンイメージへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。使用可能なイメージのタイプは .jpg、.jpeg、.png、.bmp、.gif です。イメージのサイズは 400 x 400 ピクセルに変更されます。

既定のパスは次のとおりです。

'matlabroot\toolbox\compiler\packagingResources\default_splash.png'

メモ

これは、compiler.build.standaloneWindowsApplication を使用してビルドされた Windows アプリケーションでのみ使用されます。

例: 'ExecutableSplashScreen','D:\Documents\MATLAB\work\images\mySplash.png'

データ型: char | string

`ExecutableVersion` — 実行可能ファイルのバージョン
`'1.0.0.0'` (既定値) | 文字ベクトル | string スカラー

実行可能ファイルのバージョン。文字ベクトルまたは string スカラーとして指定します。

メモ

これは Windows オペレーティングシステムでのみ使用されます。

例: 'ExecutableVersion','4.0'

データ型: char | string

`ObfuscateArchive` — デプロイ可能なアーカイブを難読化するためのフラグ
`'off'` (既定値) | on/off logical 値

デプロイ可能なアーカイブを難読化するためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティを 'on' に設定した場合、デプロイ可能なアーカイブのフォルダー構造およびファイル名はエンドユーザーに対して難読化され、MATLAB ファイルに含まれているユーザーコードおよびデータはアーカイブ内のユーザーパッケージに配置されます。また、すべての .m ファイルがパッケージ化の前に P ファイルに変換されます。このオプションは、-j および -s を指定して mcc を使用するのと等価です。
このプロパティを 'off' に設定した場合、デプロイ可能なアーカイブは難読化されません。これは既定の動作です。

例: 'ObfuscateArchive','on'

データ型: logical

`OutputDir` — 出力ディレクトリへのパス
文字ベクトル | string スカラー

ビルドファイルが保存される出力ディレクトリへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

ビルドフォルダーの既定の名前は、実行可能ファイル名に standaloneApplication を追加したものです。

例: 'OutputDir','D:\Documents\MATLAB\work\MagicSquarestandaloneApplication'

データ型: char | string

`SupportPackages` — サポートパッケージ
`'autodetect'` (既定値) | `'none'` | string スカラー | 文字ベクトルの cell 配列 | string 配列

含めるサポートパッケージ。次のオプションのいずれかとして指定します。

'autodetect' (既定) — 依存関係の分析プロセスにより、必要なサポートパッケージが自動的に検出され、含められます。
'none' — サポートパッケージは含められません。このオプションを使用すると、ランタイムエラーの原因となる可能性があります。
string スカラー、文字ベクトル、または文字ベクトルの cell 配列 — 指定されたサポートパッケージのみが含められます。インストールされている、または特定のファイルで使用されるサポートパッケージのリストを表示するには、compiler.codetools.deployableSupportPackages を参照してください。

例: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

データ型: char | string | cell

`TreatInputsAsNumeric` — コマンドライン入力を解釈するためのフラグ
`'off'` (既定値) | on/off logical 値

コマンドライン入力を数値として解釈するためのフラグ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティを 'on' に設定した場合、コマンドライン入力は MATLAB double の数値として扱われます。
このプロパティを 'off' に設定した場合、コマンドライン入力は MATLAB 文字ベクトルとして扱われます。これは既定の動作です。

例: 'TreatInputsAsNumeric','on'

データ型: logical

`Verbose` — ビルドの詳細を制御するためのフラグ
`'off'` (既定値) | on/off logical 値

ビルドの詳細を制御するためのフラグ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティを 'on' に設定した場合、MATLAB コマンドウィンドウには、ビルドプロセス中のコンパイラ出力を示す進行状況情報が表示されます。
このプロパティを 'off' に設定した場合、コマンドウィンドウには進行状況の情報は表示されません。これは既定の動作です。

例: 'Verbose','on'

データ型: logical

出力引数

すべて折りたたむ

`results` — ビルド結果
`compiler.build.Results` オブジェクト

ビルド結果。compiler.build.Results オブジェクトとして返されます。Results オブジェクトには以下が含まれています。

'standaloneApplication' であるビルドタイプ
コンパイル済みファイルへのパス
含まれているサポートパッケージのリスト
ビルドオプション。StandaloneApplicationOptions オブジェクトとして指定

ヒント

この関数を使用してシステムコマンドプロンプトからスタンドアロンアプリケーションを作成するには、関数 matlab を -batch オプションと共に使用します。以下に例を示します。
```
matlab -batch compiler.build.standaloneApplication('mymagic.m')
```

バージョン履歴

R2020b で導入

参考

compiler.build.StandaloneApplicationOptions | compiler.package.installer | compiler.build.standaloneWindowsApplication | アプリケーションコンパイラ | mcc

トピック

MATLAB 関数からのスタンドアロンアプリケーションの作成

compiler.build.standaloneApplication

構文

説明

例

スタンドアロン アプリケーションの作成

スタンドアロン アプリケーションのカスタマイズ

オプション オブジェクトを使用した複数のアプリケーションの作成

スタンドアロン アプリケーションからのビルド情報の取得

入力引数

AppFile — メイン ファイルへのパス 文字ベクトル | string スカラー

opts — スタンドアロン アプリケーションのビルド オプション StandaloneApplicationOptions オブジェクト

名前と値の引数

AdditionalFiles — 追加ファイル 文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

AutoDetectDataFiles — データ ファイルを自動的に含めるためのフラグ 'on' (既定値) | on/off logical 値

CustomHelpTextFile — ヘルプ ファイルへのパス 文字ベクトル | string スカラー

EmbedArchive — デプロイ可能なアーカイブを組み込むためのフラグ 'on' (既定値) | on/off logical 値

ExecutableIcon — アイコン イメージへのパス 文字ベクトル | string スカラー

ExecutableName — 生成されるアプリケーションの名前 文字ベクトル | string スカラー

ExecutableSplashScreen — スプラッシュ スクリーン イメージへのパス 文字ベクトル | string スカラー

ExecutableVersion — 実行可能ファイルのバージョン '1.0.0.0' (既定値) | 文字ベクトル | string スカラー

ObfuscateArchive — デプロイ可能なアーカイブを難読化するためのフラグ 'off' (既定値) | on/off logical 値

OutputDir — 出力ディレクトリへのパス 文字ベクトル | string スカラー

SupportPackages — サポート パッケージ 'autodetect' (既定値) | 'none' | string スカラー | 文字ベクトルの cell 配列 | string 配列

TreatInputsAsNumeric — コマンド ライン入力を解釈するためのフラグ 'off' (既定値) | on/off logical 値

Verbose — ビルドの詳細を制御するためのフラグ 'off' (既定値) | on/off logical 値

出力引数

results — ビルド結果 compiler.build.Results オブジェクト

ヒント

バージョン履歴

参考

トピック

スタンドアロンアプリケーションの作成

スタンドアロンアプリケーションのカスタマイズ

オプションオブジェクトを使用した複数のアプリケーションの作成

スタンドアロンアプリケーションからのビルド情報の取得

`AppFile` — メインファイルへのパス
文字ベクトル | string スカラー

`opts` — スタンドアロンアプリケーションのビルドオプション
`StandaloneApplicationOptions` オブジェクト

`AdditionalFiles` — 追加ファイル
文字ベクトル | string スカラー | 文字ベクトルの cell 配列 | string 配列

`AutoDetectDataFiles` — データファイルを自動的に含めるためのフラグ
`'on'` (既定値) | on/off logical 値

`CustomHelpTextFile` — ヘルプファイルへのパス
文字ベクトル | string スカラー

`EmbedArchive` — デプロイ可能なアーカイブを組み込むためのフラグ
`'on'` (既定値) | on/off logical 値

`ExecutableIcon` — アイコンイメージへのパス
文字ベクトル | string スカラー

`ExecutableName` — 生成されるアプリケーションの名前
文字ベクトル | string スカラー

`ExecutableSplashScreen` — スプラッシュスクリーンイメージへのパス
文字ベクトル | string スカラー

`ExecutableVersion` — 実行可能ファイルのバージョン
`'1.0.0.0'` (既定値) | 文字ベクトル | string スカラー

`ObfuscateArchive` — デプロイ可能なアーカイブを難読化するためのフラグ
`'off'` (既定値) | on/off logical 値

`OutputDir` — 出力ディレクトリへのパス
文字ベクトル | string スカラー

`SupportPackages` — サポートパッケージ
`'autodetect'` (既定値) | `'none'` | string スカラー | 文字ベクトルの cell 配列 | string 配列

`TreatInputsAsNumeric` — コマンドライン入力を解釈するためのフラグ
`'off'` (既定値) | on/off logical 値

`Verbose` — ビルドの詳細を制御するためのフラグ
`'off'` (既定値) | on/off logical 値

`results` — ビルド結果
`compiler.build.Results` オブジェクト