include/AIDA/IMeasurement.h

0001 // -*- C++ -*-
0002 // AID-GENERATED
0003 // =========================================================================
0004 // This class was generated by AID - Abstract Interface Definition
0005 // DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
0006 // =========================================================================
0007 #ifndef AIDA_IMEASUREMENT_H
0008 #define AIDA_IMEASUREMENT_H 1
0009
0010 //  This file is part of the AIDA library
0011 //  Copyright (C) 2002 by the AIDA team.  All rights reserved.
0012 //  This library is free software and under the terms of the
0013 //  GNU Library General Public License described in the LGPL.txt
0014
0015 namespace AIDA {
0016
0017 /**
0018  * Basic user-level interface class for holding a single "measurement"
0019  * with positive and negative errors (to allow for asymmetric errors).
0020  * "IMeasurement" = "value" + "errorPlus" - "errorMinus"
0021  *
0022  * @author The AIDA team (http://aida.freehep.org/)
0023  *
0024  */
0025
0026 class IMeasurement {
0027
0028 public:
0029     /// Destructor.
0030     virtual ~IMeasurement() { /* nop */; }
0031
0032     /**
0033      * Get the value of the IMeasurement.
0034      * @return The value of the IMeasurement.
0035      *
0036      */
0037     virtual double value() const = 0;
0038
0039     /**
0040      * Get the plus error of the IMeasurement.
0041      * @return The plus error.
0042      *
0043      */
0044     virtual double errorPlus() const = 0;
0045
0046     /**
0047      * Get the minus error of the IMeasurement.
0048      * @return The minus error.
0049      *
0050      */
0051     virtual double errorMinus() const = 0;
0052
0053     /**
0054      * Set the value of the IMeasurement.
0055      * @param value The new value of the IMeasurement.
0056      * @return false If the value cannot be set.
0057      *
0058      */
0059     virtual bool setValue(double value) = 0;
0060
0061     /**
0062      * Set the plus error of the IMeasurement.
0063      * @param value The new plus error of the IMeasurement.
0064      * @return false If the error cannot be set or it is negative.
0065      *
0066      */
0067     virtual bool setErrorPlus(double errorPlus) = 0;
0068
0069     /**
0070      * Set the minus error of the IMeasurement.
0071      * @param value The new minus error of the IMeasurement.
0072      * @return false If the error cannot be set or it is negative.
0073      *
0074      */
0075     virtual bool setErrorMinus(double errorMinus) = 0;
0076 }; // class
0077 } // namespace AIDA
0078 #endif /* ifndef AIDA_IMEASUREMENT_H */