uk.ac.starlink.ttools.cone

Class TilingParameter

java.lang.Object

uk.ac.starlink.task.Parameter<SkyTiling>

uk.ac.starlink.ttools.cone.TilingParameter

public class TilingParameter
extends Parameter<SkyTiling>

Parameter for specifying SkyTiling values.

Since:

13 Dec 2007

Author:

Mark Taylor

Field Summary

Fields inherited from class uk.ac.starlink.task.Parameter

BY_NAME

Constructor Summary

Constructors

Constructor and Description
TilingParameter(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	setHealpixNestDefault(int k) Sets the default value of this parameter to a HEALPix NEST instance of a given order.
SkyTiling	stringToObject(Environment env, String svalue) Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter.
SkyTiling	tilingValue(Environment env) Returns the value of this parameter as a SkyTiling object.

Methods inherited from class uk.ac.starlink.task.Parameter

clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, 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

stringToObject

public SkyTiling stringToObject(Environment env,
                                String svalue)
                         throws TaskException

Description copied from class: Parameter

Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter. This method also performs validation, so if the string value is unacceptable in any way, a ParameterValueException should be thrown.

It is an error to supply a null or empty string value.

If this method fails (throws a ParameterValueException) and if allowClassnameValue is set, then a subsequent attempt will be made to interpret the stringVal as the classname of a suitable class with a no-arg constructor.

Specified by:

stringToObject in class Parameter<SkyTiling>

Parameters:

env - execution environment; in most cases this is not required but for some purposes environment-specific characteristics may influence the result

svalue - non-null, non-empty string value

Returns:

typed value

Throws:

TaskException

tilingValue

public SkyTiling tilingValue(Environment env)
                      throws TaskException

Returns the value of this parameter as a SkyTiling object.

Parameters:

env - execution environment

Returns:

tiling value

Throws:

TaskException

setHealpixNestDefault

public void setHealpixNestDefault(int k)

Sets the default value of this parameter to a HEALPix NEST instance of a given order.

Parameters:

k - healpix order, or -1 for no default