1 |
// -*- C++ -*- |
2 |
// AID-GENERATED |
3 |
// ========================================================================= |
4 |
// This class was generated by AID - Abstract Interface Definition |
5 |
// DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it. |
6 |
// ========================================================================= |
7 |
#ifndef AIDA_IMEASUREMENT_H |
8 |
#define AIDA_IMEASUREMENT_H 1 |
9 |
|
10 |
// This file is part of the AIDA library |
11 |
// Copyright (C) 2002 by the AIDA team. All rights reserved. |
12 |
// This library is free software and under the terms of the |
13 |
// GNU Library General Public License described in the LGPL.txt |
14 |
|
15 |
namespace AIDA { |
16 |
|
17 |
/** |
18 |
* Basic user-level interface class for holding a single "measurement" |
19 |
* with positive and negative errors (to allow for asymmetric errors). |
20 |
* "IMeasurement" = "value" + "errorPlus" - "errorMinus" |
21 |
* |
22 |
* @author The AIDA team (http://aida.freehep.org/) |
23 |
* |
24 |
*/ |
25 |
|
26 |
class IMeasurement { |
27 |
|
28 |
public: |
29 |
/// Destructor. |
30 |
virtual ~IMeasurement() { /* nop */; } |
31 |
|
32 |
/** |
33 |
* Get the value of the IMeasurement. |
34 |
* @return The value of the IMeasurement. |
35 |
* |
36 |
*/ |
37 |
virtual double value() const = 0; |
38 |
|
39 |
/** |
40 |
* Get the plus error of the IMeasurement. |
41 |
* @return The plus error. |
42 |
* |
43 |
*/ |
44 |
virtual double errorPlus() const = 0; |
45 |
|
46 |
/** |
47 |
* Get the minus error of the IMeasurement. |
48 |
* @return The minus error. |
49 |
* |
50 |
*/ |
51 |
virtual double errorMinus() const = 0; |
52 |
|
53 |
/** |
54 |
* Set the value of the IMeasurement. |
55 |
* @param value The new value of the IMeasurement. |
56 |
* @return false If the value cannot be set. |
57 |
* |
58 |
*/ |
59 |
virtual bool setValue(double value) = 0; |
60 |
|
61 |
/** |
62 |
* Set the plus error of the IMeasurement. |
63 |
* @param value The new plus error of the IMeasurement. |
64 |
* @return false If the error cannot be set or it is negative. |
65 |
* |
66 |
*/ |
67 |
virtual bool setErrorPlus(double errorPlus) = 0; |
68 |
|
69 |
/** |
70 |
* Set the minus error of the IMeasurement. |
71 |
* @param value The new minus error of the IMeasurement. |
72 |
* @return false If the error cannot be set or it is negative. |
73 |
* |
74 |
*/ |
75 |
virtual bool setErrorMinus(double errorMinus) = 0; |
76 |
}; // class |
77 |
} // namespace AIDA |
78 |
#endif /* ifndef AIDA_IMEASUREMENT_H */ |