BMPPlantMgtFactory.h

Go to the documentation of this file.

/*!
 * \file BMPPlantMgtFactory.h
 * \brief Plant management operations factory
 * \author Liang-Jun Zhu
 * \date June 2016
 */
#ifndef SEIMS_BMP_PLANTMGT_H
#define SEIMS_BMP_PLANTMGT_H
 
#include "BMPFactory.h"
#include "PlantManagementOperation.h"
 
#include <set>
 
using namespace bmps;
using namespace plant_management;
using std::set;
 
namespace bmps {
/*!
 * \class bmps::BMPPlantMgtFactory
 * \brief Initiate a plant management BMP
 * Actually, it contains a series BMPs, such as plant, fertilize, harvest, etc.
 *
 */
class BMPPlantMgtFactory: public BMPFactory {
public:
    /// Constructor
    BMPPlantMgtFactory(int scenarioId, int bmpId, int subScenario,
                       int bmpType, int bmpPriority, vector<string>& distribution,
                       const string& collection, const string& location);
 
    /// Destructor
    ~BMPPlantMgtFactory();
 
    /// Load BMP parameters from MongoDB
    void loadBMP(MongoClient* conn, const string& bmpDBName) OVERRIDE;
 
    /// Output
    void Dump(ostream* fs) OVERRIDE;
 
    /// Set management fields data
    void setRasterData(map<string, IntRaster *>& sceneRsMap) OVERRIDE;
 
    /// Get management fields data
    int* GetRasterData() OVERRIDE;
 
    /// Get landuse / landcover ID
    int GetLUCCID();
 
    /// Get locations
    set<int>& GetLocations();
 
    /// Get operation sequence
    vector<int>& GetOperationSequence();
 
    /// Get operations
    map<int, PltMgtOp *>& GetOperations();
 
    /// Get operation by ID
    PltMgtOp* GetOperation(const int ID);
 
private:
    /// subSecenario name
    string m_name;
    /// management fields name, defined in 'distribution'
    string m_mgtFieldsName;
    /// management fields data (1D array raster)
    int* m_mgtFieldsRs;
    /// landuse / landcover
    int m_luccID;
    /// parameters
    FLTPT* m_parameters;
    /// field index for where to apply the subScenario. Using set instead of vector to accelerate find(). 
    set<int> m_location;
    /*!
     * The first element is the sequence number of plant management operations
     * and the second is the corresponding unique management code, i.e., index * 1000 + operationCode
     * m_bmpSequence[0] = 1002 means the first (1001 / 1000 = 1) operation is Irrigation (1002 % 1000 = 2)
     */
    vector<int> m_bmpSequence;
    /*!
     * Key is the unique management code in m_bmpSequence, e.g., 1002
     * Value is the corresponding PlantMangementOperation instance
     */
    map<int, PltMgtOp *> m_bmpPlantOps;
};
}
#endif /* SEIMS_BMP_PLANTMGT_H */