Node.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 NODE_H
#define NODE_H

#include <geo.h>
#include <vector>
#include <memory>
#include <string>
#include <utility>
#include <mutex>
#include <tuple>
#include <atomic>
#include <set>
#include "Link.h"

namespace glasscore {

// forward declarations
class CPick;
class CPickList;
class CSite;
class CWeb;
class CTrigger;

class CNode {
 public:
    CNode();

    CNode(std::string name, double lat, double lon, double z, double resolution,
            double maxDepth, bool aseismic);

    ~CNode();

    void clear();

    void clearSiteLinks();

    bool initialize(std::string name, double lat, double lon, double z,
                    double resolution, double maxDepth, bool aseismic);

    bool linkSite(std::shared_ptr<CSite> site, std::shared_ptr<CNode> node,
                    double distDeg, double travelTime1, std::string phase1,
                    double travelTime2 = -1, std::string phase2 = "");

    bool unlinkSite(std::shared_ptr<CSite> site);

    bool unlinkLastSite();

    std::shared_ptr<CTrigger> nucleate(double tOrigin, CPickList* parentThread);

    double getSignificance(double tObservedTT, double travelTime,
                            double distDeg);

    std::shared_ptr<CSite> getSite(std::string siteID);

    std::shared_ptr<CSite> getLastSite();

    void sortSiteLinks();

    std::string getSitesString();

    int getSiteLinksCount() const;

    bool getEnabled() const;

    void setEnabled(bool enabled);

    double getLatitude() const;

    double getLongitude() const;

    double getDepth() const;

    double getMaxDepth() const;

    bool getAseismic() const;

    glass3::util::Geo getGeo() const;

    double getResolution() const;

    CWeb* getWeb() const;

    void setWeb(CWeb* web);

    double getMaxSiteDistance() const;

    const std::string& getName() const;

    std::string getID() const;

    void addSource(std::string source);

 private:
    CWeb * m_pWeb;

    std::string m_sName;

    std::atomic<double> m_dLatitude;

    std::atomic<double> m_dLongitude;

    std::atomic<double> m_dDepth;

    std::atomic<double> m_dMaxDepth;

    std::atomic<bool> m_bAseismic;

    std::atomic<double> m_dMaxSiteDistance;

    std::atomic<double> m_dResolution;

    std::atomic<bool> m_bEnabled;

    std::set<std::string> m_SourceSet;

    std::vector<SiteLink> m_vSiteLinkList;

    mutable std::mutex m_SiteLinkListMutex;

    mutable std::recursive_mutex m_NodeMutex;

    // constants
    static constexpr double k_dTravelTimePickSelectionWindow = 120.0;

    static constexpr double k_dDepthShellResolutionKm = 100.0;

    static constexpr double k_dGridPointVsResolutionRatio = 0.7071;

    static constexpr double k_residualDistanceAllowanceFactor = 2.;
};
}  // namespace glasscore
#endif  // NODE_H