org.n52.matlab.control.LocalMatlabProxy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of matlab-control Show documentation
MATLAB Control
The newest version!
package org.n52.matlab.control;

/*
 * Copyright (c) 2013, Joshua Kaplan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *  - Redistributions of source code must retain the above copyright notice, this list of conditions and the following
 *    disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
 *    following disclaimer in the documentation and/or other materials provided with the distribution.
 *  - Neither the name of matlabcontrol nor the names of its contributors may be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * Allows for calling MATLAB from inside of MATLAB.
 * 
 * @since 3.1.0
 * 
 * @author Joshua Kaplan
 */
class LocalMatlabProxy extends MatlabProxy
{   
    /**
     * If connected to MATLAB.
     * 
     * This notion of connection exists to make it consistent with {@link RemoteMatlabProxy}, but is not actually
     * necessary. Unless a user calls {@link #disconnect()} this proxy cannot become disconnected.
     */
    private volatile boolean _isConnected = true;

    LocalMatlabProxy(Identifier id)
    {
        super(id, true);
    }
    
    @Override
    public boolean isRunningInsideMatlab()
    {
        return true;
    }
    
    @Override
    public boolean isConnected()
    {
        return _isConnected;
    }
    
    @Override
    public boolean disconnect()
    {
        _isConnected = false;
        
        //Notify listeners
        notifyDisconnectionListeners();
        
        return true;
    }
    
    // Methods which interact with MATLAB
        
    @Override
    public void exit() throws MatlabInvocationException
    {
        if(this.isConnected())
        {
            JMIWrapper.exit();
        }
        else
        {
            throw MatlabInvocationException.Reason.PROXY_NOT_CONNECTED.asException();
        }
    }

    @Override
    public void eval(String command) throws MatlabInvocationException
    {
        if(this.isConnected())
        {
            JMIWrapper.eval(command);
        }
        else
        {
            throw MatlabInvocationException.Reason.PROXY_NOT_CONNECTED.asException();
        }
    }
    
    @Override
    public Object[] returningEval(String command, int nargout) throws MatlabInvocationException
    {
        if(this.isConnected())
        {
            return JMIWrapper.returningEval(command, nargout);
        }
        else
        {
            throw MatlabInvocationException.Reason.PROXY_NOT_CONNECTED.asException();
        }
    }
    
    @Override
    public void feval(String functionName, Object... args) throws MatlabInvocationException
    {
        if(this.isConnected())
        {
            JMIWrapper.feval(functionName, args);
        }
        else
        {
            throw MatlabInvocationException.Reason.PROXY_NOT_CONNECTED.asException();
        }
    }

    @Override
    public Object[] returningFeval(String functionName, int nargout, Object... args) throws MatlabInvocationException
    {
        if(this.isConnected())
        {
            return JMIWrapper.returningFeval(functionName, nargout, args);
        }
        else
        {
            throw MatlabInvocationException.Reason.PROXY_NOT_CONNECTED.asException();
        }
    }

    @Override
    public void setVariable(String variableName, Object value) throws MatlabInvocationException
    {
        if(this.isConnected())
        {
            JMIWrapper.setVariable(variableName, value);
        }
        else
        {
            throw MatlabInvocationException.Reason.PROXY_NOT_CONNECTED.asException();
        }
    }
    
    @Override
    public Object getVariable(String variableName) throws MatlabInvocationException
    {
        if(this.isConnected())
        {
            return JMIWrapper.getVariable(variableName);
        }
        else
        {
            throw MatlabInvocationException.Reason.PROXY_NOT_CONNECTED.asException();
        }
    }
    
    @Override
    public  T invokeAndWait(MatlabThreadCallable callable) throws MatlabInvocationException
    {
        if(this.isConnected())
        {
            return JMIWrapper.invokeAndWait(callable);
        }
        else
        {
            throw MatlabInvocationException.Reason.PROXY_NOT_CONNECTED.asException();
        }
    }
}