PickList.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 PICKLIST_H
#define PICKLIST_H

#include <threadbaseclass.h>

#include <json.h>
#include <set>
#include <vector>
#include <memory>
#include <string>
#include <utility>
#include <mutex>
#include <thread>
#include <queue>
#include <random>
#include <atomic>

#include "Glass.h"
#include "Pick.h"
#include "HypoList.h"

namespace glasscore {

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

struct PickCompare {
    bool operator()(const std::shared_ptr<CPick> &lhs,
                    const std::shared_ptr<CPick> &rhs) const {
        if (lhs->getTSort() < rhs->getTSort()) {
            return (true);
        }
        return (false);
    }
};

class CPickList : public glass3::util::ThreadBaseClass {
 public:
    explicit CPickList(int numThreads = 1, int sleepTime = 50,
                        int checkInterval = 300);

    ~CPickList();

    void clear() override;

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

    bool addPick(std::shared_ptr<json::Object> pick);

    std::shared_ptr<CPick> getDuplicate(double newTPick, std::string newSCNL,
                                        double tDuration);

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

    const CSiteList* getSiteList() const;

    void setSiteList(CSiteList* siteList);

    int getMaxAllowablePickCount() const;

    void setMaxAllowablePickCount(int pickMax);

    int getCountOfTotalPicksProcessed() const;

    int length() const;

    std::vector<std::weak_ptr<CPick>> getPicks(double t1, double t2);

    glass3::util::WorkState work() override;

 protected:
    void updatePosition(std::shared_ptr<CPick> pick);

    void eraseFromMultiset(std::shared_ptr<CPick> pick);

 private:
    CSiteList * m_pSiteList;

    int m_iMaxAllowablePickCount;

    int m_iCountOfTotalPicksProcessed;

    std::multiset<std::shared_ptr<CPick>, PickCompare> m_msPickList;

    std::queue<std::shared_ptr<json::Object>> m_qPicksToProcess;

    std::mutex m_PicksToProcessMutex;

    mutable std::recursive_mutex m_PickListMutex;

    std::shared_ptr<CPick> m_LowerValue;

    std::shared_ptr<CPick> m_UpperValue;

    // constants
    static const int k_nMaxAllowablePickCountDefault = 10000;

    static const int k_ProcessQueueMaximumSize = 1000;
};
}  // namespace glasscore
#endif  // PICKLIST_H