uk.ac.starlink.ttools.cone
Class TilingParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.ttools.cone.TilingParameter

public class TilingParameter
extends uk.ac.starlink.task.Parameter

Parameter for specifying SkyTiling values.

Since:
13 Dec 2007
Author:
Mark Taylor

Constructor Summary
TilingParameter(String name)
          Constructor.
 
Method Summary
 void setValueFromString(uk.ac.starlink.task.Environment env, String value)
           
 SkyTiling tilingValue(uk.ac.starlink.task.Environment env)
          Returns the value of this parameter as a SkyTiling object.
 
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, stringValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TilingParameter

public TilingParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

setValueFromString

public void setValueFromString(uk.ac.starlink.task.Environment env,
                               String value)
                        throws uk.ac.starlink.task.TaskException
Overrides:
setValueFromString in class uk.ac.starlink.task.Parameter
Throws:
uk.ac.starlink.task.TaskException

tilingValue

public SkyTiling tilingValue(uk.ac.starlink.task.Environment env)
                      throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a SkyTiling object.

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


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