Main Content

matlab.engine.connect_matlab

Python 用の MATLAB エンジンへの共有 MATLAB セッションの接続

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

構文

eng = matlab.engine.connect_matlab(name=None)
eng = matlab.engine.connect_matlab(___,background)
eng = matlab.engine.connect_matlab(___,async)

説明

例

eng = matlab.engine.connect_matlab(name=None) は、共有 MATLAB® セッション name に接続して、MatlabEngine オブジェクトを eng として返します。入力引数 name は、ローカル マシンで既に実行中の MATLAB セッションの名前を指定します。

  • name を指定し、その名前の共有 MATLAB セッションをエンジンが見つけられない場合、EngineError 例外が返されます。

  • name を指定せず、共有 MATLAB セッションをエンジンが 1 つも見つけられない場合、新しい共有 MATLAB セッションが開始されます。

  • name を指定せず、実行中の共有 MATLAB セッションをエンジンが複数見つけた場合、エンジンは最初に作成されたセッションに接続します。

background が True の場合、eng = matlab.engine.connect_matlab(___,background) は非同期的に接続します。この構文では、前述の構文の name 入力引数を使用できます。

async が True の場合、eng = matlab.engine.connect_matlab(___,async) は非同期的に接続します。推奨されません。代わりに background 引数を使用してください。Python® Version 3.7 以降には使用しないでください。詳細については、互換性についての考慮事項を参照してください。

例

すべて折りたたむ

ローカル マシンで既に実行中の共有 MATLAB セッションに接続します。

import matlab.engine
eng = matlab.engine.connect_matlab()
eng.sqrt(4.0)

2.0

matlab.engine.connect_matlab は最初に作成した共有 MATLAB セッションに接続します。共有 MATLAB セッションがない場合、matlab.engine.connect_matlab により新しいセッションが開始されます。

ローカル マシンに共有 MATLAB セッションが複数存在する場合は、名前を指定して 2 つの異なるセッションに 1 つずつ接続します。

最初に作成された MATLAB セッションに接続します。

import matlab.engine
names = matlab.engine.find_matlab()
names

('MATLAB_6830', 'MATLAB_7090')

次の MATLAB セッションに接続します。

eng = matlab.engine.connect_matlab('MATLAB_7090')
eng.sqrt(4.0)

2.0

入力引数

すべて折りたたむ

共有 MATLAB セッションの名前。文字配列として指定します。名前は有効な MATLAB 変数名でなければなりません。

MATLAB に同期的または非同期的に接続します。logical のキーワード引数として指定します。

例: matlab.engine.connect_matlab(background=True)

MATLAB に同期的または非同期的に接続します。logical のキーワード引数として指定します。推奨されません。代わりに background 引数を使用してください。詳細については、互換性についての考慮事項を参照してください。

出力引数

すべて折りたたむ

MATLAB と通信するための Python 変数で、MatlabEngine オブジェクトとして返されます。eng はローカル マシンで既に実行中の共有 MATLAB セッションと通信します。

制限

  • MATLAB の同じ共有セッションにエンジンを複数回接続しないでください。

バージョン履歴

R2015b で導入

すべて展開する

参考

|

トピック