com.maplesoft.client
Class MapleImageFunctionPlot

java.lang.Object
  |
  +--com.maplesoft.client.MapleStatement
        |
        +--com.maplesoft.client.MapleImageBase
              |
              +--com.maplesoft.client.MapleImageFunctionPlot
Direct Known Subclasses:
MapleImage2DPlot

public class MapleImageFunctionPlot
extends MapleImageBase

Represents an object that can be plotted by specifying a function.
Before a plot can be generated the Host and User must be specified using setHost and setUser methods.
The function to be plotted is established using the setFunction method.
A plot is setup using MapleImagebase methods and then created via a call to the server using the getPlot method.


Field Summary
static java.lang.String CURVEMODE_COMPLEX
          The plots will be generated expecting that the function specified in setFunction is a complex valued function.
static java.lang.String CURVEMODE_FUNCTION
          The plots will be generated normal Maple Plots
static java.lang.String CURVEMODE_IMPLICIT
          The plots will be generated using the Maple ImplicitPlot method
 
Fields inherited from class com.maplesoft.client.MapleImageBase
FORMAT_GIF, FORMAT_JPEG
 
Constructor Summary
MapleImageFunctionPlot()
          Creates a Function Plot Object that will be evaluated by a the server.
MapleImageFunctionPlot(java.lang.String sFunction)
          Creates a Function Plot Object that will be evaluated by a server and initializes the definition of the function.
 
Method Summary
 java.lang.String getCurveMode()
          Returns the mode that was set by setCurveMode
 java.lang.String getFunction()
          Returns the function that was defined for this plot
 void setCurveMode(java.lang.String sMode)
          Set the type of Curve Plotting to perform.
 void setFunction(java.lang.String sFunction)
          Defines the function to be plotted.
 
Methods inherited from class com.maplesoft.client.MapleImageBase
getFormat, getHeight, getNumpoints, getOptions, getOptions, getOptions, getPlot, getPlotColor, getPlotLegend, getPlotTitle, getWidth, getXAxisLabel, getYAxisLabel, isThreeD, setDimensions, setDomain, setDomain, setDomain, setFormat, setHeight, setNumpoints, setOptions, setOptions, setPlotColor, setPlotLegend, setPlotTitle, setRange, setRange, setRange, setThreeD, setType, setWidth, setXAxisLabel, setYAxisLabel
 
Methods inherited from class com.maplesoft.client.MapleStatement
doMaple, execute, execute, getHost, getLock, getResponse, getResponseArray, getUser, getXMLString, getXMLStringArray, releaseLock, setHost, setHost, setUser, setUser
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CURVEMODE_FUNCTION

public static final java.lang.String CURVEMODE_FUNCTION
The plots will be generated normal Maple Plots
See Also:
setCurveMode(String)

CURVEMODE_COMPLEX

public static final java.lang.String CURVEMODE_COMPLEX
The plots will be generated expecting that the function specified in setFunction is a complex valued function.
See Also:
setCurveMode(String)

CURVEMODE_IMPLICIT

public static final java.lang.String CURVEMODE_IMPLICIT
The plots will be generated using the Maple ImplicitPlot method
See Also:
setCurveMode(String)
Constructor Detail

MapleImageFunctionPlot

public MapleImageFunctionPlot()
Creates a Function Plot Object that will be evaluated by a the server.
A function will need to be defined using the setFunction method.

MapleImageFunctionPlot

public MapleImageFunctionPlot(java.lang.String sFunction)
Creates a Function Plot Object that will be evaluated by a server and initializes the definition of the function.
Method Detail

setCurveMode

public void setCurveMode(java.lang.String sMode)
Set the type of Curve Plotting to perform.
Ensure that the Maple Function specified in setFunction matches the Curve Plotting Mode
Parameters:
sMode - This should be one of CURVEMODE_FUNCTION, CURVEMODE_COMPLEX or CURVEMODE_IMPLICIT. Any other value defaults to CURVEMODE_FUNCTION.

getCurveMode

public java.lang.String getCurveMode()
Returns the mode that was set by setCurveMode
Returns:
String The mode that will be used to plot this function

setFunction

public void setFunction(java.lang.String sFunction)
Defines the function to be plotted.
The function must be defined in the same terms, such as x and/or y, that was established in the setDomain and setRange methods.

getFunction

public java.lang.String getFunction()
Returns the function that was defined for this plot
Returns:
String The function that was defined in setFunction
See Also:
setFunction(java.lang.String)