MATLABControlUtils (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.plugins.scripting.matlab.MATLABControlUtils

```
public final class MATLABControlUtils
extends Object
```
Utility class for maintaining a single entry point to the MATLAB executable.

Author:

Mark Hiner

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`hasProxy()`
`static matlabcontrol.MatlabProxy`	`proxy()` A running MATLAB instance can only have one proxy active at a time.
`static matlabcontrol.MatlabProxy`	`proxy(boolean hidden)` As `proxy()`, with a specification flag for whether or not the MATLAB instance should be hidden and automatically exit when the calling JVM is shut down.
`static matlabcontrol.MatlabProxy`	`proxy(boolean hidden, boolean multithreaded)` As `proxy(boolean)` with a specification flag for whether or not MATLAB should be allowed to run multithreaded.
`static matlabcontrol.MatlabProxy`	`proxy(boolean hidden, boolean multithreaded, String license)` As `proxy(boolean, boolean)` with a specification string for the MATLAB license file.
`static matlabcontrol.MatlabProxy`	`proxy(MATLABOptions options)` As `proxy(boolean, boolean, String)` using the settings in the given `MATLABOptions`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - hasProxy
```
public static boolean hasProxy()
```
    Returns:
    
    True if there is an active MATLAB connection.
  - proxy
```
public static matlabcontrol.MatlabProxy proxy()
```
    A running MATLAB instance can only have one proxy active at a time. Attempting to create multiple proxies will cause additional instances of MATLAB to be spawned - which we would like to avoid. Thus this method will cache a proxy and return it if it is still connected. If not, a new proxy will be generated with the default configuration:
    - hidden = true
    - multithreaded = true
    - license = null
    Returns:
    
    An active MatlabProxy.
  - proxy
```
public static matlabcontrol.MatlabProxy proxy(boolean hidden)
```
    As proxy(), with a specification flag for whether or not the MATLAB instance should be hidden and automatically exit when the calling JVM is shut down.
    
    Parameters:
    
    hidden - If MATLAB should run hidden (no command prompt)
    
    Returns:
    
    An active MatlabProxy.
  - proxy
```
public static matlabcontrol.MatlabProxy proxy(boolean hidden,
                                              boolean multithreaded)
```
    As proxy(boolean) with a specification flag for whether or not MATLAB should be allowed to run multithreaded.
    
    Parameters:
    
    hidden - If MATLAB should run hidden (no command prompt)
    
    multithreaded - If MATLAB is allowed to be multithreaded
    
    Returns:
    
    An active MatlabProxy.
  - proxy
```
public static matlabcontrol.MatlabProxy proxy(boolean hidden,
                                              boolean multithreaded,
                                              String license)
```
    As proxy(boolean, boolean) with a specification string for the MATLAB license file.
    
    Parameters:
    
    hidden - If MATLAB should run hidden (no command prompt)
    
    multithreaded - If MATLAB is allowed to be multithreaded
    
    license - Path to MATLAB license
    
    Returns:
    
    An active MatlabProxy.
  - proxy
```
public static matlabcontrol.MatlabProxy proxy(MATLABOptions options)
```
    As proxy(boolean, boolean, String) using the settings in the given MATLABOptions
    
    Parameters:
    
    options - - Cached options for proxy configuration
    
    Returns:
    
    An active MatlabProxy.

Class MATLABControlUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

hasProxy

proxy

proxy

proxy

proxy

proxy