FreeHEP API
Version 3.0

hep.aida
Interface IMeasurement


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"

Author:
The AIDA team (http://aida.freehep.org/)

Method Summary
 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

public double value()
Get the value of the IMeasurement.

Returns:
The value of the IMeasurement.

errorPlus

public double errorPlus()
Get the plus error of the IMeasurement.

Returns:
The plus error.

errorMinus

public double errorMinus()
Get the minus error of the IMeasurement.

Returns:
The minus error.

setValue

public void setValue(double value)
              throws IllegalArgumentException
Set the value of the IMeasurement.

Parameters:
value - The new value of the IMeasurement.
Throws:
IllegalArgumentException - If the value cannot be set.

setErrorPlus

public void setErrorPlus(double errorPlus)
                  throws IllegalArgumentException
Set the plus error of the IMeasurement.

Throws:
IllegalArgumentException - If the error cannot be set or it is negative.

setErrorMinus

public void setErrorMinus(double errorMinus)
                   throws IllegalArgumentException
Set the minus error of the IMeasurement.

Throws:
IllegalArgumentException - If the error cannot be set or it is negative.

FreeHEP API
Version 3.0

Copyright © 2000-2002 AIDA Team, All Rights Reserved.