RegData.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2006-2008 by Antonello Lobianco                         *
 *   http://regmas.org                                                     *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef REGDATA_H
#define REGDATA_H

// Core C++ headers
#include <string>
#include <vector>
#include <map>
#include <stdexcept>
#include <iostream>
#include <sstream>

// Qt headers...
#include <QString>

// RegMAS headers...
#include "BaseRegmas.h"
//#include "InputDocument.h"
#include "InputNode.h"

using namespace std;

struct IFiles;
struct BasicData;
class  LLData;
struct VectorSettings;
class  RegActivities;
struct RegResources;
class  ModelObject;
//class InputDocument;
//class InputNode;


class RegData: public BaseRegmas{

public:
                        RegData(ThreadManager* MTHREAD_h);
                       ~RegData();
    

    void                loadInput();
    vector<string>      getScenarios();
    int                 getScenarioIndex();
    bool                delDir(QString dirname); 
    void                setDefaultSettings();
    void                setScenarioSettings();
    void                setResources();
    void                setDefaultActivities();
    void                setScenarioActivities();
    void                setObjectsDefinitions();
    void                initializeResourcesObjectsMatch(); 
    void                setSpace(); 
    void                initializeSpacialObjectsMatch();
    void                debug();

    vector <ModelObject> getBestMatchingInitialObjects (string resourceName_h, double resourceQ_h);
    string              getOutputDirectory() const {return outputDirname;};
    string              getFilenameByType(string type_h);
    LLData              getTable(string tableName_h, int debugLevel=MSG_CRITICAL_ERROR);
    vector <IFiles>     getIFilesVector() const {return iFilesVector;};
    string              getBaseDirectory() const {return baseDirectory;};
    int                 getActivitiesDefinitionVectorSize() const {return activitiesDefinitionVector.size();};

    vector <string>     getResourceNames(int type_h=-1) const; 
    int                 getResourceSize(int type_h=-1) const; 
    vector <string>     getObjectNames() const;
    vector <string>     getActivityNames() const;
    int                 getActGisCodeByName(string actName_h) const;

    int                 getIntSetting          (const string &name_h, int position=0);
    double              getDoubleSetting       (const string &name_h, int position=0);
    string              getStringSetting       (const string &name_h, int position=0);
    bool                getBoolSetting         (const string &name_h, int position=0);
    vector <int>        getIntVectorSetting    (const string &name_h);
    vector <double>     getDoubleVectorSetting (const string &name_h);
    vector <string>     getStringVectorSetting (const string &name_h);
    vector <bool>       getBoolVectorSetting   (const string &name_h);

    RegResources        getResourceByName(string name_h);
    ModelObject         getObjectByName(string name_h);
    vector<RegActivities*> getRegActivities();
    RegActivities*      getRegActivityByName(string name_h);
    vector <ModelObject*>  getObjectsDefinitionVector();

    vector <ModelObject> getModelObjectsBySoilType(int soilType_h);

    void                setOutputDirectory(const char* output_dirname_h);
    void                setBaseDiretory(string baseDirectory_h){baseDirectory=baseDirectory_h;};
    void                addSetting(string name_h, vector <string> values_h, int type_h, string comment_h);
    void                addSetting(string name_h, string value_h, int type_h, string comment_h);

    void                setBasicData(const string &name_h, int value, int position=0);
    void                setBasicData(const string &name_h, double value, int position=0);
    void                setBasicData(const string &name_h, string value, int position=0);
    void                setBasicData(const string &name_h, bool value, int position=0);

private:
    string              getBaseData (const string &name_h, int type_h, int position=0);
    vector <string>     getVectorBaseData (const string &name_h, int type_h);
    void                setBasicData(const string &name_h, string value, int type_h, int position);

    string                                   inputFilename; // from Qt fileOpen dialog
    string                                   outputDirname; // from main config files
    string                                   baseDirectory; // from Qt fileOpen dialog

    // In the following vectors, when it is stated "just the topology", it means here we have just the definition of the objects, but the values may change at the agent-level. Thi is why each agent hads a "personal copy" of them
    vector <IFiles>                           iFilesVector;  
    vector <BasicData>               programSettingsVector;  
    vector <RegResources>        resourcesDefinitionVector;  
    vector <RegActivities>      activitiesDefinitionVector;  
    vector <ModelObject>           objectsDefinitionVector;  
    vector <LLData>                           LLDataVector;  

    vector <vector <string> >       resourcesJoinedObjects;  
    vector <vector <double> >  resourcesProvidedQuantities;  

    vector <vector <ModelObject> > availableObjectsBySoilType;
    InputNode                             mainDocument;  
    //InputNode                                     mainNode;  ///< the main input node
};


//Changed from a class to a structure on 2006.10.17.
struct IFiles {
    string                                       directory;
    string                                            type;
    string                                            name;
    string                                         comment;
};


struct BasicData {
    string                                            name;
    vector <string>                                 values;
    int                                               type; // enum TYPE_*
    string                                         comment;
};



struct RegResources {
    string                                            name;
    string                                            unit;
    string                                         comment;
    int                                             source;
    int                                               type;
    string                                         subType;
};


class RegActivities: public BaseRegmas{
public:
                        RegActivities(ThreadManager* MTHREAD_h);
                       ~RegActivities();

    string              getName() const {return activityName;};
    string              getComment() const {return activityComment;};
    double              getMatrixGrossMargin() const; //todo:get the current one!
    map <string, double> getMatrixActRes() const; 
    vector <double>     getMatrixCoefficients(); 
    double              getMatrixCoefficientByName(string cname_h); 

    bool                getSpatiallyExplicit(){return spatiallyExplicit;};
    vector <int>        getRequiredLandUseCodes(){return requiredLandUseCodes;};
    string              getRequiredObjectOnPlot(){return requiredObjectOnPlot;};
    int                 getMapCode() const {return mapCode;};
    int                 getMapRColor(){return mapRColor;};
    int                 getMapGColor(){return mapGColor;};
    int                 getMapBColor(){return mapBColor;};
    double              getDecouplingOption(int premiumIndex);
    void                setName(string activityName_h){activityName=activityName_h;};
    void                setComment(string activityComment_h){activityComment=activityComment_h;};
    friend void RegData::setDefaultActivities();
    friend void RegData::setScenarioActivities();

private:
    string                          activityName;
    string                       activityComment;
    vector<double>       matrixGrossMarginByYear;
    vector< map<string,double> > matrixActResByYear;
    vector<int>             requiredLandUseCodes; 
    string                 requiredObjectOnPlot; 
    bool                       spatiallyExplicit;
    int                                  mapCode;    
    int                                mapRColor;  
    int                                mapGColor;  
    int                                mapBColor;  
    vector< vector<double> >             decouplingOptions;  

};

class LLData: public BaseRegmas{

public:
                        LLData(ThreadManager* MTHREAD_h, string tableName_h);
                       ~LLData();
    void                clean(); // clean the data from empty headers
    string              getTableName(){return tableName;};
    int                 nrecords(){return records.size();};
    string              getData(int pos_h, string header_h, int debugLevel=MSG_CRITICAL_ERROR);
    friend void RegData::loadInput();

private:
    string                             tableName;
    vector<string>                       headers;
    vector < vector <string> >           records;

};


#endif