seiscomp-training/include/seiscomp/datamodel/stationmagnitude.h

/***************************************************************************
 * 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_STATIONMAGNITUDE_H
#define SEISCOMP_DATAMODEL_STATIONMAGNITUDE_H


#include <string>
#include <seiscomp/datamodel/realquantity.h>
#include <seiscomp/datamodel/waveformstreamid.h>
#include <seiscomp/datamodel/creationinfo.h>
#include <vector>
#include <seiscomp/datamodel/comment.h>
#include <seiscomp/datamodel/notifier.h>
#include <seiscomp/datamodel/publicobject.h>
#include <seiscomp/core/exceptions.h>


namespace Seiscomp {
namespace DataModel {


DEFINE_SMARTPOINTER(StationMagnitude);
DEFINE_SMARTPOINTER(Comment);

class Origin;


/**
 * \brief This class describes the magnitude derived from a single
 * \brief waveform stream.
 */
class SC_SYSTEM_CORE_API StationMagnitude : public PublicObject {
	DECLARE_SC_CLASS(StationMagnitude)
	DECLARE_SERIALIZATION;
	DECLARE_METAOBJECT;

	// ------------------------------------------------------------------
	//  Xstruction
	// ------------------------------------------------------------------
	protected:
		//! Protected constructor
		StationMagnitude();

	public:
		//! Copy constructor
		StationMagnitude(const StationMagnitude& other);

		//! Constructor with publicID
		StationMagnitude(const std::string& publicID);

		//! Destructor
		~StationMagnitude() override;
	

	// ------------------------------------------------------------------
	//  Creators
	// ------------------------------------------------------------------
	public:
		static StationMagnitude* Create();
		static StationMagnitude* Create(const std::string& publicID);


	// ------------------------------------------------------------------
	//  Lookup
	// ------------------------------------------------------------------
	public:
		static StationMagnitude* Find(const std::string& publicID);


	// ------------------------------------------------------------------
	//  Operators
	// ------------------------------------------------------------------
	public:
		//! Copies the metadata of other to this
		//! No changes regarding child objects are made
		StationMagnitude& operator=(const StationMagnitude& other);
		//! Checks for equality of two objects. Child objects
		//! are not part of the check.
		bool operator==(const StationMagnitude& other) const;
		bool operator!=(const StationMagnitude& other) const;

		//! Wrapper that calls operator==
		bool equal(const StationMagnitude& other) const;


	// ------------------------------------------------------------------
	//  Setters/Getters
	// ------------------------------------------------------------------
	public:
		//! Reference to an origin's publicID if the StationMagnitude
		//! has an associated Origin.
		void setOriginID(const std::string& originID);
		const std::string& originID() const;

		//! Estimated magnitude as RealQuantity.
		void setMagnitude(const RealQuantity& magnitude);
		RealQuantity& magnitude();
		const RealQuantity& magnitude() const;

		//! See class Magnitude.
		void setType(const std::string& type);
		const std::string& type() const;

		//! Identifies the data source of the StationMagnitude. For
		//! magnitudes derived from amplitudes in
		//! waveforms (e. g., local magnitude ML ), amplitudeID points
		//! to publicID in class Amplitude.
		void setAmplitudeID(const std::string& amplitudeID);
		const std::string& amplitudeID() const;

		//! See class Magnitude.
		void setMethodID(const std::string& methodID);
		const std::string& methodID() const;

		//! Identifies the waveform stream. This element can be helpful
		//! if no
		//! amplitude is referenced, or the amplitude is not available
		//! in the
		//! context. Otherwise, it would duplicate the waveformID
		//! provided there
		//! and can be omitted.
		void setWaveformID(const OPT(WaveformStreamID)& waveformID);
		WaveformStreamID& waveformID();
		const WaveformStreamID& waveformID() const;

		//! An optional flag that indicates whether a station magnitude
		//! has passed
		//! the quality control or not. For example, if a station
		//! magnitude is
		//! out of the defined distance range but should be associated
		//! to a network
		//! magnitude for further analysis then this flag can be set to
		//! false.
		//! If the flag is not set, it defaults to true.
		void setPassedQC(const OPT(bool)& passedQC);
		bool passedQC() const;

		//! CreationInfo for the StationMagnitude object.
		void setCreationInfo(const OPT(CreationInfo)& creationInfo);
		CreationInfo& creationInfo();
		const CreationInfo& creationInfo() const;

	
	// ------------------------------------------------------------------
	//  Public interface
	// ------------------------------------------------------------------
	public:
		/**
		 * Add an object.
		 * @param obj The object pointer
		 * @return true The object has been added
		 * @return false The object has not been added
		 *               because it already exists in the list
		 *               or it already has another parent
		 */
		bool add(Comment* obj);

		/**
		 * Removes an object.
		 * @param obj The object pointer
		 * @return true The object has been removed
		 * @return false The object has not been removed
		 *               because it does not exist in the list
		 */
		bool remove(Comment* obj);

		/**
		 * Removes an object of a particular class.
		 * @param i The object index
		 * @return true The object has been removed
		 * @return false The index is out of bounds
		 */
		bool removeComment(size_t i);
		bool removeComment(const CommentIndex& i);

		//! Retrieve the number of objects of a particular class
		size_t commentCount() const;

		//! Index access
		//! @return The object at index i
		Comment* comment(size_t i) const;
		Comment* comment(const CommentIndex& i) const;

		//! Find an object by its unique attribute(s)

		Origin* origin() const;

		//! Implement Object interface
		bool assign(Object *other) override;
		bool attachTo(PublicObject *parent) override;
		bool detachFrom(PublicObject *parent) override;
		bool detach() override;

		//! Creates a clone
		Object *clone() const override;

		//! Implement PublicObject interface
		bool updateChild(Object *child) override;

		void accept(Visitor *visitor) override;


	// ------------------------------------------------------------------
	//  Implementation
	// ------------------------------------------------------------------
	private:
		// Attributes
		std::string _originID;
		RealQuantity _magnitude;
		std::string _type;
		std::string _amplitudeID;
		std::string _methodID;
		OPT(WaveformStreamID) _waveformID;
		OPT(bool) _passedQC;
		OPT(CreationInfo) _creationInfo;

		// Aggregations
		std::vector<CommentPtr> _comments;

	DECLARE_SC_CLASSFACTORY_FRIEND(StationMagnitude);
};


}
}


#endif