Class FromDimensionsBase<T extends FeatureInputDimensions>

Object
AnchorBean<Feature<T>>
InitializableBean<Feature<T>, FeatureInitialization>
Feature<T>
FromDimensionsBase<T>
Type Parameters:
T - feature-input-type that extends FeatureInputDimensions
Direct Known Subclasses:
Area, ForSpecificAxis, Volume
public abstract class FromDimensionsBase<T extends FeatureInputDimensions> extends Feature<T>
Base class for features that are calculated from Dimensions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FromDimensionsBase()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    calculate(FeatureCalculationInput<T> input)
     
    protected abstract double
    calculateFromDimensions(Dimensions dimensions)
    Calculates a feature value from the given dimensions.
    Class<? extends FeatureInput>
    inputType()
     

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

    assignTo, beforeCalc, calculateCheckInitialized, castAs, createListChildFeatures, describeBean, describeParameters, descriptionLong, 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

    • FromDimensionsBase

      public FromDimensionsBase()

  • Method Details

    • calculate

      public double calculate(FeatureCalculationInput<T> input) throws FeatureCalculationException
      Specified by:
      calculate in class Feature<T extends FeatureInputDimensions>
      Throws:
      FeatureCalculationException

    • inputType

      public Class<? extends FeatureInput> inputType()
      Specified by:
      inputType in class Feature<T extends FeatureInputDimensions>

    • calculateFromDimensions

      protected abstract double calculateFromDimensions(Dimensions dimensions) throws FeatureCalculationException
      Calculates a feature value from the given dimensions.
      Parameters:
      dimensions - the Dimensions to calculate from
      Returns:
      the calculated feature value
      Throws:
      FeatureCalculationException - if the calculation fails