CorrelationList.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 CORRELATIONLIST_H
#define CORRELATIONLIST_H

#include <json.h>
#include <memory>
#include <string>
#include <set>
#include <vector>
#include <utility>
#include <atomic>
#include "Correlation.h"

namespace glasscore {

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

struct CorrelationCompare {
    bool operator()(const std::shared_ptr<CCorrelation> &lhs,
                    const std::shared_ptr<CCorrelation> &rhs) const {
        if (lhs->getTCorrelation() < rhs->getTCorrelation()) {
            return (true);
        }
        return (false);
    }
};

class CCorrelationList {
 public:
    CCorrelationList();

    ~CCorrelationList();

    void clear();

    bool receiveExternalMessage(std::shared_ptr<json::Object> com);

    bool addCorrelationFromJSON(std::shared_ptr<json::Object> com);

    bool checkDuplicate(CCorrelation * newCorrelation, double tWindow,
                        double xWindow);

    bool scavenge(std::shared_ptr<CHypo> hyp, double tWindow = 2.5);

    const CSiteList* getSiteList() const;

    void setSiteList(CSiteList* siteList);

    int getMaxAllowableCorrelationCount() const;

    void setMaxAllowableCorrelationCount(int correlationMax);

    int getCountOfTotalCorrelationsProcessed() const;

    int length() const;

    std::vector<std::weak_ptr<CCorrelation>> getCorrelations(double t1,
                                                                double t2);

 private:
    CSiteList * m_pSiteList;

    std::atomic<int> m_iMaxAllowableCorrelationCount;

    std::atomic<int> m_iCountOfTotalCorrelationsProcessed;

    std::multiset<std::shared_ptr<CCorrelation>, CorrelationCompare> m_msCorrelationList;  // NOLINT

    mutable std::recursive_mutex m_CorrelationListMutex;

    static const int k_nMaxAllowableCorrelationCountDefault = 10000;
};
}   // namespace glasscore
#endif  // CORRELATIONLIST_H