org.youscope.plugin.matlabscripting

Class RemoteMatlabProxyFactory

java.lang.Object

org.youscope.plugin.matlabscripting.RemoteMatlabProxyFactory

public class RemoteMatlabProxyFactory
extends java.lang.Object

Use this class to create instances of RemoteMatlabProxy. Each proxy will control a different instance of MATLAB. Confirmed to work on OS X, Windows, & Linux. If your operating system is not reported as OS X, it will launch it as if it were on Windows or Linux (they are handled exactly the same).

Author:

Joshua Kaplan

Constructor Summary

Constructors

Constructor and Description
RemoteMatlabProxyFactory()

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(MatlabConnectionListener listener) Add a listener to be notified when MATLAB connections are established and lost.
RemoteMatlabProxy	getProxy() Calling this method will get a RemoteMatlabProxy.
void	removeConnectionListener(MatlabConnectionListener listener) Removes a listener so that it is no longer notified.
void	requestProxy() Requests a proxy.
void	setMatlabLocation(java.lang.String matlabLocation) Set the location of the MATLAB program.
void	setTimeout(int ms) Sets the maximum amount of time to wait in attempting to setup a connection to MATLAB in milliseconds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteMatlabProxyFactory

public RemoteMatlabProxyFactory()

Method Detail

setMatlabLocation

public void setMatlabLocation(java.lang.String matlabLocation)

Set the location of the MATLAB program. If this property is not set an appropriate default for your operating system will be used. If that fails, then use this method to give the correct location.

Parameters:

matlabLocation -

requestProxy

public void requestProxy()
                  throws MatlabConnectionException

Requests a proxy. When the proxy has been made (there is a possibility it will not be if errors occur), all listeners will be notified.

Throws:

MatlabConnectionException

See Also:

getProxy(), addConnectionListener(MatlabConnectionListener)

getProxy

public RemoteMatlabProxy getProxy()
                           throws MatlabConnectionException

Calling this method will get a RemoteMatlabProxy. This will take some time as it involves launching MATLAB. If for any reason a connection cannot be established, this method will timeout in 60 seconds or the amount of time as specified by setTimeout(int).

Returns:

proxy

Throws:

MatlabConnectionException

See Also:

requestProxy()

setTimeout

public void setTimeout(int ms)

Sets the maximum amount of time to wait in attempting to setup a connection to MATLAB in milliseconds. The default value is 60 seconds.

Parameters:

ms -

addConnectionListener

public void addConnectionListener(MatlabConnectionListener listener)

Add a listener to be notified when MATLAB connections are established and lost.

Parameters:

listener -

removeConnectionListener

public void removeConnectionListener(MatlabConnectionListener listener)

Removes a listener so that it is no longer notified.

Parameters:

listener -