image thumbnail
from java_web_figures_demo by Joe Bienkowski
Java Web Figures Demo Code From Help

Plotter.html
Plotter

com.mathworks.examples.plot
Class Plotter

java.lang.Object
  extended by com.mathworks.toolbox.javabuilder.MWComponentInstance<Plotter>
      extended by com.mathworks.examples.plot.Plotter
All Implemented Interfaces:
com.mathworks.toolbox.javabuilder.Disposable

public class Plotter
extends com.mathworks.toolbox.javabuilder.MWComponentInstance<Plotter>

The Plotter C:\Projects\workspace\WebFiguresExample\m\getplot.m The dispose() method must be called on a Plotter instance when it is no longer needed to ensure that native resources allocated by this class are properly freed.


Field Summary
 
Fields inherited from class com.mathworks.toolbox.javabuilder.MWComponentInstance
fMCR
 
Constructor Summary
Plotter()
          Constructs a new instance of the Plotter class.
Plotter(com.mathworks.toolbox.javabuilder.MWComponentOptions componentOptions)
          Constructs a new instance of the Plotter class.
Plotter(java.lang.String pathToComponent)
          Constructs a new instance of the Plotter class.
 
Method Summary
 void dispose()
          Frees native resources associated with this object
static void disposeAllInstances()
          Calls dispose method for each outstanding instance of this class.
 java.lang.Object[] getplot(int nargout, java.lang.Object... rhs)
          Provides the standard interface for calling the getplot M-function with 0 input argument.
 void getplot(java.util.List lhs, java.util.List rhs)
          Provides the mlx interface for calling the getplot M-function.
 void getplot(java.lang.Object[] lhs, java.lang.Object[] rhs)
          Provides the mlx interface for calling the getplot M-function.
static void main(java.lang.String[] args)
          Invokes the first m-function specified by MCC, with any arguments given on the command line, and prints the result.
 
Methods inherited from class com.mathworks.toolbox.javabuilder.MWComponentInstance
alive, finalize, waitForFigures
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Plotter

public Plotter()
        throws com.mathworks.toolbox.javabuilder.MWException
Constructs a new instance of the Plotter class.

Throws:
com.mathworks.toolbox.javabuilder.MWException

Plotter

public Plotter(java.lang.String pathToComponent)
        throws com.mathworks.toolbox.javabuilder.MWException
Constructs a new instance of the Plotter class. Use this constructor to specify a component directory other than the default location.

Parameters:
pathToComponent - Path to component directory.
Throws:
com.mathworks.toolbox.javabuilder.MWException

Plotter

public Plotter(com.mathworks.toolbox.javabuilder.MWComponentOptions componentOptions)
        throws com.mathworks.toolbox.javabuilder.MWException
Constructs a new instance of the Plotter class. Use this constructor to specify the options required to instantiate this component. The options will be specific to the instance of this component being created.

Parameters:
componentOptions - Options specific to the component.
Throws:
com.mathworks.toolbox.javabuilder.MWException
Method Detail

dispose

public void dispose()
Frees native resources associated with this object

Specified by:
dispose in interface com.mathworks.toolbox.javabuilder.Disposable
Overrides:
dispose in class com.mathworks.toolbox.javabuilder.MWComponentInstance<Plotter>

main

public static void main(java.lang.String[] args)
Invokes the first m-function specified by MCC, with any arguments given on the command line, and prints the result.


disposeAllInstances

public static void disposeAllInstances()
Calls dispose method for each outstanding instance of this class.


getplot

public void getplot(java.util.List lhs,
                    java.util.List rhs)
             throws com.mathworks.toolbox.javabuilder.MWException
Provides the mlx interface for calling the getplot M-function.

Parameters:
lhs - List in which to return outputs. Number of outputs (nargout) is determined by allocated size of this List. Outputs are returned as sub-classes of com.mathworks.toolbox.javabuilder.MWArray. Each output array should be freed by calling its dispose() method.
rhs - List containing inputs. Number of inputs (nargin) is determined by the allocated size of this List. Input arguments may be passed as sub-classes of com.mathworks.toolbox.javabuilder.MWArray, or as arrays of any supported Java type. Arguments passed as Java types are converted to MATLAB arrays according to default conversion rules.
Throws:
com.mathworks.toolbox.javabuilder.MWException - An error has occured during the function call.

getplot

public void getplot(java.lang.Object[] lhs,
                    java.lang.Object[] rhs)
             throws com.mathworks.toolbox.javabuilder.MWException
Provides the mlx interface for calling the getplot M-function.

Parameters:
lhs - array in which to return outputs. Number of outputs (nargout) is determined by allocated size of this array. Outputs are returned as sub-classes of com.mathworks.toolbox.javabuilder.MWArray. Each output array should be freed by calling its dispose() method.
rhs - array containing inputs. Number of inputs (nargin) is determined by the allocated size of this array. Input arguments may be passed as sub-classes of com.mathworks.toolbox.javabuilder.MWArray, or as arrays of any supported Java type. Arguments passed as Java types are converted to MATLAB arrays according to default conversion rules.
Throws:
com.mathworks.toolbox.javabuilder.MWException - An error has occured during the function call.

getplot

public java.lang.Object[] getplot(int nargout,
                                  java.lang.Object... rhs)
                           throws com.mathworks.toolbox.javabuilder.MWException
Provides the standard interface for calling the getplot M-function with 0 input argument.

Parameters:
nargout - Number of outputs to return.
rhs - The inputs to the M function.
Returns:
Array of length nargout containing the function outputs. Outputs are returned as sub-classes of com.mathworks.toolbox.javabuilder.MWArray. Each output array should be freed by calling its dispose() method.
Throws:
com.mathworks.toolbox.javabuilder.MWException - An error has occured during the function call.


Contact us at files@mathworks.com