org.anchoranalysis.feature.bean.operator.Constant<T>

Type Parameters:: T - the input-type (even though it is irrelevant and ignored, but it keeps the class hierarchy consistent).

public class Constant<T extends FeatureInput>
extends FeatureGeneric<T>

A constant value that is entirely invariant to the feature-input.

Author:: Owen Feehan

Constructor Summary

Constructors
Constructor	Description
`Constant()`
`Constant(double value)`	Constructor with a particular value.
`Constant(String customName, double value)`	Constructor with a particular value and a custom-name.

Method Summary

Modifier and Type	Method	Description
`double`	`calculate(FeatureCalculationInput<T> input)`	Calculates a value for some input.
`String`	`describeParameters()`	A human-readable description of the parameterization of the bean.
`String`	`descriptionLong()`	A long human-readable description of the feature and some or all of its parameterization.
`double`	`getValue()`	The constant value.
`void`	`setValue(double value)`	The constant value.

Methods inherited from class org.anchoranalysis.feature.bean.operator.FeatureGeneric

inputType

Methods inherited from class org.anchoranalysis.feature.bean.Feature

assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, duplicateChangeName, getCustomName, getFriendlyName, onInitialization, setCustomName, toString

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- Constant
  
  public Constant(double value)
  
  Constructor with a particular value.
  
  Parameters:
  
  value - the value.
- Constant
  
  public Constant(String customName, double value)
  
  Constructor with a particular value and a custom-name.
  
  Parameters:
  
  customName - a custom-name for feature.
  
  value - the value.
- Constant
  
  public Constant()
Method Details
- calculate
  
  public double calculate(FeatureCalculationInput<T> input)
  
  Description copied from class: Feature
  
  Calculates a value for some input.
  
  Specified by:
  
  calculate in class Feature<T extends FeatureInput>
  
  Parameters:
  
  input - the input to the calculation.
  
  Returns:
  
  the result of the calculation.
- describeParameters
  
  public String describeParameters()
  
  Description copied from class: Feature
  
  A human-readable description of the parameterization of the bean.
  
  Overrides:
  
  describeParameters in class Feature<T extends FeatureInput>
  
  Returns:
  
  the description.
- descriptionLong
  
  public String descriptionLong()
  
  Description copied from class: Feature
  
  A long human-readable description of the feature and some or all of its parameterization.
  This can be overwritten to create an alternative description for features. By default string returned by Feature.describeBean() is used.
  
  Overrides:
  
  descriptionLong in class Feature<T extends FeatureInput>
  
  Returns:
  
  the description.
- getValue
  
  public double getValue()
  
  The constant value.
- setValue
  
  public void setValue(double value)
  
  The constant value.

Class Constant<T extends FeatureInput>