public class PlotExample
extends java.lang.Object
Constructor and Description |
---|
PlotExample(java.lang.String name,
java.lang.String taskName,
java.lang.String[] params,
java.lang.String[] comments)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static PlotExample[] |
createPlot2dExamples()
Returns a list of examples for the plot2d task.
|
static PlotExample[] |
createPlot3dExamples()
Returns a list of examples for the plot3d task.
|
static PlotExample[] |
createPlotHistExamples()
Returns a list of examples for the plothist task.
|
static void |
main(java.lang.String[] args)
Writes example files ready for incorporation into documentation.
|
java.lang.String |
writeImage()
Generates and outputs the image file showing the result of this
example.
|
void |
writeXml(java.io.PrintStream out)
Outputs the XML for this example as a <dt><dd> element
pair.
|
public PlotExample(java.lang.String name, java.lang.String taskName, java.lang.String[] params, java.lang.String[] comments) throws uk.ac.starlink.task.TaskException, uk.ac.starlink.util.LoadException
name
- example nametaskName
- name of the STILTS task being usedparams
- array of name=value pairs giving parameters;
a null in the list signifies line break for formattingcomments
- array of lines consituting the example description;
concatenated must form one or more XML <p>
elementsuk.ac.starlink.task.TaskException
uk.ac.starlink.util.LoadException
public void writeXml(java.io.PrintStream out) throws java.io.IOException
out
- destination streamjava.io.IOException
public java.lang.String writeImage() throws java.io.IOException, uk.ac.starlink.task.TaskException
java.io.IOException
uk.ac.starlink.task.TaskException
public static PlotExample[] createPlot2dExamples() throws uk.ac.starlink.task.TaskException, uk.ac.starlink.util.LoadException
uk.ac.starlink.task.TaskException
uk.ac.starlink.util.LoadException
public static PlotExample[] createPlot3dExamples() throws uk.ac.starlink.task.TaskException, uk.ac.starlink.util.LoadException
uk.ac.starlink.task.TaskException
uk.ac.starlink.util.LoadException
public static PlotExample[] createPlotHistExamples() throws uk.ac.starlink.task.TaskException, uk.ac.starlink.util.LoadException
uk.ac.starlink.task.TaskException
uk.ac.starlink.util.LoadException
public static void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.