|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.build.PlotExample
public class PlotExample
Programmatically generates example text and images for STILTS plotting tasks. Used in generating the documentation.
Constructor Summary | |
---|---|
PlotExample(String name,
String taskName,
String[] params,
String[] comments)
Constructor. |
Method Summary | |
---|---|
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(String[] args)
Writes example files ready for incorporation into documentation. |
String |
writeImage()
Generates and outputs the image file showing the result of this example. |
void |
writeXml(PrintStream out)
Outputs the XML for this example as a <dt><dd> element pair. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PlotExample(String name, String taskName, String[] params, String[] comments) throws TaskException, 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>
elements
TaskException
LoadException
Method Detail |
---|
public void writeXml(PrintStream out) throws IOException
out
- destination stream
IOException
public String writeImage() throws IOException, TaskException
IOException
TaskException
public static PlotExample[] createPlot2dExamples() throws TaskException, LoadException
TaskException
LoadException
public static PlotExample[] createPlot3dExamples() throws TaskException, LoadException
TaskException
LoadException
public static PlotExample[] createPlotHistExamples() throws TaskException, LoadException
TaskException
LoadException
public static void main(String[] args) throws Exception
Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |