Correlation.h

Go to the documentation of this file.

/*****************************************
 * This file is documented for Doxygen.
 * If you modify this file please update
 * the comments so that Doxygen will still
 * be able to work.
 ****************************************/
#ifndef CORRELATION_H
#define CORRELATION_H

#include <json.h>
#include <memory>
#include <string>
#include <vector>
#include <mutex>
#include <atomic>

namespace glasscore {

// forward declarations
class CSite;
class CSiteList;
class CHypo;

class CCorrelation {
 public:
    CCorrelation();

    CCorrelation(std::shared_ptr<CSite> correlationSite, double correlationTime,
                    std::string correlationIdString, std::string phase,
                    double orgTime, double orgLat, double orgLon, double orgZ,
                    double corrVal);

    CCorrelation(std::shared_ptr<json::Object> correlation,
                    CSiteList *pSiteList);

    ~CCorrelation();

    void clear();

    bool initialize(std::shared_ptr<CSite> correlationSite,
                    double correlationTime, std::string correlationIdString,
                    std::string phase, double orgTime, double orgLat,
                    double orgLon, double orgZ, double corrVal);

    void addHypoReference(std::shared_ptr<CHypo> hyp, bool force = false);

    void removeHypoReference(std::shared_ptr<CHypo> hyp);

    void removeHypoReference(std::string pid);

    void clearHypoReference();

    double getCorrelation() const;

    double getLatitude() const;

    double getLongitude() const;

    double getDepth() const;

    double getTOrigin() const;

    const std::shared_ptr<json::Object>& getJSONCorrelation() const;

    const std::shared_ptr<CHypo> getHypoReference() const;

    const std::shared_ptr<CSite> getSite() const;

    const std::string& getPhaseName() const;

    const std::string& getID() const;

    double getTCorrelation() const;

    double getTCreate() const;

 private:
    std::weak_ptr<CSite> m_wpSite;

    std::weak_ptr<CHypo> m_wpHypo;

    std::string m_sPhaseName;

    std::string m_sID;

    std::atomic<double> m_tCorrelation;

    std::atomic<double> m_tOrigin;

    std::atomic<double> m_dLatitude;

    std::atomic<double> m_dLongitude;

    std::atomic<double> m_dDepth;

    std::atomic<double> m_dCorrelation;

    std::atomic<double> m_tCreate;

    std::shared_ptr<json::Object> m_JSONCorrelation;

    mutable std::recursive_mutex m_CorrelationMutex;
};
}  // namespace glasscore
#endif  // CORRELATION_H