uk.ac.starlink.ttools.task
Class InputTableParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.ttools.task.AbstractInputTableParameter
          extended by uk.ac.starlink.ttools.task.InputTableParameter

public class InputTableParameter
extends AbstractInputTableParameter

Parameter for specifying a single input table.

Author:
Mark Taylor

Constructor Summary
InputTableParameter(String name)
          Constructor.
 
Method Summary
 uk.ac.starlink.table.StarTable tableValue(uk.ac.starlink.task.Environment env)
          Returns the input table which has been selected by this parameter.
 
Methods inherited from class uk.ac.starlink.ttools.task.AbstractInputTableParameter
getFormatParameter, getStreamParameter, makeTable
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getUsage, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, setUsage, setValueFromString, stringValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

InputTableParameter

public InputTableParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

tableValue

public uk.ac.starlink.table.StarTable tableValue(uk.ac.starlink.task.Environment env)
                                          throws uk.ac.starlink.task.TaskException
Returns the input table which has been selected by this parameter.

Parameters:
env - execution environment
Throws:
uk.ac.starlink.task.TaskException


Copyright © 2009 Central Laboratory of the Research Councils. All Rights Reserved.