org.youscope.plugin.matlabscripting

Interface MatlabInternalProxy

All Superinterfaces:

java.rmi.Remote

public interface MatlabInternalProxy
extends java.rmi.Remote

Methods that can be called to control MATLAB except for checkConnection(). All of these methods throw RemoteException. RemoteException will be thrown if something occurs to disrupt the communication between this JVM and the one MATLAB is running in. For instance, closing MATLAB will terminate its JVM and then all method calls on this proxy will throw exceptions. Additionally, many of these methods throw InterruptedException. This occurs if while waiting for MATLAB to return from a method called on it, the thread waiting is interrupted. For descriptions of what these methods do see the corresponding methods in RemoteMatlabProxy.

Author:

Joshua Kaplan

Method Summary

Modifier and Type	Method and Description
void	checkConnection() This method does nothing.
java.lang.String	eval(java.lang.String command) Evaluates a command in MATLAB.
void	exit() Exits MATLAB.
void	feval(java.lang.String command, java.lang.Object[] args) Calls a MATLAB function with the name functionName.
java.lang.Object	getVariable(java.lang.String variableName) Gets the value of the variable named variableName from MATLAB.
java.lang.Object	returningEval(java.lang.String command, int returnCount) Evaluates a command in MATLAB.
java.lang.Object	returningFeval(java.lang.String command, java.lang.Object[] args) Calls a MATLAB function with the name functionName.
java.lang.Object	returningFeval(java.lang.String command, java.lang.Object[] args, int returnCount) Calls a MATLAB function with the name functionName.
void	setEchoEval(boolean echo) Allows for enabling a diagnostic mode that will show in MATLAB each time a Java method that calls into MATLAB is invoked.
void	setVariable(java.lang.String variableName, java.lang.Object value) Sets the variable to the given value.

Method Detail

exit

void exit()
   throws java.rmi.RemoteException,
          MatlabInvocationException

Exits MATLAB.

Throws:

java.rmi.RemoteException

MatlabInvocationException

setVariable

void setVariable(java.lang.String variableName,
                 java.lang.Object value)
          throws java.rmi.RemoteException,
                 MatlabInvocationException

Sets the variable to the given value.

Parameters:

variableName -

value -

Throws:

java.rmi.RemoteException

MatlabInvocationException

getVariable

java.lang.Object getVariable(java.lang.String variableName)
                      throws java.rmi.RemoteException,
                             MatlabInvocationException

Gets the value of the variable named variableName from MATLAB.

Parameters:

variableName -

Returns:

value

Throws:

java.rmi.RemoteException

MatlabInvocationException

eval

java.lang.String eval(java.lang.String command)
               throws java.rmi.RemoteException,
                      MatlabInvocationException

Evaluates a command in MATLAB. The result of this command will not be returned.

This is equivalent to MATLAB's eval(['command']).

Parameters:

command - the command to be evaluated in MATLAB

Returns:

A String representation of the Matlab display output.

Throws:

java.rmi.RemoteException

MatlabInvocationException

See Also:

returningEval(String, int)

feval

void feval(java.lang.String command,
           java.lang.Object[] args)
    throws java.rmi.RemoteException,
           MatlabInvocationException

Calls a MATLAB function with the name functionName. Arguments to the function may be provided as args, if you wish to call the function with no arguments pass in null. The result of this command will not be returned.

The Objects in the array will be converted into MATLAB equivalents as appropriate. Importantly, this means that any String will be converted to a MATLAB char array, not a variable name.

Parameters:

command - name of the MATLAB function to call

args - the arguments to the function, null if none

Throws:

java.rmi.RemoteException

MatlabInvocationException

See Also:

returningFeval(String, Object[], int), returningFeval(String, Object[])

returningFeval

java.lang.Object returningFeval(java.lang.String command,
                                java.lang.Object[] args)
                         throws java.rmi.RemoteException,
                                MatlabInvocationException

Calls a MATLAB function with the name functionName. Arguments to the function may be provided as args, if you wish to call the function with no arguments pass in null.

The Objects in the array will be converted into MATLAB equivalents as appropriate. Importantly, this means that any String will be converted to a MATLAB char array, not a variable name.

The result of this function can be returned. In order for a function's return data to be returned to MATLAB it is necessary to know how many arguments will be returned. This method will attempt to determine that automatically, but in the case where a function has a variable number of arguments returned it will only return one of them. To have all of them returned use returningFeval(String, Object[], int) and specify the number of arguments that will be returned.

Parameters:

command - name of the MATLAB function to call

args - the arguments to the function, null if none

Returns:

result of MATLAB function

Throws:

java.rmi.RemoteException

MatlabInvocationException

See Also:

feval(String, Object[]), returningFeval(String, Object[])

returningFeval

java.lang.Object returningFeval(java.lang.String command,
                                java.lang.Object[] args,
                                int returnCount)
                         throws java.rmi.RemoteException,
                                MatlabInvocationException

Calls a MATLAB function with the name functionName. Arguments to the function may be provided as args, if you wish to call the function with no arguments pass in null.

The Objects in the array will be converted into MATLAB equivalents as appropriate. Importantly, this means that any String will be converted to a MATLAB char array, not a variable name.

The result of this function can be returned. In order for the result of this function to be returned the number of arguments to be returned must be specified by returnCount . You can use the nargout function in the MATLAB Command Window to determine the number of arguments that will be returned. If nargout returns -1 that means the function returns a variable number of arguments based on what you pass in. In that case, you will need to manually determine the number of arguments returned. If the number of arguments returned differs from returnCount then either only some of the items will be returned or null will be returned.

Parameters:

command - name of the MATLAB function to call

args - the arguments to the function, null if none

returnCount - the number of arguments that will be returned from this function

Returns:

result of MATLAB function

Throws:

java.rmi.RemoteException

MatlabInvocationException

See Also:

feval(String, Object[]), returningFeval(String, Object[])

returningEval

java.lang.Object returningEval(java.lang.String command,
                               int returnCount)
                        throws java.rmi.RemoteException,
                               MatlabInvocationException

Evaluates a command in MATLAB. The result of this command can be returned.

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 returnCount. If the command you are evaluating is a MATLAB function you can determine the amount of arguments it returns by using the nargout function in the MATLAB Command Window. If it returns -1 that means the function returns a variable number of arguments based on what you pass in. In that case, you will need to manually determine the number of arguments returned. If the number of arguments returned differs from returnCount then either null or an empty String will be returned.

Parameters:

command - the command to be evaluated in MATLAB

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

Returns:

result of MATLAB eval

Throws:

java.rmi.RemoteException

MatlabInvocationException

See Also:

eval(String)

setEchoEval

void setEchoEval(boolean echo)
          throws java.rmi.RemoteException

Allows for enabling a diagnostic mode that will show in MATLAB each time a Java method that calls into MATLAB is invoked.

Parameters:

echo -

Throws:

java.rmi.RemoteException

checkConnection

void checkConnection()
              throws java.rmi.RemoteException

This method does nothing. It is used internally to check if a connection is still active.

Throws:

java.rmi.RemoteException