Measurement.h

Go to the documentation of this file.

/*!
 * \file Measurement.h
 * \brief Measurement class to store HydroClimate site data
 *
 * Changelog:
 *   - 1. 2016-05-30 - lj - Replace mongoc_client_t by MongoClient interface.
 *   - 2. 2022-08-18 - lj - Change float to FLTPT.
 *
 * \author Junzhi Liu, LiangJun Zhu
 * \version 2.1
 */
#ifndef SEIMS_MEASUREMENT_H
#define SEIMS_MEASUREMENT_H
 
#include <seims.h>
 
#include "db_mongoc.h"
 
using namespace ccgl;
using namespace db_mongoc;
 
/*!
 * \ingroup data
 * \class Measurement
 * \brief Get HydroClimate measurement data from MongoDB
 */
class Measurement: Interface {
public:
    /*!
     * \brief Initialize Measurement instance from MongoDB
     *
     * \param[in] conn \a MongoClient, MongoDB client
     * \param[in] hydroDBName \a string, HydroClimate database name
     * \param[in] sitesList \a string, sites list
     * \param[in] siteType \a string, sites type
     * \param[in] startTime \a time_t, start date time
     * \param[in] endTime \a time_t, end date time
     */
    Measurement(MongoClient* conn, const string& hydroDBName, const string& sitesList, const string& siteType,
                time_t startTime, time_t endTime);
 
    //! Destructor
    ~Measurement();
 
    //! Get site data by time
    virtual FLTPT* GetSiteDataByTime(time_t t) = 0;
 
    //! Get Number of site
    int NumberOfSites() const { return CVT_INT(m_siteIDList.size()); }
 
    //! Get HydroClimate site type, "M" or "P"
    string Type() const { return m_type; }
 
    //! start time
    time_t StartTime() const { return m_startTime; }
 
    //! end time
    time_t EndTime() const { return m_endTime; }
 
protected:
    //! MongoDB client object
    MongoClient* m_conn;
    //! HydroClimate database name
    string m_hydroDBName;
    //! Site IDs list
    vector<int> m_siteIDList;
    //! Site type, M means meteorology, and P means precipitation
    string m_type;
    //! Start time
    time_t m_startTime;
    //! End time
    time_t m_endTime;
    //! Measurement data of all sites in given date
    FLTPT* pData;
};
#endif /* SEIMS_MEASUREMENT_H */