artisynth.core.util

Class MatlabInterface

java.lang.Object

artisynth.core.util.MatlabInterface

public class MatlabInterface
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
double[][]	arrayFromMatlab(java.lang.String matlabName) Takes the MATLAB array named by matlabName and returns the corresponding double[][] object, with values assigned in row-major order.
static MatlabInterface	create()
void	dispose()
boolean	errorOccurred()
java.lang.Exception	getError()
boolean	isConnected()
Matrix	matrixFromMatlab(java.lang.String matlabName) Takes the MATLAB array named by matlabName and returns a corresponding Matrix object.
void	objectToMatlab(java.lang.Object obj, java.lang.String matlabName) Sets the MATLAB array named matlabName to the values associated with the ArtiSynth object obj.
VectorNd	vectorFromMatlab(java.lang.String matlabName) Takes the MATLAB array named by matlabName and returns a corresponding VectorNd object.

Methods inherited from class java.lang.Object

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

Method Detail

objectToMatlab

public void objectToMatlab(java.lang.Object obj,
                           java.lang.String matlabName)
                    throws MatlabInterfaceException

Sets the MATLAB array named matlabName to the values associated with the ArtiSynth object obj. The ArtiSynth object must be either a Matrix, Vector, or double[][]. The MATLAB array is dense, unless the ArtiSynth object is an instance of SparseMatrix, in which the assigned array is sparse.

Parameters:

obj - ArtiSynth objecy

matlabName - name of the MATLAB array

Throws:

MatlabInterfaceException - if communication with MATLAB fails

arrayFromMatlab

public double[][] arrayFromMatlab(java.lang.String matlabName)
                           throws MatlabInterfaceException

Takes the MATLAB array named by matlabName and returns the corresponding double[][] object, with values assigned in row-major order. If the named MATLAB array does not exist, or is not dense and 2-dimensional, then null is returned.

Parameters:

matlabName - name of the MATLAB array

Returns:

double array corresponding to the MATLAB array

Throws:

MatlabInterfaceException - if communication with MATLAB fails

matrixFromMatlab

public Matrix matrixFromMatlab(java.lang.String matlabName)
                        throws MatlabInterfaceException

Takes the MATLAB array named by matlabName and returns a corresponding Matrix object. If the named MATLAB array does not exist, or is not 2-dimensional, then null is returned. Otherwise, either a MatrixNd or SparseMatrixNd is returned, depending on whether the array is dense or sparse.

Parameters:

matlabName - name of the MATLAB array

Returns:

matrix corresponding to the MATLAB array

Throws:

MatlabInterfaceException - if communication with MATLAB fails

vectorFromMatlab

public VectorNd vectorFromMatlab(java.lang.String matlabName)
                          throws MatlabInterfaceException

Takes the MATLAB array named by matlabName and returns a corresponding VectorNd object. If the named MATLAB array does not exist, or is not 2-dimensional with a size of 1 in at least one dimension, then null Is returned.

Parameters:

matlabName - name of the MATLAB array

Returns:

vector corresponding to the MATLAB array

Throws:

MatlabInterfaceException - if communication with MATLAB fails

dispose

public void dispose()

errorOccurred

public boolean errorOccurred()

getError

public java.lang.Exception getError()

isConnected

public boolean isConnected()

create

public static MatlabInterface create()
                              throws MatlabInterfaceException

Throws:

MatlabInterfaceException