[seiscomp, scanloc] Install, add .gitignore

include/seiscomp/datamodel/realquantity.h

@@ -0,0 +1,154 @@
+/***************************************************************************
+ * Copyright (C) gempa GmbH                                                *
+ * All rights reserved.                                                    *
+ * Contact: gempa GmbH (seiscomp-dev@gempa.de)                             *
+ *                                                                         *
+ * GNU Affero General Public License Usage                                 *
+ * This file may be used under the terms of the GNU Affero                 *
+ * Public License version 3.0 as published by the Free Software Foundation *
+ * and appearing in the file LICENSE included in the packaging of this     *
+ * file. Please review the following information to ensure the GNU Affero  *
+ * Public License version 3.0 requirements will be met:                    *
+ * https://www.gnu.org/licenses/agpl-3.0.html.                             *
+ *                                                                         *
+ * Other Usage                                                             *
+ * Alternatively, this file may be used in accordance with the terms and   *
+ * conditions contained in a signed written agreement between you and      *
+ * gempa GmbH.                                                             *
+ ***************************************************************************/
+
+
+#ifndef SEISCOMP_DATAMODEL_REALQUANTITY_H
+#define SEISCOMP_DATAMODEL_REALQUANTITY_H
+
+
+#include <seiscomp/datamodel/realpdf1d.h>
+#include <seiscomp/core/baseobject.h>
+#include <seiscomp/core.h>
+#include <seiscomp/core/exceptions.h>
+
+
+namespace Seiscomp {
+namespace DataModel {
+
+
+DEFINE_SMARTPOINTER(RealQuantity);
+
+
+/**
+ * \brief Physical quantities expressed as floating point numbers are
+ * \brief represented by their
+ * \brief measured or computed values and optional values for
+ * \brief symmetric or upper
+ * \brief and lower uncertainties. The interpretation of these
+ * \brief uncertainties is
+ * \brief not defined in the standard. They can contain statistically
+ * \brief well-defined
+ * \brief error measures, but the mechanism can also be used to
+ * \brief simply describe a
+ * \brief possible value range. If the confidence level of the
+ * \brief uncertainty is known,
+ * \brief it can be listed in the optional attribute confidenceLevel.
+ * \brief Note that uncertainty, upperUncertainty, and
+ * \brief lowerUncertainty are given as absolute values of the
+ * \brief deviation
+ * \brief from the main value.
+ */
+class SC_SYSTEM_CORE_API RealQuantity : public Core::BaseObject {
+	DECLARE_SC_CLASS(RealQuantity)
+	DECLARE_SERIALIZATION;
+	DECLARE_METAOBJECT;
+
+	// ------------------------------------------------------------------
+	//  Xstruction
+	// ------------------------------------------------------------------
+	public:
+		//! Constructor
+		RealQuantity();
+
+		//! Copy constructor
+		RealQuantity(const RealQuantity& other);
+
+		//! Custom constructor
+		RealQuantity(double value,
+		             const OPT(double)& uncertainty = Seiscomp::Core::None,
+		             const OPT(double)& lowerUncertainty = Seiscomp::Core::None,
+		             const OPT(double)& upperUncertainty = Seiscomp::Core::None,
+		             const OPT(double)& confidenceLevel = Seiscomp::Core::None,
+		             const OPT(RealPDF1D)& pdf = Seiscomp::Core::None);
+
+		//! Destructor
+		~RealQuantity() override;
+	
+
+	// ------------------------------------------------------------------
+	//  Operators
+	// ------------------------------------------------------------------
+	public:
+		operator double&();
+		operator double() const;
+
+		//! Copies the metadata of other to this
+		RealQuantity& operator=(const RealQuantity& other);
+		//! Checks for equality of two objects. Child objects
+		//! are not part of the check.
+		bool operator==(const RealQuantity& other) const;
+		bool operator!=(const RealQuantity& other) const;
+
+		//! Wrapper that calls operator==
+		bool equal(const RealQuantity& other) const;
+
+
+	// ------------------------------------------------------------------
+	//  Setters/Getters
+	// ------------------------------------------------------------------
+	public:
+		//! Value of the quantity. The unit is implicitly defined and
+		//! depends on the context.
+		void setValue(double value);
+		double value() const;
+
+		//! Uncertainty as the absolute value of symmetric deviation
+		//! from the main value.
+		void setUncertainty(const OPT(double)& uncertainty);
+		double uncertainty() const;
+
+		//! Uncertainty as the absolute value of deviation from the
+		//! main value towards smaller values.
+		void setLowerUncertainty(const OPT(double)& lowerUncertainty);
+		double lowerUncertainty() const;
+
+		//! Uncertainty as the absolute value of deviation from the
+		//! main value towards larger values.
+		void setUpperUncertainty(const OPT(double)& upperUncertainty);
+		double upperUncertainty() const;
+
+		//! Confidence level of the uncertainty, given in percent.
+		void setConfidenceLevel(const OPT(double)& confidenceLevel);
+		double confidenceLevel() const;
+
+		//! Probability density function of the quantity.
+		void setPdf(const OPT(RealPDF1D)& pdf);
+		RealPDF1D& pdf();
+		const RealPDF1D& pdf() const;
+
+
+	// ------------------------------------------------------------------
+	//  Implementation
+	// ------------------------------------------------------------------
+	private:
+		// Attributes
+		double _value;
+		OPT(double) _uncertainty;
+		OPT(double) _lowerUncertainty;
+		OPT(double) _upperUncertainty;
+		OPT(double) _confidenceLevel;
+		OPT(RealPDF1D) _pdf;
+};
+
+
+}
+}
+
+
+#endif