matlab::engine::SharedFutureResult

非同期演算の結果を共有 future として取得する

説明

共有 future の結果は、MATLAB® の関数またはステートメントの結果を任意の回数取得するために使用するオブジェクトです。

クラスの詳細

名前空間:

matlab::engine
インクルードMatlabEngine.hpp

コンストラクターの概要

次の非同期関数のいずれかを使用して、FutureResult オブジェクトを作成します。

メソッドの概要

メンバー関数

cancel

FutureResult オブジェクトで保持されている演算をキャンセルします。

std::shared_future に委託されているメンバー関数

operator=, get, valid, wait, wait_for, wait_until

get メソッドでスローされる例外

matlab::engine::EngineException

MATLAB セッションの起動やセッションへの接続ができません。

matlab::engine::CancelException

コマンドの実行がキャンセルされました。

matlab::engine::InterruptedException

コマンドの評価が中断されました。

matlab::engine::MATLABNotAvailableException

MATLAB セッションを使用できません。

matlab::engine::MATLABSyntaxException

MATLAB 関数に構文エラーが存在します。

matlab::engine::MATLABExecutionException

関数に MATLAB ランタイム エラーがあります。

matlab::engine::TypeConversionException

MATLAB 関数の結果を指定された型に変換できません。

メソッドの詳細

cancel

bool FutureResult::cancel(bool allowInterrupt = true);
説明

MATLAB 関数またはステートメントの評価をキャンセルします。

matlab::engine::startMATLABAsync、matlab::engine::connectMATLABAsync、matlab::engine::findMATLABAsync の各関数を使用して開始された非同期的な起動、接続、または検索の操作はキャンセルできないことに注意してください。

パラメーター

bool allowInterrupt

false の場合、実行が既に開始されていたら中断しない。

戻り値

bool

MATLAB コマンドをキャンセルできる場合は true

例
bool flag = future.cancel();
例外

なし

バージョン履歴

R2017b で導入

参考

トピック