Documentation of 'hep.aida.IMeasurement' Java class
IMeasurement
hep.aida

Interface IMeasurement

  • All Known Implementing Classes:
    Measurement


    public interface IMeasurement
    Basic user-level interface class for holding a single "measurement" with positive and negative errors (to allow for asymmetric errors). "IMeasurement" = "value" + "errorPlus" - "errorMinus"
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      double errorMinus()
      Get the minus error of the IMeasurement.
      double errorPlus()
      Get the plus error of the IMeasurement.
      void setErrorMinus(double errorMinus)
      Set the minus error of the IMeasurement.
      void setErrorPlus(double errorPlus)
      Set the plus error of the IMeasurement.
      void setValue(double value)
      Set the value of the IMeasurement.
      double value()
      Get the value of the IMeasurement.
    • Method Detail

      • value

        double value()
        Get the value of the IMeasurement.
        Returns:
        The value of the IMeasurement.
      • errorPlus

        double errorPlus()
        Get the plus error of the IMeasurement.
        Returns:
        The plus error.
      • errorMinus

        double errorMinus()
        Get the minus error of the IMeasurement.
        Returns:
        The minus error.
      • setValue

        void setValue(double value)
               throws java.lang.IllegalArgumentException
        Set the value of the IMeasurement.
        Parameters:
        value - The new value of the IMeasurement.
        Throws:
        java.lang.IllegalArgumentException - If the value cannot be set.
      • setErrorPlus

        void setErrorPlus(double errorPlus)
                   throws java.lang.IllegalArgumentException
        Set the plus error of the IMeasurement.
        Parameters:
        value - The new plus error of the IMeasurement.
        Throws:
        java.lang.IllegalArgumentException - If the error cannot be set or it is negative.
      • setErrorMinus

        void setErrorMinus(double errorMinus)
                    throws java.lang.IllegalArgumentException
        Set the minus error of the IMeasurement.
        Parameters:
        value - The new minus error of the IMeasurement.
        Throws:
        java.lang.IllegalArgumentException - If the error cannot be set or it is negative.

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.