public class Plot2Example
extends java.lang.Object
Constructor and Description |
---|
Plot2Example(java.lang.String label,
uk.ac.starlink.ttools.build.Plot2Example.Context context,
uk.ac.starlink.ttools.build.Plot2Example.PlotTask task,
java.lang.String[] params)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Picture |
createPicture(java.lang.String[] extraParams)
Constructs an object giving this example's plot ready for output.
|
static java.util.Map<java.lang.String,java.lang.String> |
getExamplesXml()
Returns a map from the names of the known examples to
their XML invocation text.
|
java.lang.String |
getLabel()
Returns this example's name.
|
java.lang.String[] |
getLines()
Returns the lines representing the stilts command you would type
to execute this example.
|
java.lang.String[] |
getRequiredTableNames()
Returns the names of table files that must be in place for this
example to run.
|
java.lang.String |
getXml()
Returns XML text representing the stilts command you would type
to execute this example.
|
static void |
main(java.lang.String[] args)
Main method.
|
void |
testParams()
Tests that this example can execute, but does not run the
actual plotting code.
|
public Plot2Example(java.lang.String label, uk.ac.starlink.ttools.build.Plot2Example.Context context, uk.ac.starlink.ttools.build.Plot2Example.PlotTask task, java.lang.String[] params)
label
- name of examplecontext
- example execution contexttask
- the STILTS task used for the plotparams
- array of [*!]name=value pairs giving parameters;
a prepended "*" indicates emphasis;
a prepended "!" hides it from user view;
value
part may be enclosed in single quotes;
a null in the list signifies line break for formattingpublic java.lang.String getLabel()
public java.lang.String[] getLines()
public java.lang.String getXml()
public Picture createPicture(java.lang.String[] extraParams) throws java.io.IOException, uk.ac.starlink.task.TaskException, java.lang.InterruptedException, uk.ac.starlink.util.LoadException
extraParams
- additional name=value strings to apply
when doing the plotjava.io.IOException
uk.ac.starlink.task.TaskException
java.lang.InterruptedException
uk.ac.starlink.util.LoadException
public void testParams() throws java.lang.Exception
java.lang.Exception
public java.lang.String[] getRequiredTableNames()
public static java.util.Map<java.lang.String,java.lang.String> getExamplesXml()
public static void main(java.lang.String[] args) throws java.lang.Exception
Use the -help
flag for usage information.
java.lang.Exception
Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.