java.lang.Object
com.aquima.interactions.test.templates.AbstractReportingTemplate
com.aquima.interactions.test.templates.matching.RampTemplate

public class RampTemplate extends AbstractReportingTemplate
This template class may be used to initialize a ramp definition.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer
  • Constructor Details

    • RampTemplate

      public RampTemplate(String name)
      Constructs the ramp template with the name of the ramp.
      Parameters:
      name - The name of the ramp (function).
    • RampTemplate

      protected RampTemplate(com.aquima.interactions.foundation.report.InitializationReport report, String name)
  • Method Details

    • getName

      protected String getName()
    • getLowerPartial

      protected double getLowerPartial()
    • setLowerPartial

      public void setLowerPartial(double lowerPartial)
      This method may be used to set the lower partial of the ramp. The default value is zero.
      Parameters:
      lowerPartial - the lower partial of the ramp.
    • getLowerRange

      protected double getLowerRange()
    • setLowerRange

      public void setLowerRange(double lowerRange)
      This method may be used to set the lower range of the ramp. The default value is zero.
      Parameters:
      lowerRange - the lower range of the ramp.
    • getUpperRange

      protected double getUpperRange()
    • setUpperRange

      public void setUpperRange(double upperRange)
      This method may be used to set the upper range of the ramp. The default value is zero.
      Parameters:
      upperRange - the upper range of the ramp.
    • getUpperPartial

      protected double getUpperPartial()
    • setUpperPartial

      public void setUpperPartial(double upperPartial)
      This method may be used to set the upper partial of the ramp. The default value is zero.
      Parameters:
      upperPartial - the upper partial of the ramp.
    • isLeftOnly

      protected boolean isLeftOnly()
    • setLeftOnly

      public void setLeftOnly(boolean leftOnly)
      This method may be used to indicate the ramp is left-only. The default value is false.
      Parameters:
      leftOnly - Boolean indicating the ramp is left-only.
    • isRightOnly

      protected boolean isRightOnly()
    • setRightOnly

      public void setRightOnly(boolean rightOnly)
      This method may be used to indicate the ramp is right-only. The default value is false.
      Parameters:
      rightOnly - Boolean indicating the ramp is right-only.
    • isAbsolute

      protected boolean isAbsolute()
    • setAbsolute

      public void setAbsolute(boolean absolute)
      This method may be used to indicate the ramp is absolute. The default value is true.
      Parameters:
      absolute - Boolean indicating the ramp is absolute.
    • toDataSource

      public com.aquima.interactions.matching.ds.IRampDS toDataSource()
      This method converts the template to a data source that can be used to initialize the ramp definition.
      Returns:
      a data source that can be used to initialize the ramp definition.