matlabcontrol.link

Class LinkedOperations

java.lang.Object

matlabcontrol.link.LinkedOperations

All Implemented Interfaces:

MatlabOperations

public final class LinkedOperations
extends Object
implements MatlabOperations

Since:

4.2.0

Constructor Summary

Constructors

Constructor and Description
LinkedOperations(MatlabProxy proxy)

Method Summary

Modifier and Type	Method and Description
void	eval(String command) Evaluates a command in MATLAB.
void	feval(String functionName, Object... args) Calls a MATLAB function with the name functionName, returning the result.
MatlabProxy	getDelegateProxy() The proxy used to communicate with MATLAB.
Object	getVariable(String variableName) Gets the value of variableName in MATLAB.
Object[]	returningEval(String command, int nargout) Evaluates a command in MATLAB, returning the result.
Object[]	returningFeval(String functionName, int nargout, Object... args) Calls a MATLAB function with the name functionName, returning the result.
void	setVariable(String variableName, Object value) Sets variableName to value in MATLAB, creating the variable if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkedOperations

public LinkedOperations(MatlabProxy proxy)

Method Detail

eval

public void eval(String command)
          throws MatlabInvocationException

Description copied from interface: MatlabOperations

Evaluates a command in MATLAB. This is equivalent to MATLAB's eval('command').

Specified by:

eval in interface MatlabOperations

Parameters:

command - the command to be evaluated in MATLAB

Throws:

MatlabInvocationException

returningEval

public Object[] returningEval(String command,
                              int nargout)
                       throws MatlabInvocationException

Description copied from interface: MatlabOperations

Evaluates a command in MATLAB, returning the result. This is equivalent to MATLAB's eval('command').

In order for the result of this command to be returned the number of arguments to be returned must be specified by nargout. This is equivalent in MATLAB to the number of variables placed on the left hand side of an expression. For example, in MATLAB the inmem function may be used with either 1, 2, or 3 return values each resulting in a different behavior:

 
 M = inmem;
 [M, X] = inmem;
 [M, X, J] = inmem;
 
 

The returned Object array will be of length nargout with each return argument placed into the corresponding array position.

If the command cannot return the number of arguments specified by nargout then an exception will be thrown.

Specified by:

returningEval in interface MatlabOperations

Parameters:

command - the command to be evaluated in MATLAB

nargout - the number of arguments that will be returned from evaluating command

Returns:

result of MATLAB command, the length of the array will be nargout

Throws:

MatlabInvocationException

feval

public void feval(String functionName,
                  Object... args)
           throws MatlabInvocationException

Description copied from interface: MatlabOperations

Calls a MATLAB function with the name functionName, returning the result. Arguments to the function may be provided as args, but are not required if the function needs no arguments.

The function arguments will be converted into MATLAB equivalents as appropriate. Importantly, this means that a String will be converted to a MATLAB char array, not a variable name.

Specified by:

feval in interface MatlabOperations

Parameters:

functionName - the name of the MATLAB function to call

args - the arguments to the function

Throws:

MatlabInvocationException

returningFeval

public Object[] returningFeval(String functionName,
                               int nargout,
                               Object... args)
                        throws MatlabInvocationException

Description copied from interface: MatlabOperations

Calls a MATLAB function with the name functionName, returning the result. Arguments to the function may be provided as args, but are not required if the function needs no arguments.

The function arguments will be converted into MATLAB equivalents as appropriate. Importantly, this means that a String will be converted to a MATLAB char array, not a variable name.

In order for the result of this function to be returned the number of arguments to be returned must be specified by nargout. This is equivalent in MATLAB to the number of variables placed on the left hand side of an expression. For example, in MATLAB the inmem function may be used with either 1, 2, or 3 return values each resulting in a different behavior:

 
 M = inmem;
 [M, X] = inmem;
 [M, X, J] = inmem;
 
 

The returned Object array will be of length nargout with each return argument placed into the corresponding array position.

If the function is not capable of returning the number of arguments specified by nargout then an exception will be thrown.

Specified by:

returningFeval in interface MatlabOperations

Parameters:

functionName - the name of the MATLAB function to call

nargout - the number of arguments that will be returned by functionName

args - the arguments to the function

Returns:

result of MATLAB function, the length of the array will be nargout

Throws:

MatlabInvocationException

setVariable

public void setVariable(String variableName,
                        Object value)
                 throws MatlabInvocationException

Description copied from interface: MatlabOperations

Sets variableName to value in MATLAB, creating the variable if it does not yet exist.

Specified by:

setVariable in interface MatlabOperations

Throws:

MatlabInvocationException

getVariable

public Object getVariable(String variableName)
                   throws MatlabInvocationException

Description copied from interface: MatlabOperations

Gets the value of variableName in MATLAB.

Specified by:

getVariable in interface MatlabOperations

Returns:

value

Throws:

MatlabInvocationException

getDelegateProxy

public MatlabProxy getDelegateProxy()

The proxy used to communicate with MATLAB.

Returns:

proxy