uk.ac.starlink.ttools.plottask
Class ShaderParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter
      extended by uk.ac.starlink.task.ChoiceParameter
          extended by uk.ac.starlink.ttools.plottask.StyleParameter
              extended by uk.ac.starlink.ttools.plottask.ShaderParameter

public class ShaderParameter
extends StyleParameter

Parameter for choosing Shader objects.

Since:
7 Aug 2008
Author:
Mark Taylor

Constructor Summary
ShaderParameter(String name)
          Constructor.
 
Method Summary
static String[] getDefaultValues(int count)
          Returns some suitable default values for a set of related ShaderParameters.
 String getName(Object option)
           
 Shader shaderValue(uk.ac.starlink.task.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
 
Methods inherited from class uk.ac.starlink.task.ChoiceParameter
addOption, addOption, getOption, getOptionNames, getOptions, objectValue, setDefaultOption, setValueFromString
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, stringValue, 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(uk.ac.starlink.task.Environment env)
                   throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a Shader object.

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

getName

public String getName(Object option)
Overrides:
getName in class StyleParameter

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


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