org.graffiti.plugin.parameter
Class ProbabilityParameter

java.lang.Object
  extended by org.graffiti.plugin.parameter.AbstractSingleParameter<T>
      extended by org.graffiti.plugin.parameter.AbstractLimitableParameter<Double>
          extended by org.graffiti.plugin.parameter.ProbabilityParameter
All Implemented Interfaces:
Serializable, Displayable<Double>, LimitableParameter<Double>, Parameter<Double>, SingleParameter<Double>

public class ProbabilityParameter
extends AbstractLimitableParameter<Double>

Represents a probability parameter. This parameter's value is between 0.0 and 1.0.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.graffiti.plugin.parameter.AbstractLimitableParameter
max, min, sliderMax, sliderMin
 
Constructor Summary
ProbabilityParameter(double val, String name, String description)
          Creates a ProbabilityParameter.
ProbabilityParameter(String name, String description)
          Creates a ProbabilityParameter.
 
Method Summary
 Double getProbability()
          Returns the value of this parameter as a Double.
 void setProbability(Double val)
          Sets the value of this parameter as a Double.
 
Methods inherited from class org.graffiti.plugin.parameter.AbstractLimitableParameter
getMax, getMin, getSliderMax, getSliderMin, isValid, toXMLString
 
Methods inherited from class org.graffiti.plugin.parameter.AbstractSingleParameter
canCopy, copy, getDependencyParent, getDependencyValue, getDescription, getImage, getName, getStandardXML, getValue, isVisible, setDependency, setDescription, setObjectValue, setValue, setVisible, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.graffiti.plugin.parameter.Parameter
canCopy, copy, getDependencyParent, getDependencyValue, getImage, isVisible, setDependency, setObjectValue, setVisible
 
Methods inherited from interface org.graffiti.plugin.Displayable
getDescription, getName, getValue, setDescription, setValue
 

Constructor Detail

ProbabilityParameter

public ProbabilityParameter(String name,
                            String description)
Creates a ProbabilityParameter.

Parameters:
name - The parameter's name.
description - The parameter's description.

ProbabilityParameter

public ProbabilityParameter(double val,
                            String name,
                            String description)
Creates a ProbabilityParameter.

Parameters:
val - The parameter's value.
name - The parameter's name.
description - The parameter's description.
Method Detail

setProbability

public void setProbability(Double val)
Sets the value of this parameter as a Double.

Parameters:
val - The value to set in this parameter.

getProbability

public Double getProbability()
Returns the value of this parameter as a Double.

Returns:
the value of this parameter as a Double.


Generated at 2012-05-30 11:00:36 PM CEST