uk.ac.starlink.ttools.plottask

Class ShaderParameter

java.lang.Object

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

uk.ac.starlink.task.AbstractChoiceParameter<T,T>

uk.ac.starlink.task.ChoiceParameter<T>

uk.ac.starlink.ttools.plottask.StyleParameter<Shader>

uk.ac.starlink.ttools.plottask.ShaderParameter

public class ShaderParameter
extends StyleParameter<Shader>

Parameter for choosing Shader objects.

Since:

7 Aug 2008

Author:

Mark Taylor

Field Summary

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

BY_NAME

Constructor Summary

Constructors

Constructor and Description
ShaderParameter(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
static String[]	getDefaultValues(int count) Returns some suitable default values for a set of related ShaderParameters.
String	getName(Shader option) Converts an option value object to a string which is used to identify it as a string value of this parameter.
Shader	shaderValue(Environment env) Returns the value of this parameter as a Shader object.

Methods inherited from class uk.ac.starlink.ttools.plottask.StyleParameter

getOptionList, getUsage, setUsage, stringifyOption

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

objectToString, setDefaultOption, stringToObject

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

addOption, addOption, choiceToString, clearOptions, getOption, getOptionNames, getOptions, getOptionValueList, stringToChoice

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

clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, 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

ShaderParameter

public ShaderParameter(String name)

Constructor.

Parameters:

name - parameter name

Method Detail

shaderValue

public Shader shaderValue(Environment env)
                   throws TaskException

Returns the value of this parameter as a Shader object.

Parameters:

env - execution environment

Returns:

shader

Throws:

TaskException

getName

public String getName(Shader option)

Description copied from class: AbstractChoiceParameter

Converts an option value object to a string which is used to identify it as a string value of this parameter.

Overrides:

getName in class AbstractChoiceParameter<Shader,Shader>

Parameters:

option - option value

Returns:

string representation

getDefaultValues

public static String[] getDefaultValues(int count)

Returns some suitable default values for a set of related ShaderParameters.

Parameters:

count - number of parameters to get defaults for

Returns:

array of default values, one for each parameter