Regional data, including macros and settings. More...

#include <ModelData.h>

Inheritance diagram for ModelData:

Collaboration diagram for ModelData:

[legend]

Public Member Functions
	ModelData (ThreadManager *MTHREAD_h)

	~ModelData ()

void	loadInput ()
	Unzip the OpenOffice input file (NEW 2008.05.13)

LLData	getTableFromFile (string tablename, string filename_h)
	Load and return a data table from a file (instead that from a spreadsheet sheet)

vector< string >	getScenarios ()

int	getScenarioIndex ()

bool	delDir (QString dirname)
	Recursivelly delete a directory.

void	setScenarioData ()
	Set the infos about this scenario (long description and overriding tables)

void	setDefaultSettings ()

void	setScenarioSettings ()

void	createRegions ()

void	setDefaultForData ()

void	setScenarioForData ()

void	setDefaultProdData ()

void	setScenarioProdData ()

void	setDefaultProductResourceMatrixLink ()

void	setScenarioProductResourceMatrixLink ()

void	setForestTypes ()

void	setReclassificationRules ()

void	setDefaultPathogenRules ()

void	setScenarioPathogenRules ()

void	applyOverrides ()
	Cancel all reg1 level data and trasform them in reg2 level if not already existing.

void	applyDebugMode ()
	Works only a specified subset of regions and products.

void	setSpace ()

string	getOutputDirectory () const
	Return a vector of objects that together provide the specified resource in the specified quantity.

int	getFilenamesByDir (const string &dir, vector< string > &files, const string &filter="")
	Return a list of files in a directory.

string	getFilenameByType (string type_h)

LLData	getTable (string tableName_h, int debugLevel=MSG_CRITICAL_ERROR)

vector< IFiles >	getIFilesVector () const

string	getBaseDirectory () const

ModelRegion *	getRegion (int regId_h)

bool	regionExist (const int &regId_h) const

vector< ModelRegion * >	getAllRegions (bool excludeResidual=true)

vector< int >	getRegionIds (int level_h, bool excludeResidual=true)

vector< vector< int > >	getRegionIds (bool excludeResidual=true)

string	regId2RegSName (const int &regId_h) const

int	regSName2RegId (const string &regSName_h) const

int	getNForTypes ()

int	getNReclRules ()

forType *	getForType (int position)

forType *	getForType (string &forTypeId_h)

int	getForTypeCounter (string &forTypeId_h, bool all=false)
	By default it doesn't return forTypes used only as input.

vector< string >	getForTypeIds (bool all=false)
	By default it doesn't return forTypes used only as input.

string	getForTypeParentId (const string &forTypeId_h)

vector< string >	getForTypeChilds (const string &forTypeId_h)

vector< int >	getForTypeChilds_pos (const string &forTypeId_h, bool all=false)

vector< string >	getForTypeParents ()

int	getNForTypesChilds (const string &forTypeId_h)

reclRule *	getReclRule (int position)

vector< string >	getDiameterClasses (bool productionOnly=false)

const bool	assessProdPossibility (const string &prod_h, const string &forType_h, const string &dClass_h)
	A simple function to assess if a specified product can be made by a certain forest type and diameter class.

const int	getMaxYearUsableDeathTimber (const string &prod_h, const string &forType_h, const string &dClass_h)

const int	getMaxYearUsableDeathTimber ()

void	setErrorLevel (int errorLevel_h)

int	getErrorLevel ()

bool	getTempBool ()

void	setTempBool (bool tempBool_h)

bool	getValueFoundBool ()

void	setValueFoundBool (bool valueFoundBool_h)

vector< vector< int > >	createCombinationsVector (const int &nItems)
	Return a vector containing any possible combination of nItems items (including any possible subset). The returned vector has in each slot the items present in that specific combination.

double	getTimedData (const vector< double > &dated_vector, const int &year_h) const
	Return the value for the specified year in a timelly ordered vector, taking the last value if this is smaller than the required position.

void	setTimedData (const double &value_h, vector< double > &dated_vector, const int &year_h, const int &MSG_LEVEL=MSG_WARNING)

int	getIntSetting (const string &name_h, int position=0, int reg=WORLD) const

double	getDoubleSetting (const string &name_h, int position=0, int reg=WORLD) const

string	getStringSetting (const string &name_h, int position=0, int reg=WORLD) const

bool	getBoolSetting (const string &name_h, int position=0, int reg=WORLD) const

vector< int >	getIntVectorSetting (const string &name_h, int reg=WORLD) const

vector< double >	getDoubleVectorSetting (const string &name_h, int reg=WORLD) const

vector< string >	getStringVectorSetting (const string &name_h, int reg=WORLD) const

vector< bool >	getBoolVectorSetting (const string &name_h, int reg=WORLD) const

const double	getProdData (const string &type_h, const int &regId_h, const string &prodId_h, const int &year=DATA_NOW, const string &freeDim_h="")

const double	getForData (const string &type_h, const int &regId_h, const string &forType_h, const string &freeDim_h, const int &year=DATA_NOW)

void	setProdData (const double &value_h, const string &type_h, const int &regId_h, const string &prodId_h, const int &year=DATA_NOW, const bool &allowCreate=false, const string &freeDim_h="")

void	setForData (const double &value_h, const string &type_h, const int &regId_h, const string &forType_h, const string &freeDim_h, const int &year=DATA_NOW, const bool &allowCreate=false)

string	makeKeyProdData (const string &parName, const string &regId, const string &prod, const string &freeDim="") const

string	makeKeyForData (const string &parName, const string &regId, const string &forType, const string &diamClass) const

void	unpackKeyProdData (const string &key, string &parName, int &regId, string &prod, string &freeDim) const

void	unpackKeyForData (const string &key, string &parName, int &regId, string &forType, string &diamClass) const

vector< pathRule * >	getPathMortalityRule (const string &forType, const string &dC)
	Return the pathogen mortality rule(s) associated with a given ft and dc (plural as more than a single pathogen could be found)

double	calculateAnnualisedEquivalent (const double &amount_h, const int &years_h, const double &ir) const
	Calculate the annual equivalent flow.

double	calculateAnnualisedEquivalent (const double &amount_h, const double &years_h, const double &ir) const
	Transform the double to the highest integer and call calculateAnnualisedEquivalent(double amount_h, int years_h)

void	setOutputDirectory (const char *output_dirname_h)

void	setBaseDiretory (string 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	cacheSettings ()
	Called after input reading, it fix frequently used data;.

int	getCachedInitialYear ()

void	deathTimberInventory_incrOrAdd (const iisskey &thekey, double value_h)

void	deathTimberInventory_incr (const iisskey &thekey, double value_h)

double	deathTimberInventory_get (const iisskey &thekey)

map< iisskey, double > *	getDeathTimberInventory ()

double	getAvailableDeathTimber (const vector< string > &primProd_h, int regId_h, int year_h)
	Returns the timber available for a given set of primary products as stored in the deathTimberInventory map.

double	getAvailableAliveTimber (const vector< string > &primProd_h, int regId_h)
	Returns the timber available for a given set of primary products as stored in the px->vol_l vector.

vector< int >	getAllocableProductIdsFromDeathTimber (const int &regId_h, const string &ft, const string &dc, const int &harvesting_year, int request_year=DATA_NOW)
	Returns the ids of the primary products that is possible to obtain using the timber recorded death in the specific year, ft, dc combination.

Public Member Functions inherited from BaseClass
	BaseClass ()

	~BaseClass ()

void	msgOut (const int &msgCode_h, const string &msg_h, const bool &refreshGUI_h=true) const
	Overloaded function to print the output log.

void	msgOut (const int &msgCode_h, const int &msg_h, const bool &refreshGUI_h=true) const
	Overloaded function to print the output log.

void	msgOut (const int &msgCode_h, const double &msg_h, const bool &refreshGUI_h=true) const
	Overloaded function to print the output log.

int	s2i (const string &string_h) const
	string to integer conversion

double	s2d (const string &string_h) const
	string to double conversion

double	s2d (const string &string_h, const bool &replaceComma) const
	string to double conversion

bool	s2b (const string &string_h) const
	string to bool conversion

string	i2s (const int &int_h) const
	integer to string conversion

string	d2s (const double &double_h) const
	double to string conversion

string	b2s (const bool &bool_h) const
	bool to string conversion

vector< int >	s2i (const vector< string > &string_h) const
	string to integer conversion (vector)

vector< double >	s2d (const vector< string > &string_h, const bool &replaceComma=false) const
	string to double conversion (vector)

vector< bool >	s2b (const vector< string > &string_h) const
	string to bool conversion (vector)

vector< string >	i2s (const vector< int > &int_h) const
	integer to string conversion (vector)

vector< string >	d2s (const vector< double > &double_h) const
	double to string conversion (vector)

vector< string >	b2s (const vector< bool > &bool_h) const
	bool to string conversion (vector)

int	getType (const string &type_h) const
	Return a type according to enum TYPE_* from a string (eg: "string" -> TYPE_STRING (2))

void	refreshGUI () const
	Ping to periodically return the control to the GUI.

template<typename T >
string	toString (const T &x) const

template<typename T >
T	stringTo (const std::string &s) const

int	vSum (const vector< int > &vector_h) const

double	vSum (const vector< double > &vector_h) const

int	vSum (const vector< vector< int > > &vector_h) const

double	vSum (const vector< vector< double > > &vector_h) const

void	tokenize (const string &str, vector< string > &tokens, const string &delimiter=" ") const
	Tokenize a string using a delimiter (default is space)

void	untokenize (string &str, vector< string > &tokens, const string &delimiter=" ") const

template<typename K , typename V >
V	findMap (const map< K, V > &mymap, const K &key, const int &error_level=MSG_CRITICAL_ERROR, const V &notFoundValue=numeric_limits< V >::min()) const
	Lookup a map for a value. Return the value starting from the key.

template<typename K , typename V >
void	changeMapValue (map< K, V > &mymap, const K &key, const V &value, const int &error_level=MSG_CRITICAL_ERROR)
	Change the value stored in a map given the key and the new value.

template<typename K , typename V >
void	incrMapValue (map< K, V > &mymap, const K &key, const V &value, const int &error_level=MSG_CRITICAL_ERROR)
	Increments a value stored in a map of the specified value, given the key.

template<typename K , typename V >
void	incrOrAddMapValue (map< K, V > &mymap, const K &key, const V &value)
	Increments a value stored in a map of the specified value, given the key.

template<typename K , typename V >
void	resetMapValues (map< K, V > &mymap, const V &value)
	Reset all values stored in a map to the specified one.

template<typename K , typename V >
map< K, V >	vectorToMap (const vector< K > &keys, const V &value=0.0)
	Returns a map built using the given vector and the given (scalar) value as keys/values pairs.

template<typename T >
vector< T >	positionsToContent (const vector< T > &vector_h, const vector< int > &positions)
	Return a vector of content from a vector and a vector of positions (int)

template<typename V >
void	debugMap (const map< iisskey, V > &mymap)
	Debug a map.

template<typename K , typename V >
void	debugMap (const map< K, V > &mymap, const K &key)

template<typename K >
int	getMaxPos (const vector< K > &v)
	Returns the position of the maximum element in the vector (the last one in case of multiple equivalent maxima)

template<typename K >
int	getMinPos (const vector< K > &v)
	Returns the position of the minimum element in the vector (the first one in case of multiple equivalent minima)

template<typename K >
K	getMax (const vector< K > &v)
	Returns the value of the maximum element in the vector (the last one in case of multiple equivalent maxima)

template<typename K >
K	getMin (const vector< K > &v)
	Returns the value of the minimum element in the vector (the first one in case of multiple equivalent minima)

template<typename K >
double	getAvg (const vector< K > &v)
	Returns the average of the elements in the vector.

template<typename K >
double	getSd (const vector< K > &v, bool sample=true)

template<typename K >
int	getPos (const K &element, const vector< K > &v, const int &msgCode_h=MSG_CRITICAL_ERROR)

template<typename K >
bool	inVector (const K &element, const vector< K > &v)

double	normSample (const double &avg, const double &stdev, const double &minval=NULL, const double &maxval=NULL) const
	Sample from a normal distribution with bounds. Slower (double time, but still you see the diff only after milion of loops).

template<typename K >
K	normSample (normal_distribution< K > &d, std::mt19937 &gen, const K &minval=NULL, const K &maxval=NULL) const
	Sample from a normal distribution with bounds. Faster (half time) as the normal_distribution is made only once.

template<typename T >
std::string	toString (const T &x) const

Public Attributes
scenarioData	scenario

Private Member Functions
string	getBaseData (const string &name_h, int type_h, int position=0, int regId_h=WORLD)

vector< string >	getVectorBaseData (const string &name_h, int type_h, int regId_h=WORLD)

bool	dataMapCheckExist (const DataMap &map, const string &search_for, const bool &exactMatch=true) const

double	dataMapGetValue (const DataMap &map, const string &search_for, const int &year_h, const bool &exactMatch=true)

int	dataMapSetValue (DataMap &map, const string &search_for, const double &value_h, const int &year_h, const bool &exactMatch=true)

Private Attributes
string	inputFilename

string	outputDirname

string	baseDirectory

map< string, vector< double > >	forDataMap
	Forestry data.

map< string, vector< double > >	prodDataMap
	Product data.

vector< forToProd >	forToProdVector
	Vector of coefficients from forest resources to primary products.

vector< IFiles >	iFilesVector
	List of all input files. Simple (struct)

vector< BasicData >	programSettingsVector
	Setting data. Simple (struct)

vector< LLData >	LLDataVector
	Vector of Low Level Data.

vector< ModelRegion >	regionsVector
	Vector of modelled regions.

vector< forType >	forTypes
	Vector of forest types.

vector< reclRule >	reclRules
	Vector of reclassification rules.

vector< pathRule >	pathRules
	Vector of pathogen rules.

vector< vector< int > >	l2r
	Region2 ids.

map< iisskey, double >	deathTimberInventory
	Map that register the death of biomass still usable as timber by year, l2_region, forest type and diameter class [Mm^3 wood].

vector< string >	diamClasses
	Diameter classes.

int	cached_initialYear

vector< string >	priProducts

vector< string >	secProducts

vector< string >	allProducts

bool	tempBool
	a temporary bool variable used for various functions

bool	valueFoundBool
	a bool used in getForData() and getProdData() to communicate they didn't found a variable

InputNode	mainDocument
	For each agricultural soil type (as defined in the setting "agrLandTypes") this list define the objects that can be placed on that soil type.

int	errorLevel

Friends
void	Output::printForestData (bool finalFlush)

void	Output::printProductData (bool finalFlush)

Additional Inherited Members
Protected Attributes inherited from BaseClass
ThreadManager *	MTHREAD
	Pointer to the Thread manager.

Detailed Description

Regional data, including macros and settings.

All regional data are within this class. It may have linked other data-classes.
On some variables ModelData has just the definition of the objects, but the values may change at the agent-level. This is why each agent has a "personal copy" of them.

Author: Antonello Lobianco

Definition at line 80 of file ModelData.h.

Constructor & Destructor Documentation

◆ ModelData()

ModelData ( ThreadManager * MTHREAD_h )

Definition at line 61 of file ModelData.cpp.

                                            {
  MTHREAD        = MTHREAD_h;
  errorLevel     = MSG_ERROR;
  tempBool       = true;
  valueFoundBool = true;
}

◆ ~ModelData()

~ModelData ( )

Definition at line 68 of file ModelData.cpp.

                     {
 
}

Member Function Documentation

◆ addSetting() [1/2]

void addSetting	(	string	name_h,
		string	value_h,
		int	type_h,
		string	comment_h
	)

Definition at line 298 of file ModelData.cpp.

                                                                                {
  vector <string> values;
  values.push_back(value_h);
  addSetting(name_h, values, type_h, comment_h);
}

Here is the call graph for this function:

◆ addSetting() [2/2]

void addSetting	(	string	name_h,
		vector< string >	values_h,
		int	type_h,
		string	comment_h
	)

Definition at line 281 of file ModelData.cpp.

                                                                                          {
 
  for (uint i=0;i<programSettingsVector.size();i++){
    if (programSettingsVector.at(i).name == name_h){
      msgOut(MSG_ERROR, "I already have setting "+name_h+".. Nothing is added..");
      return;
    }
  }
  BasicData SETT;
  SETT.name = name_h;
  SETT.values = values_h;
  SETT.type= type_h;
  SETT.comment = comment_h;
  programSettingsVector.push_back(SETT);
}

Referenced by addSetting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyDebugMode()

void applyDebugMode ( )

Works only a specified subset of regions and products.

The applyDebugMode flag all level2 regions not in the "debugRegions" option as "residual" (so they are in the map but not in the model code) and remove the primary and secondary products that are not included in the debugPriProducts and debugSecProducts options.

Definition at line 957 of file ModelData.cpp.

                         {
  if(! getBoolSetting("debugFlag")) return;
 
  vector <int> debugRegions = getIntVectorSetting("debugRegions");
  vector <string> debugPriProducts = getStringVectorSetting("debugPriProducts");
  vector <string> debugSecProducts = getStringVectorSetting("debugSecProducts");
 
  for(uint i=0;i< regionsVector.size();i++){
    if (regionsVector[i].getRegLevel()==2){
      bool found= false;
      for(uint j=0;j<debugRegions.size();j++){
        if (debugRegions[j] == regionsVector[i].getRegId()){
          found = true;
          break;
        }
      }
      if(!found){ // not in the list to keep
        regionsVector[i].setIsResidual(true);
      }
    }
  }
 
  for (uint i=0; i<programSettingsVector.size();i++){
    if (programSettingsVector.at(i).name == "priProducts"){
      programSettingsVector.at(i).values = debugPriProducts;
    } else if (programSettingsVector.at(i).name == "secProducts"){
      programSettingsVector.at(i).values = debugSecProducts;
    }
  }
 
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyOverrides()

void applyOverrides ( )

Cancel all reg1 level data and trasform them in reg2 level if not already existing.

Definition at line 749 of file ModelData.cpp.

                         {
 
  if(!getBoolSetting("applyOverriding")) return;
  msgOut(MSG_INFO, "Starting regional overriding analysis..");
 
  DataMap::iterator p;
  string parName,prod,freeDim,forType,diamClass, key;
  int regId;
  DataMap toBeAdded;
  vector <string> keysToRemove;
 
 
  //apply override from level 0 to level 1 for forestry data
  toBeAdded.clear();
  keysToRemove.clear();
  for(p=forDataMap.begin();p!=forDataMap.end();p++){
    unpackKeyForData(p->first,parName,regId,forType,diamClass);
    if(!regionExist(regId)){
      msgOut(MSG_CRITICAL_ERROR,"Forest variable has a unknown region code If you want not to model a region, set residual=true.: "+parName+"\t"+i2s(regId));
      continue;
    }
    if(getRegion(regId)->getRegLevel() == 0){
      vector<ModelRegion*> childs = getRegion(regId)->getChildren(false);
      for(uint j=0;j<childs.size();j++){
        bool found = false;
        key = makeKeyForData(parName,i2s(childs[j]->getRegId()),forType,diamClass);
        if (!dataMapCheckExist(forDataMap,key,true)){
          toBeAdded.insert(DataPair(key,p->second));
        }
      }
      keysToRemove.push_back(p->first);
    }
  }
  forDataMap.insert(toBeAdded.begin(),toBeAdded.end());
  for(uint i=0;i<keysToRemove.size();i++){
    DataMap::iterator rem = forDataMap.find(keysToRemove[i]);
    if(rem != forDataMap.end()){
      forDataMap.erase(rem);
    }
  }
 
 
 
 
  //apply override from level 1 to level 2 for forestry data
  toBeAdded.clear();
  keysToRemove.clear();
  for(p=forDataMap.begin();p!=forDataMap.end();p++){
    unpackKeyForData(p->first,parName,regId,forType,diamClass);
    if(!regionExist(regId)){
      msgOut(MSG_CRITICAL_ERROR,"Forest variable has a unknown region code If you want not to model a region, set residual=true.: "+parName+"\t"+i2s(regId));
      continue;
    }
    if(getRegion(regId)->getRegLevel() == 1){
      vector<ModelRegion*> childs = getRegion(regId)->getChildren(false);
      for(uint j=0;j<childs.size();j++){
        bool found = false;
        key = makeKeyForData(parName,i2s(childs[j]->getRegId()),forType,diamClass);
        if (!dataMapCheckExist(forDataMap,key,true)){
          toBeAdded.insert(DataPair(key,p->second));
        }
      }
      keysToRemove.push_back(p->first);
    }
  }
  forDataMap.insert(toBeAdded.begin(),toBeAdded.end());
  for(uint i=0;i<keysToRemove.size();i++){
    DataMap::iterator rem = forDataMap.find(keysToRemove[i]);
    if(rem != forDataMap.end()){
      forDataMap.erase(rem);
    }
  }
 
  //apply override from level 0 to level 1 for production data
  toBeAdded.clear();
  keysToRemove.clear();
  for(p=prodDataMap.begin();p!=prodDataMap.end();p++){
    unpackKeyProdData(p->first,parName,regId,prod,freeDim);
    if(!regionExist(regId)){
      msgOut(MSG_CRITICAL_ERROR,"Product variable has a unknown region code If you want not to model a region, set residual=true.: "+parName+"\t"+i2s(regId));
      continue;
    }
    if(getRegion(regId)->getRegLevel() == 0){
      vector<ModelRegion*> childs = getRegion(regId)->getChildren(false);
      for(uint j=0;j<childs.size();j++){
        bool found = false;
        key = makeKeyProdData(parName,i2s(childs[j]->getRegId()),prod,freeDim);
        if (!dataMapCheckExist(prodDataMap,key,true)){
          toBeAdded.insert(DataPair(key,p->second));
        }
      }
      //prodDataMap.erase(p);
      //p--;
      keysToRemove.push_back(p->first);
    }
  }
  prodDataMap.insert(toBeAdded.begin(),toBeAdded.end());
  for(uint i=0;i<keysToRemove.size();i++){
    DataMap::iterator rem = prodDataMap.find(keysToRemove[i]);
    if(rem != prodDataMap.end()){
      prodDataMap.erase(rem);
    }
  }
 
 
  //apply override from level 1 to level 2 for production data
  toBeAdded.clear();
  keysToRemove.clear();
  for(p=prodDataMap.begin();p!=prodDataMap.end();p++){
    string debug = p->first;
    unpackKeyProdData(p->first,parName,regId,prod,freeDim);
    if(!regionExist(regId)){
      msgOut(MSG_CRITICAL_ERROR,"Product variable has a unknown region code If you want not to model a region, set residual=true.: "+parName+"\t"+i2s(regId));
      continue;
    }
    if(getRegion(regId)->getRegLevel() == 1){
      vector<ModelRegion*> childs = getRegion(regId)->getChildren(false);
      for(uint j=0;j<childs.size();j++){
        bool found = false;
        key = makeKeyProdData(parName,i2s(childs[j]->getRegId()),prod,freeDim);
        if (!dataMapCheckExist(prodDataMap,key,true)){
          toBeAdded.insert(DataPair(key,p->second));
        }
      }
      //prodDataMap.erase(p);
      //p--;
      keysToRemove.push_back(p->first);
    }
  }
  prodDataMap.insert(toBeAdded.begin(),toBeAdded.end());
    for(uint i=0;i<keysToRemove.size();i++){
    DataMap::iterator rem = prodDataMap.find(keysToRemove[i]);
    if(rem != prodDataMap.end()){
      prodDataMap.erase(rem);
    }
  }
 
  //apply override from level 0 to level 1 for reclassification rules
  for(uint i=0;i<reclRules.size();i++){
    if(reclRules[i].regId == 0){
      if(!regionExist(reclRules[i].regId)){
        msgOut(MSG_CRITICAL_ERROR,"Reclassification rule has a unknown region code If you want not to model a region, set residual=true.: "+i2s(reclRules[i].regId));
        continue;
      }
      for(uint j=0;j<getRegion(reclRules[i].regId)->getNChildren(false);j++){
        vector<ModelRegion*> childs = getRegion(reclRules[i].regId)->getChildren(false);
        bool found = 0;
        for(uint z=0;z<reclRules.size();z++){
          if(   reclRules[z].regId == childs[j]->getRegId()
             && reclRules[z].forTypeIn == reclRules[i].forTypeIn
             && reclRules[z].forTypeOut == reclRules[i].forTypeOut
          ){
            found = true; // do nothing, this child has been already manually overritten
            break;
          }
        }
        if(!found){
          reclRule RR;
          RR.regId      = childs[j]->getRegId();
          RR.forTypeIn  = reclRules[i].forTypeIn;
          RR.forTypeOut = reclRules[i].forTypeOut;
          RR.coeff      = reclRules[i].coeff;
          reclRules.push_back(RR);
        }
      }
      reclRules.erase(reclRules.begin()+i);
      i--;
    }
  }
 
  //apply override from level 1 to level 2 for reclassification rules
  for(uint i=0;i<reclRules.size();i++){
    if(!regionExist(reclRules[i].regId)){
      msgOut(MSG_CRITICAL_ERROR,"Reclassification rule has a unknown region code. If you want not to model a region, set residual=true.: "+i2s(reclRules[i].regId));
      continue;
    }
    if(getRegion(reclRules[i].regId)->getRegLevel() == 1){
      for(uint j=0;j<getRegion(reclRules[i].regId)->getNChildren(false);j++){
        vector<ModelRegion*> childs = getRegion(reclRules[i].regId)->getChildren(false);
        bool found = 0;
        for(uint z=0;z<reclRules.size();z++){
          if(   reclRules[z].regId == childs[j]->getRegId()
             && reclRules[z].forTypeIn == reclRules[i].forTypeIn
             && reclRules[z].forTypeOut == reclRules[i].forTypeOut
          ){
            found = true; // do nothing, this child has been already manually overritten
            break;
          }
        }
        if(!found){
          reclRule RR;
          RR.regId      = childs[j]->getRegId();
          RR.forTypeIn  = reclRules[i].forTypeIn;
          RR.forTypeOut = reclRules[i].forTypeOut;
          RR.coeff      = reclRules[i].coeff;
          reclRules.push_back(RR);
        }
      }
      reclRules.erase(reclRules.begin()+i);
      i--;
    }
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assessProdPossibility()

const bool assessProdPossibility	(	const string &	prod_h,
		const string &	forType_h,
		const string &	dClass_h
	)

A simple function to assess if a specified product can be made by a certain forest type and diameter class.

Definition at line 441 of file ModelData.cpp.

                                                                                                     {
  bool ok=false;
  for(uint i=0;i<forToProdVector.size();i++){
    if(    forToProdVector[i].product == prod_h
      && forToProdVector[i].forType == forType_h
      && forToProdVector[i].dClass  == dClass_h
    ){
      return true;
    }
  }
  return false;
}

Referenced by ModelCore::app(), ModelCoreSpatial::app(), Opt::app(), getAllocableProductIdsFromDeathTimber(), getAvailableAliveTimber(), and getAvailableDeathTimber().

Here is the caller graph for this function:

◆ cacheSettings()

void cacheSettings ( )

Called after input reading, it fix frequently used data;.

Definition at line 305 of file ModelData.cpp.

                        {
  cached_initialYear = getIntSetting("initialYear");
  diamClasses = getStringVectorSetting("dClasses");
  priProducts = getStringVectorSetting("priProducts");
  secProducts = getStringVectorSetting("secProducts");
  allProducts = priProducts;
  allProducts.insert( allProducts.end(), secProducts.begin(), secProducts.end() );
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateAnnualisedEquivalent() [1/2]

double calculateAnnualisedEquivalent	(	const double &	amount_h,
		const double &	years_h,
		const double &	ir
	)		const

Transform the double to the highest integer and call calculateAnnualisedEquivalent(double amount_h, int years_h)

Definition at line 2000 of file ModelData.cpp.

                                                                                                             {
  //ceil(x) DNLP returns the smallest integer number greater than or equal to x
  //loop( (u,i,lambda,essence),
  //  cumTp(u,i,lambda,essence) =   ceil(cumTp(u,i,lambda,essence));
  //);
  int ceiledYear = ceil(years_h);
  return calculateAnnualisedEquivalent(amount_h, ceiledYear, ir);
}

Here is the call graph for this function:

◆ calculateAnnualisedEquivalent() [2/2]

double calculateAnnualisedEquivalent	(	const double &	amount_h,
		const int &	years_h,
		const double &	ir
	)		const

Calculate the annual equivalent flow.

calculating the discount factor

Revenues at years n will be transforemed as average year rate as

av.y.rev = rev(n)/ ( (1+ir)^(n-1)+(1+ir)^(n-2)+(1+ir)^(n-3)+...+(1+ir)^(n-n) )

Objective is to have the present value of the final harvest (A) equal to the sum pf the present values of yearly activities (B):

Comparing present values

$PV(A) = SUM(PV(B)$

$A/(1+r)^n = B/(1+r)^1 + B/(1+r)^2 + … + B/(1+r)^n$

$A/(1+r)^n = B * ( 1/(1+r)^1 + 1/(1+r)^2 + … + 1/(1+r)^n )$

$A/(1+r)^n = B * ( (1+r)^(n-1) + (1+r)^(n-2) + … + (1+r)^(n-n) )$

$B = A / ( (1+r)^(n-1) + (1+r)^(n-2) + … + (1+r)^(n-n) )$

Changed for the equivalent but simpler eai = rev(t)*i / ((1+i)^t-1)

Definition at line 1961 of file ModelData.cpp.

                                                                                                           {
  // modified and tested 20120912. Before it was running this formula instead:
  // av.y.rev = rev(n)/ ( (1+ir)^1+(1+ir)^2+(1+ir)^3+...+(1+ir)^n )
  // the difference is that in this way the annual equivalent that is calulated doesn't need to be further discounted for yearly activites (e.g. agric)
 
  //loop(fy$(ord(fy)=1),
  //  df(fy)= (1+ir)**(ord(fy));
  //);
  //loop(fy$(ord(fy)>1),
  //  df(fy)=df(fy-1)+(1+ir)**(ord(fy));
  //);
  if(years_h<0) return 0.;
  if(years_h==0) return amount_h;
  //double ir = getDoubleSetting("ir",DATA_NOW);
  double eai = amount_h * ir / (pow(1.0+ir,years_h)-1.0);
 
  return eai;
 
    /*
  vector <double> df_by;
  for(int y=0;y<years_h;y++){
    double df;
    if(y==0){
      df = pow((1+ir),y);
    } else {
      df = df_by.at(y-1)+pow((1+ir),y);
    }
    if (y==years_h-1) {
         cout << eai << "   " << amount_h/df << endl;
     return amount_h/df; // big bug 20120904
    }
    df_by.push_back(df);
  }
  exit(1);
  return 0; // never reached, just to avoid compilation warnings
    */
}

Referenced by calculateAnnualisedEquivalent(), ModelCore::runManagementModule(), and ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

◆ createCombinationsVector()

vector< vector< int > > createCombinationsVector ( const int & nItems )

Return a vector containing any possible combination of nItems items (including any possible subset). The returned vector has in each slot the items present in that specific combination.

ModelData::createCombinationsVector Return a vector containing any possible combination of nItems items (including all subsets).

For example with nItems = 3: 0: []; 1: [0]; 2: [1]; 3: [0,1]; 4: [2]; 5: [0,2]; 6: [1,2]; 7: [0,1,2]

Parameters

nItems number of items to create p

Returns: A vector with in each slot the items present in that specific combination subset.

Definition at line 2055 of file ModelData.cpp.

                                                     {
  // Not confuse combination with permutation where order matter. Here it doesn't matter, as much as the algorithm is the same and returns
  // to as each position always the same subset
  vector < vector <int> > toReturn;
  int nCombs = pow(2,nItems);
  //int nCombs = nItems;
  for (uint i=0; i<nCombs; i++){
    vector<int> thisCombItems; //concernedPriProducts;
    for(uint j=0;j<nItems;j++){
      uint j2 = pow(2,j);
      if(i & j2){ // bit a bit operator, p217 C++ book
        thisCombItems.push_back(j);
      }
    }
    toReturn.push_back(thisCombItems);
  }
  return toReturn;
}

Referenced by ModelCoreSpatial::computeInventary(), Opt::get_nlp_info(), and ModelCoreSpatial::runMarketModule().

Here is the caller graph for this function:

◆ createRegions()

void createRegions ( )

Definition at line 317 of file ModelData.cpp.

                        {
  // first create regions and assign basic data...
  LLData table = getTable("regions");
  for (int i=0; i< table.nrecords();i++){
    ModelRegion REGION(MTHREAD,
               s2i(table.getData(i,"regId")),
               table.getData(i,"regSName"),
               table.getData(i,"regLName"),
               s2i(table.getData(i,"regLevel")),
               s2i(table.getData(i,"parRegId")),
               s2b(table.getData(i,"isResidual")));
    regionsVector.push_back(REGION);
  }
  // Now let's assign the parent/children pointers..
  for (int i=0; i< regionsVector.size();i++){
    // let's assign the parent:
    regionsVector[i].setParent(this->getRegion(regionsVector[i].getParRegId()));
    // let's assign the children:
    vector<ModelRegion*> kids;
    for (int y=0; y< regionsVector.size();y++){
      if(regionsVector[y].getParRegId() == regionsVector[i].getRegId() ){
        kids.push_back(&regionsVector[y]);
      }
    }
    regionsVector[i].setChildren(kids);
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dataMapCheckExist()

bool dataMapCheckExist	(	const DataMap &	map,
		const string &	search_for,
		const bool &	exactMatch = `true`
	)		const

private

Definition at line 1812 of file ModelData.cpp.

                                                                                                       {
  /*int dummyYear=MTHREAD->SCD->getYear();
  if(dataMapGetValue(map, search_for, dummyYear, exactMatch)==DATA_ERROR) {
    return false;
  } else {
    return true;
  }
  return false;
}*/
  bool found = false;
  DataMap::const_iterator i;
  if(!exactMatch){
    i = map.lower_bound(search_for);
    for(;i != map.end();i++){
      const string& key = i->first;
      if (key.compare(0, search_for.size(), search_for) == 0) {// Really a prefix?
          return true;
      } else {
        return false;
      }
    }
  } else {
    i = map.find(search_for);
    if (i!=map.end()){
      return true;
    }
  }
  return false;
}

Referenced by applyOverrides().

Here is the caller graph for this function:

◆ dataMapGetValue()

double dataMapGetValue	(	const DataMap &	map,
		const string &	search_for,
		const int &	year_h,
		const bool &	exactMatch = `true`
	)

private

Definition at line 1844 of file ModelData.cpp.

                                                                                                                  {
  double toReturn = 0;
  tempBool = false;
  DataMap::const_iterator i;
  if(!exactMatch){
    i = map.lower_bound(search_for);
    for(;i != map.end();i++){
      const string& key = i->first;
      if (key.compare(0, search_for.size(), search_for) == 0) {// Really a prefix?
          tempBool = true;
          toReturn += getTimedData( i->second, year_h );
      } else {
        break;
      }
    }
  } else {
    i = map.find(search_for);
    if (i!=map.end()){
      tempBool = true;
      return  getTimedData( i->second, year_h );
    }
  }
  return toReturn;
}

Referenced by getForData(), and getProdData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dataMapSetValue()

int dataMapSetValue	(	DataMap &	map,
		const string &	search_for,
		const double &	value_h,
		const int &	year_h,
		const bool &	exactMatch = `true`
	)

private

Definition at line 1872 of file ModelData.cpp.

                                                                                                                                   {
  bool found = false;
  DataMap::iterator i;
  if(!exactMatch){
    i = map.lower_bound(search_for);
    for(;i != map.end();i++){
      const string& key = i->first;
      if (key.compare(0, search_for.size(), search_for) == 0) {// Really a prefix?
          found = true;
          setTimedData(value_h, i->second, year_h);
      } else {
        break;
      }
    }
  } else {
    i = map.find(search_for);
    if (i!=map.end()){
      found = true;
      setTimedData(value_h, i->second, year_h, errorLevel);
    }
  }
  // removed 20120903 as the insertion of new values must be explicitly done, not in all cases we want a new insertion
  /*if(!found){
    vector < double> newValues;
    setTimedData(value_h, newValues, year_h, MSG_NO_MSG); // don't warning if we are making a multi-year value vector, as it is a new one
    map.insert(DataPair (search_for,newValues));
  }*/
  return found;
}

Referenced by setForData(), and setProdData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deathTimberInventory_get()

double deathTimberInventory_get ( const iisskey & thekey )

inline

Definition at line 197 of file ModelData.h.

197{return findMap(deathTimberInventory, thekey);}

BaseClass::findMap

V findMap(const map< K, V > &mymap, const K &key, const int &error_level=MSG_CRITICAL_ERROR, const V &notFoundValue=numeric_limits< V >::min()) const

Lookup a map for a value. Return the value starting from the key.

Definition BaseClass.h:286

ModelData::deathTimberInventory

map< iisskey, double > deathTimberInventory

Map that register the death of biomass still usable as timber by year, l2_region, forest type and dia...

Definition ModelData.h:230

Referenced by ModelCoreSpatial::allocateHarvesting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deathTimberInventory_incr()

void deathTimberInventory_incr	(	const iisskey &	thekey,
		double	value_h
	)

inline

Definition at line 196 of file ModelData.h.

196{incrMapValue(deathTimberInventory,thekey, value_h);}

BaseClass::incrMapValue

void incrMapValue(map< K, V > &mymap, const K &key, const V &value, const int &error_level=MSG_CRITICAL_ERROR)

Increments a value stored in a map of the specified value, given the key.

Definition BaseClass.h:312

Here is the call graph for this function:

◆ deathTimberInventory_incrOrAdd()

void deathTimberInventory_incrOrAdd	(	const iisskey &	thekey,
		double	value_h
	)

inline

Definition at line 195 of file ModelData.h.

195{incrOrAddMapValue(deathTimberInventory,thekey, value_h);}

BaseClass::incrOrAddMapValue

void incrOrAddMapValue(map< K, V > &mymap, const K &key, const V &value)

Increments a value stored in a map of the specified value, given the key.

Definition BaseClass.h:325

Referenced by ModelCoreSpatial::allocateHarvesting(), ModelCoreSpatial::initialiseDeathTimber(), and ModelCoreSpatial::runBiologicalModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delDir()

bool delDir ( QString dirname )

Recursivelly delete a directory.

Definition at line 1769 of file ModelData.cpp.

                                 {
        bool deleted = false;
        QDir dir(dirname);
  //msgOut(MSG_DEBUG, dir.absolutePath().toStdString());
  dir.setFilter(QDir::Dirs | QDir::Files | QDir::NoDotAndDotDot | QDir::NoSymLinks);
  QFileInfoList list = dir.entryInfoList();
  deleted = dir.rmdir(dir.absolutePath());
  if (deleted) return true;
 
  for (int i = 0; i < list.size(); ++i) {
    QFileInfo fileInfo = list.at(i);
    if (fileInfo.isFile()){
      //msgOut(MSG_DEBUG, "A file, gonna remove it: "+fileInfo.absoluteFilePath().toStdString());
      QFile targetFile(fileInfo.absoluteFilePath());
      bool fileDeleted = targetFile.remove();
      if (!fileDeleted){
        msgOut(MSG_CRITICAL_ERROR, "We have a problem: can't delete file "+fileInfo.absoluteFilePath().toStdString());
      }
    }
    else if (fileInfo.isDir()){
      //msgOut(MSG_DEBUG, "A directory, gonna go inside it: "+fileInfo.absoluteFilePath().toStdString());
      delDir(fileInfo.absoluteFilePath());
      dir.rmdir(fileInfo.absoluteFilePath());
    }  
  }
 
  deleted = dir.rmdir(dir.absolutePath());
  if (deleted) return true;
  return false;
}

Referenced by delDir(), and loadInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllocableProductIdsFromDeathTimber()

vector< int > getAllocableProductIdsFromDeathTimber	(	const int &	regId_h,
		const string &	ft,
		const string &	dc,
		const int &	harvesting_year,
		int	request_year = `DATA_NOW`
	)

Returns the ids of the primary products that is possible to obtain using the timber recorded death in the specific year, ft, dc combination.

Definition at line 2105 of file ModelData.cpp.

                                                                                                                                                    {
  vector<int> allocableProductIds;
  if (!getBoolSetting("useDeathTimber",DATA_NOW)) return allocableProductIds;
  if (request_year == DATA_NOW) request_year = MTHREAD->SCD->getYear();
  for(uint p=0;p<priProducts.size();p++){
    string primProd = priProducts[p];
    if(assessProdPossibility(primProd,ft, dc)){
      int maxYears = getMaxYearUsableDeathTimber(primProd, ft, dc);
      if (request_year-harvesting_year < maxYears){
        allocableProductIds.push_back(p);
      }
    }
  }
  return allocableProductIds;
}

Referenced by ModelCoreSpatial::allocateHarvesting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllRegions()

vector< ModelRegion * > getAllRegions ( bool excludeResidual = true )

Definition at line 379 of file ModelData.cpp.

                                            {
  vector <ModelRegion*> toReturn;
  for(uint i=0;i<regionsVector.size();i++){
    if( (!excludeResidual) || (!regionsVector[i].getIsResidual())){
      toReturn.push_back(&regionsVector[i]);
    }
  }
  return toReturn;
}

Referenced by ModelRegion::getSiblings(), and Gis::setSpace().

Here is the caller graph for this function:

◆ getAvailableAliveTimber()

double getAvailableAliveTimber	(	const vector< string > &	primProd_h,
		int	regId_h
	)

Returns the timber available for a given set of primary products as stored in the px->vol_l vector.

Definition at line 2124 of file ModelData.cpp.

                                                                               {
  double toReturn = 0.0;
  ModelRegion* REG = MTHREAD->MD->getRegion(regId_h);
  vector <Pixel*> regPx = REG->getMyPixels();
  vector <string> forTypesIds = getForTypeIds();
  for (uint i=0;i<forTypesIds.size();i++){
    string ft = forTypesIds[i];
    for(uint u=0;u<diamClasses.size();u++){
      string dc = diamClasses[u];
      bool possible = false;
      for (int p=0; p<primProd_h.size();p++){
          string primProd = primProd_h[p];
          if(assessProdPossibility(primProd,ft, dc)){
              possible = true;
          }
      }
      if(possible){
        for (uint p=0;p<regPx.size();p++){
          Pixel* px = regPx[p];
          toReturn += px->vol_l.at(i).at(u)*px->avalCoef.at(i);
        }
      }
    }
  }
  return toReturn;
}

Referenced by ModelCoreSpatial::computeInventary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAvailableDeathTimber()

double getAvailableDeathTimber	(	const vector< string > &	primProd_h,
		int	regId_h,
		int	year_h
	)

Returns the timber available for a given set of primary products as stored in the deathTimberInventory map.

Definition at line 2076 of file ModelData.cpp.

                                                                                           {
  if (!getBoolSetting("useDeathTimber",DATA_NOW)) return 0;
  double toReturn = 0.0;
  vector <string> forTypesIds = getForTypeIds();
  for (uint i=0;i<forTypesIds.size();i++){
    string ft = forTypesIds[i];
    for(uint u=0;u<diamClasses.size();u++){
      string dc = diamClasses[u];
      bool possible = false;
      int maxYears = 0;
      for (int p=0; p<primProd_h.size();p++){
          string primProd = primProd_h[p];
          if(assessProdPossibility(primProd,ft, dc)){
              possible = true;
              maxYears=max(maxYears,getMaxYearUsableDeathTimber(primProd, ft, dc));
          }
      }
      if(possible){
        for(int y=year_h;y>year_h-maxYears;y--){
          iisskey key(y,regId_h,ft,dc);
          toReturn += findMap(deathTimberInventory,key,MSG_NO_MSG,0.0);
        }
      }
    }
  }
  return toReturn;
}

Referenced by ModelCoreSpatial::computeInventary(), and ModelCoreSpatial::sumRegionalForData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBaseData()

string getBaseData	(	const string &	name_h,
		int	type_h,
		int	position = `0`,
		int	regId_h = `WORLD`
	)

private

Returns the value stored in the settings database.

Regional overriding.

Concerning the param regId_h: it expect either world (default), a L2 or L1 region. Settings in the memory are stored also with data in one or more of these levels (e.g. we may have a general WORLD value and then a more specific L2 value. The function is done such that if WORLD is used to query it, it returns only a world value, if L1 is used instead, it looks for this L1 value and then eventually (if nothing is found) for WORLD. Finally, if L2 is used, it query, in the order, for L2, L1 or world levels.

Definition at line 1015 of file ModelData.cpp.

                                                                                  {
  // If the data is called with DATA_NOW we interpret the array of values as a temporal array and we return the value at the current time.
  if(position == DATA_NOW) {
    position = MTHREAD->SCD->getIteration();
  }
 
  vector <int> regIds;
 
  if(regId_h == WORLD){
    regIds.push_back(WORLD);
  } else if (getRegion(regId_h)->getRegLevel()==1){
    regIds.push_back(regId_h);
    regIds.push_back(WORLD);
  } else if (getRegion(regId_h)->getRegLevel()==2) {
    regIds.push_back(regId_h);
    regIds.push_back(getRegion(regId_h)->getParRegId());
    regIds.push_back(WORLD);
  } else {
    msgOut(MSG_CRITICAL_ERROR, "Error in getBaseData(). Data requested for a unknown region level.");
  }
 
 
  for (uint j=0; j<regIds.size();j++){
    int regId = regIds[j];
    for (uint i=0; i<programSettingsVector.size();i++){
      if (programSettingsVector.at(i).name == name_h & programSettingsVector.at(i).regId == regId){
        int type = programSettingsVector.at(i).type;
        if(type != type_h){msgOut(MSG_CRITICAL_ERROR, "mismatching type in calling getBaseData() for "+name_h);}
        if(programSettingsVector.at(i).values.size() > ((uint)position)) {
          return programSettingsVector.at(i).values.at(position);
        } else if (programSettingsVector.at(i).values.size() > 0 ){
          // returning the last available value...
          return programSettingsVector.at(i).values.at( programSettingsVector.at(i).values.size()-1 );
        }
        else {msgOut(MSG_CRITICAL_ERROR, "Error: "+name_h+" doesn't have any value, even on the first position(year)!"); }
      }
    }
  }
 
  msgOut(MSG_CRITICAL_ERROR, "Error calling getBaseData() for "+ name_h +". No setting option or macro data found with this name.");
 
//  switch(type_h){
//    case TYPE_BOOL:
//      return "0";
//    case TYPE_INT:
//      return "0";
//    case TYPE_DOUBLE:
//      return "0.0";
//    case TYPE_STRING:
//      return "";
//    default:
//      msgOut(MSG_CRITICAL_ERROR, "Error calling getBaseData() for "+ i2s(type_h) +". I don't know this type.");
//  }
  return "";
}

Referenced by getBoolSetting(), getDoubleSetting(), getIntSetting(), and getStringSetting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBaseDirectory()

string getBaseDirectory ( ) const

inline

Definition at line 118 of file ModelData.h.

118{return baseDirectory;}

ModelData::baseDirectory

string baseDirectory

Definition ModelData.h:215

Referenced by Output::commonInit(), Gis::initLayers(), Gis::initLayersPixelData(), Layers::print(), and Layers::printBinMap().

Here is the caller graph for this function:

◆ getBoolSetting()

bool getBoolSetting	(	const string &	name_h,
		int	position = `0`,
		int	reg = `WORLD`
	)		const

Definition at line 1117 of file ModelData.cpp.

                                                                          {
  return s2b( MTHREAD->MD->getBaseData(name_h,TYPE_BOOL,position,reg) );
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBoolVectorSetting()

vector< bool > getBoolVectorSetting	(	const string &	name_h,
		int	reg = `WORLD`
	)		const

Definition at line 1133 of file ModelData.cpp.

                                                                  {
  return s2b(MTHREAD->MD->getVectorBaseData(name_h,TYPE_BOOL,reg));
}

Here is the call graph for this function:

◆ getCachedInitialYear()

int getCachedInitialYear ( )

inline

Definition at line 187 of file ModelData.h.

187{return cached_initialYear;}

Referenced by Scheduler::run().

Here is the caller graph for this function:

◆ getDeathTimberInventory()

map< iisskey, double > * getDeathTimberInventory ( )

inline

Definition at line 198 of file ModelData.h.

198{return &deathTimberInventory;};

◆ getDiameterClasses()

vector< string > getDiameterClasses ( bool productionOnly = false )

Definition at line 1191 of file ModelData.cpp.

                                                {
  int i;
  if(productionOnly){
    i=1;
  } else {
    i=0;
  }
  vector <string> toReturn;
  for (i;i<diamClasses.size();i++){
    toReturn.push_back(diamClasses[i]);
  }
  return toReturn;
}

Referenced by getForData(), and setForData().

Here is the caller graph for this function:

◆ getDoubleSetting()

double getDoubleSetting	(	const string &	name_h,
		int	position = `0`,
		int	reg = `WORLD`
	)		const

Definition at line 1109 of file ModelData.cpp.

                                                                            {
  return s2d( MTHREAD->MD->getBaseData(name_h,TYPE_DOUBLE,position,reg) );
}

Referenced by Gis::applySpatialStochasticValues(), Gis::applyStochasticRiskAdversion(), ModelCoreSpatial::cacheDynamicSettings(), ModelCoreSpatial::cachePixelExogenousData(), ModelCore::cacheSettings(), Opt::eval_constraints(), Opt::get_nlp_info(), Pixel::getMultiplier(), Pixel::getSTData(), Carbon::registerTransports(), ModelCore::runManagementModule(), ModelCoreSpatial::runManagementModule(), ModelCoreSpatial::runMarketModule(), and Gis::setSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDoubleVectorSetting()

vector< double > getDoubleVectorSetting	(	const string &	name_h,
		int	reg = `WORLD`
	)		const

Definition at line 1125 of file ModelData.cpp.

                                                                    {
  return s2d(MTHREAD->MD->getVectorBaseData(name_h,TYPE_DOUBLE,reg));
}

Here is the call graph for this function:

◆ getErrorLevel()

int getErrorLevel ( )

inline

Definition at line 144 of file ModelData.h.

144{return errorLevel;}

Referenced by ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

◆ getFilenameByType()

std::string getFilenameByType ( std::string type_h )

Definition at line 1175 of file ModelData.cpp.

                                            {
  std::string directory;
  std::string filename;
  std::string filename_complete;
  for (uint i=0; i<iFilesVector.size(); i++){
    if (iFilesVector.at(i).type == type_h){
      directory=iFilesVector.at(i).directory;
      filename=iFilesVector.at(i).name;
      break;
    }
  }
  filename_complete = baseDirectory+directory+filename;
  return filename_complete;
}

◆ getFilenamesByDir()

int getFilenamesByDir	(	const string &	dir,
		vector< string > &	files,
		const string &	filter = `""`
	)

Return a list of files in a directory.

Get a list of files in a directory

Definition at line 2011 of file ModelData.cpp.

                                                                                             {
  DIR *dp;
  struct dirent *dirp;
  if((dp  = opendir(dir.c_str())) == NULL) {
    msgOut(MSG_ERROR, "Error " + i2s(errno) + " opening the " + dir + " directory.");
    //cout << "Error(" << errno << ") opening " << dir << endl;
    return errno;
  }
  while ((dirp = readdir(dp)) != NULL) {
    string filename = dirp->d_name;
    if(
      (filter != "" && filename.substr(filename.find_last_of(".")) == filter) // there is a filter and the last bit of the filename match the filter
      || (filter == "" && filename.substr(filename.find_last_of(".") + 1) != "") // there isn't any filter but we don't want stuff like ".." or "."
    ) {
      files.push_back(string(dirp->d_name));
    }
  }
  closedir(dp);
  return 0;
}

Referenced by Gis::initLayersPixelData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForData()

const double getForData	(	const string &	type_h,
		const int &	regId_h,
		const string &	forType_h,
		const string &	freeDim_h,
		const int &	year = `DATA_NOW`
	)

Basic function to retrieve forest-related data. It addmits the following "filters": @type_h Name of the specific parameter requested @regId_h Look for a level1 or level2 region @forType_h If specified, look exactly for the specified forest type, otherwise accept the keyword FT_ALL for summing all of them @freeDim_h Normally used for diameter class, but occasionally used for other uses (changed 20140514). It accepts three keywords, for summing up all diameters, production-ready diameters or sub-production ones, namelly DIAM_ALL, DIAM_PROD, DIAM_FIRST.\ If a diameter-independed variable is required, put it in the data with an empty diameter class and retrieve it here using DIAM_ALL. @year Unless specified, get the value of the current year. If array is smaller (e.g. because it is time-independent), get the last value.

Definition at line 1281 of file ModelData.cpp.

                                                                                                                                {
  vector<int> regIds;
  vector <string> dClasses;
  vector <string> fTypes;
  string key;
  DataMap::const_iterator p;
  bool found = false;
  double value = 0;
 
  // creating the arrays to look up if keywords were specified..
  if (forType_h == FT_ALL){ // || forType_h == ""){
    fTypes = getForTypeIds();
    fTypes.push_back("");
  } else {
    fTypes.push_back(forType_h);
  }
  if(freeDim_h == DIAM_ALL){ // || freeDim_h == ""){
    dClasses = diamClasses;
    dClasses.push_back("");
  } else if (freeDim_h == DIAM_PROD){
    dClasses = getDiameterClasses(true);
  } else if (freeDim_h == DIAM_FIRST){
    dClasses.push_back(diamClasses.at(0));
  } else  {
    dClasses.push_back(freeDim_h);
  }
  // Make sure to set the new value to all l2 regions if requested for a reg1 level
  if(getRegion(regId_h)->getRegLevel()==2){
    regIds.push_back(regId_h);
  } else if (getRegion(regId_h)->getRegLevel()==1) {
    for(uint i=0;i<getRegion(regId_h)->getNChildren();i++){
      regIds.push_back(getRegion(regId_h)->getChildren()[i]->getRegId());
    }
  } else {
    msgOut(MSG_CRITICAL_ERROR, "Error in getProdData(). Setting a value for the whole World is not supported.");
  }
  int regIdsS = regIds.size();
 
  // getting the actual data...
  for(uint r=0;r< regIds.size();r++){
    for(uint i=0;i<dClasses.size();i++){
      for (uint y=0;y<fTypes.size();y++){
        key = makeKeyForData(type_h,i2s(regIds[r]),fTypes[y],dClasses[i]);
        value += dataMapGetValue(forDataMap,key,year,true);
        if(tempBool) found = true;
      }
    }
  }
 
  if(!found){
    valueFoundBool = false;
    msgOut(errorLevel, "Error in getForData(): no combination found for "+type_h+", "+i2s(regId_h)+", "+forType_h+", "+i2s(year)+", "+freeDim_h+". Returning 0, but double check that this is ok for your model.");
  }
  return value;
}

Referenced by Gis::applySpatialStochasticValues(), Pixel::getMultiplier(), Carbon::getStock(), Opt::gfd(), ModelCore::gfd(), ModelCoreSpatial::gfd(), Carbon::initialiseDeathBiomassStocks(), Output::printForestData(), Carbon::registerDeathBiomass(), Carbon::registerHarvesting(), and ModelCoreSpatial::runManagementModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForType() [1/2]

forType * getForType ( int position )

inline

Definition at line 128 of file ModelData.h.

128{return &forTypes[position];}

ModelData::forTypes

vector< forType > forTypes

Vector of forest types.

Definition ModelData.h:226

Referenced by Gis::applyForestReclassification(), getForTypeChilds_pos(), ModelCoreSpatial::loadExogenousForestLayers(), and ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

◆ getForType() [2/2]

forType * getForType ( string & forTypeId_h )

Definition at line 73 of file ModelData.cpp.

                                        {
  for(int i=0;i<forTypes.size();i++){
    if(forTypes[i].forTypeId==forTypeId_h) return &forTypes[i];
  }
  msgOut(MSG_CRITICAL_ERROR,"forTypeId "+forTypeId_h+" not found. Aborting.");
}

Here is the call graph for this function:

◆ getForTypeChilds()

vector< string > getForTypeChilds ( const string & forTypeId_h )

Definition at line 98 of file ModelData.cpp.

                                                    {
  vector<string> childs;
  for(int i=0;i<forTypes.size();i++){
      if(forTypes[i].ereditatedFrom==forTypeId_h) {
          childs.push_back(forTypes[i].forTypeId);
      }
  }
  return childs;
}

Referenced by ModelCoreSpatial::runManagementModule(), and ModelCoreSpatial::sumRegionalForData().

Here is the caller graph for this function:

◆ getForTypeChilds_pos()

vector< int > getForTypeChilds_pos	(	const string &	forTypeId_h,
		bool	all = `false`
	)

Definition at line 109 of file ModelData.cpp.

                                                                  {
  vector <int> childs;
  vector <string> fTIds = getForTypeIds(all);
  for(int i=0;i<fTIds.size();i++){
      forType* ft = getForType(fTIds[i]);
      if(ft->ereditatedFrom==forTypeId_h) {
          childs.push_back(i);
      }
  }
  return childs;
}

Referenced by ModelCoreSpatial::sumRegionalForData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForTypeCounter()

int getForTypeCounter	(	string &	forTypeId_h,
		bool	all = `false`
	)

By default it doesn't return forTypes used only as input.

Definition at line 81 of file ModelData.cpp.

                                                         {
  vector <string> fTIds = getForTypeIds(all);
  for(int i=0;i<fTIds.size();i++){
    if(fTIds[i]==forTypeId_h) return i;
  }
  msgOut(MSG_CRITICAL_ERROR,"forTypeId "+forTypeId_h+" not found in "+((string) __func__ )+". Aborting.");
}

Here is the call graph for this function:

◆ getForTypeIds()

vector< string > getForTypeIds ( bool all = false )

By default it doesn't return forTypes used only as input.

Definition at line 430 of file ModelData.cpp.

                                {
  vector <string> toReturn;
  for(uint i=0;i<forTypes.size();i++){
    if(forTypes[i].memType!=1 || all) {
      toReturn.push_back(forTypes[i].forTypeId);
    }
  }
  return toReturn;
}

Referenced by Gis::applySpatialStochasticValues(), ModelCore::cacheSettings(), ModelCoreSpatial::cacheSettings(), Output::commonInit(), ModelRegion::getArea(), ModelRegion::getArea(), getAvailableAliveTimber(), getAvailableDeathTimber(), getForData(), getForTypeChilds_pos(), getForTypeCounter(), Pixel::getSpModifier(), Carbon::getStock(), Carbon::initialiseDeathBiomassStocks(), Gis::initLayers(), Pixel::Pixel(), ModelCoreSpatial::runManagementModule(), setForData(), ModelCore::updateMapAreas(), ModelCoreSpatial::updateMapAreas(), and ModelCoreSpatial::updateOtherMapData().

Here is the caller graph for this function:

◆ getForTypeParentId()

string getForTypeParentId ( const string & forTypeId_h )

Definition at line 90 of file ModelData.cpp.

                                                      {
    for(int i=0;i<forTypes.size();i++){
        if(forTypes[i].forTypeId==forTypeId_h) return forTypes[i].ereditatedFrom;
    }
    msgOut(MSG_CRITICAL_ERROR,"forTypeId "+forTypeId_h+" not found. Aborting.");
}

Referenced by ModelCoreSpatial::runManagementModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForTypeParents()

vector< string > getForTypeParents ( )

Definition at line 122 of file ModelData.cpp.

                            {
  vector<string> parents;
  for(int i=0;i<forTypes.size();i++){
    string parent = forTypes[i].ereditatedFrom;
    if(!inVector(parent,parents) && parent != ""){
      parents.push_back(parent);
    }
  }
  return parents;
}

Referenced by Output::printForestData(), and ModelCoreSpatial::sumRegionalForData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIFilesVector()

vector< IFiles > getIFilesVector ( ) const

inline

Definition at line 117 of file ModelData.h.

117{return iFilesVector;}

◆ getIntSetting()

int getIntSetting	(	const string &	name_h,
		int	position = `0`,
		int	reg = `WORLD`
	)		const

Definition at line 1105 of file ModelData.cpp.

                                                                         {
  return s2i( MTHREAD->MD->getBaseData(name_h,TYPE_INT,position, reg) );
}

Referenced by ModelCore::cacheSettings(), ModelCoreSpatial::cacheSettings(), cacheSettings(), Output::commonInit(), Opt::get_nlp_info(), Output::getOutputFieldDelimiter(), Pixel::getPathMortality(), Carbon::getStock(), Carbon::HWP_eol2energy(), Layers::print(), Output::print(), Scheduler::run(), ModelCore::runManagementModule(), ModelCoreSpatial::runMarketModule(), Init::setInitLevel1(), and Gis::setSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIntVectorSetting()

vector< int > getIntVectorSetting	(	const string &	name_h,
		int	reg = `WORLD`
	)		const

Definition at line 1121 of file ModelData.cpp.

                                                                 {
  return s2i(MTHREAD->MD->getVectorBaseData(name_h,TYPE_INT,reg));
}

Referenced by applyDebugMode(), and Output::commonInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMaxYearUsableDeathTimber() [1/2]

const int getMaxYearUsableDeathTimber ( )

Definition at line 456 of file ModelData.cpp.

                                      {
  int maxMaxYears = 0;
  for(uint i=0;i<forToProdVector.size();i++){
    if(forToProdVector[i].maxYears > maxMaxYears){
      maxMaxYears = forToProdVector[i].maxYears;
    }
  }
  return maxMaxYears;
}

Referenced by getAllocableProductIdsFromDeathTimber(), and getAvailableDeathTimber().

Here is the caller graph for this function:

◆ getMaxYearUsableDeathTimber() [2/2]

const int getMaxYearUsableDeathTimber	(	const string &	prod_h,
		const string &	forType_h,
		const string &	dClass_h
	)

Definition at line 468 of file ModelData.cpp.

                                                                                                           {
  for(uint i=0;i<forToProdVector.size();i++){
    if(    forToProdVector[i].product == prod_h
      && forToProdVector[i].forType == forType_h
      && forToProdVector[i].dClass  == dClass_h
    ){
      return forToProdVector[i].maxYears;
    }
  }
  msgOut(MSG_CRITICAL_ERROR,"In getMaxYearUsableDeathTimber() I has been asked of a combination that I don't know how to handle.");
}

Referenced by ModelCoreSpatial::allocateHarvesting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNForTypes()

int getNForTypes ( )

inline

Definition at line 126 of file ModelData.h.

126{return forTypes.size();}

Referenced by Gis::applyForestReclassification().

Here is the caller graph for this function:

◆ getNForTypesChilds()

int getNForTypesChilds ( const string & forTypeId_h )

Definition at line 135 of file ModelData.cpp.

                                                      {
    int nChilds = 0;
    for(int i=0;i<forTypes.size();i++){
        if(forTypes[i].ereditatedFrom==forTypeId_h) {
            nChilds ++;
        }
    }
    return nChilds;
}

Referenced by ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

◆ getNReclRules()

int getNReclRules ( )

inline

Definition at line 127 of file ModelData.h.

127{return reclRules.size();}

Referenced by Gis::applyForestReclassification().

Here is the caller graph for this function:

◆ getOutputDirectory()

string getOutputDirectory ( ) const

inline

Return a vector of objects that together provide the specified resource in the specified quantity.

Definition at line 113 of file ModelData.h.

113{return outputDirname;}

ModelData::outputDirname

string outputDirname

Definition ModelData.h:214

Referenced by Output::commonInit(), Layers::print(), and Layers::printBinMap().

Here is the caller graph for this function:

◆ getPathMortalityRule()

vector< pathRule * > getPathMortalityRule	(	const string &	forType,
		const string &	dC
	)

Return the pathogen mortality rule(s) associated with a given ft and dc (plural as more than a single pathogen could be found)

Definition at line 2034 of file ModelData.cpp.

                                                                      {
  vector<pathRule*> toReturn;
  for(uint i=0;i<pathRules.size();i++){
    if(pathRules[i].forType == forType && pathRules[i].dClass == dC){
      toReturn.push_back(&pathRules[i]);
    }
  }
  return toReturn;
}

Referenced by Pixel::getPathMortality().

Here is the caller graph for this function:

◆ getProdData()

const double getProdData	(	const string &	type_h,
		const int &	regId_h,
		const string &	prodId_h,
		const int &	year = `DATA_NOW`,
		const string &	freeDim_h = `""`
	)

Basic function to retrieve products-related data. It addmits the following "filters": @type_h Name of the specific parameter requested @regId_h Look for level1 or level 2 region. @prodId_h Product. It accept three keywords, for summing up all products, primary products or secondary products, namelly PROD_ALL, PROD_PRI, PROD_SEC. @year Unless specified, get the value of the current year. If array is smaller (e.g. because it is time-independent), get the last value. @freeDim_h If specified, look exactly for it, otherwise simply doesn't filter for it.

Definition at line 1216 of file ModelData.cpp.

                                                                                                                                 {
 
  double value=0;
  vector <int> regIds;
  string key;
  DataMap::const_iterator p;
 
  bool found = false;
  vector <string> products;
  bool exactMatch=true;
 
  if(prodId_h == PROD_PRI){
    products = priProducts;
  } else if (prodId_h == PROD_SEC){
    products = secProducts;
  } else if (prodId_h == PROD_ALL || prodId_h == ""){
    products = allProducts;
    products.push_back("");
  } else  {
    products.push_back(prodId_h);
  }
  if(freeDim_h=="") exactMatch=false;
 
  // Make sure to set the new value to all l2 regions if requested for a reg1 level
  if(getRegion(regId_h)->getRegLevel()==2){
    regIds.push_back(regId_h);
  } else if (getRegion(regId_h)->getRegLevel()==1) {
    for(uint i=0;i<getRegion(regId_h)->getNChildren();i++){
      regIds.push_back(getRegion(regId_h)->getChildren()[i]->getRegId());
    }
  } else {
    msgOut(MSG_CRITICAL_ERROR, "Error in setProdData(). Setting a value for the whole World is not supported.");
  }
  int regIdsS = regIds.size();
 
 
  for(uint r=0;r<regIdsS;r++){
    for(uint i=0;i<products.size();i++){
      key = makeKeyProdData(type_h,i2s(regIds[r]),products[i],freeDim_h);
      if (!exactMatch && key.size () > 0)  key.resize (key.size () - 1); // bug 20140402, removing the last #
      value += dataMapGetValue(prodDataMap,key,year,exactMatch);
      if(tempBool) found = true;
    }
  }
 
  if(!found){
    valueFoundBool = false;
    msgOut(errorLevel, "Error in getProdData: no combination found for "+type_h+", "+i2s(regId_h)+", "+prodId_h+", "+i2s(year)+", "+freeDim_h+". Returning 0, but double check that this is ok for your model.");
  }
  return value;
 
 
}

Referenced by Carbon::getStock(), ModelCore::gpd(), ModelCoreSpatial::gpd(), Opt::gpd(), Carbon::HWP_eol2energy(), Carbon::initialiseProductsStocks(), Output::printProductData(), and Carbon::registerProducts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReclRule()

reclRule * getReclRule ( int position )

inline

Definition at line 137 of file ModelData.h.

137{return &reclRules[position];}

Referenced by Gis::applyForestReclassification().

Here is the caller graph for this function:

◆ getRegion()

ModelRegion * getRegion ( int regId_h )

Definition at line 346 of file ModelData.cpp.

                               {
  for (int i=0; i< regionsVector.size();i++){
    if(regionsVector[i].getRegId()==regId_h){
      return &regionsVector[i];
    }
  }
  msgOut(MSG_CRITICAL_ERROR, "Region id "+i2s(regId_h)+" not found, check your input data. Aborting simulation.");
}

Referenced by applyOverrides(), Gis::applySpatialStochasticValues(), Gis::applyStochasticRiskAdversion(), ModelCoreSpatial::assignSpMultiplierPropToVols(), ModelCoreSpatial::cachePixelExogenousData(), Output::commonInit(), ModelCoreSpatial::computeCumulativeData(), ModelCoreSpatial::computeEconomicBalances(), ModelCoreSpatial::computeInventary(), Opt::copyInventoryResourses(), createRegions(), Opt::get_nlp_info(), Gis::getAllPlotsByRegion(), getAvailableAliveTimber(), getBaseData(), getForData(), getProdData(), getRegionIds(), getVectorBaseData(), ModelCoreSpatial::initializePixelArea(), ModelCoreSpatial::initializePixelVolumes(), ModelCoreSpatial::loadExogenousForestLayers(), Output::printDebugPixelValues(), regId2RegSName(), regSName2RegId(), ModelCoreSpatial::resetPixelValues(), ModelCoreSpatial::runBiologicalModule(), ModelCoreSpatial::runManagementModule(), ModelCoreSpatial::runMarketModule(), setForData(), setProdData(), ModelCoreSpatial::sumRegionalForData(), ModelCore::updateMapAreas(), and ModelCoreSpatial::updateMapAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRegionIds() [1/2]

vector< vector< int > > getRegionIds ( bool excludeResidual = true )

Definition at line 390 of file ModelData.cpp.

                                            {
  vector < vector <int> > toReturn;
  vector <int> l1regIds =  MTHREAD->MD->getRegionIds(1, excludeResidual);
  for(uint i=0;i<l1regIds.size();i++){
    vector<int> l2ChildrenIds;
    ModelRegion* l1Region = MTHREAD->MD->getRegion(l1regIds[i]);
    vector<ModelRegion*> l2Childrens = l1Region->getChildren(excludeResidual);
    for(uint j=0;j<l2Childrens.size();j++){
      l2ChildrenIds.push_back(l2Childrens[j]->getRegId());
    }
    if(l2ChildrenIds.size()){
      toReturn.push_back(l2ChildrenIds);
    }
  }
  return toReturn;
}

Here is the call graph for this function:

◆ getRegionIds() [2/2]

vector< int > getRegionIds	(	int	level_h,
		bool	excludeResidual = `true`
	)

Definition at line 366 of file ModelData.cpp.

                                                        {
  vector <int> toReturn;
  for(uint i=0;i<regionsVector.size();i++){
    if(regionsVector[i].getRegLevel()==level_h){
      if( (!excludeResidual) || (!regionsVector[i].getIsResidual())){
        toReturn.push_back(regionsVector[i].getRegId());
      }
    }
  }
  return toReturn;
}

Referenced by Gis::applySpatialStochasticValues(), Gis::applyStochasticRiskAdversion(), ModelCore::cacheSettings(), ModelCoreSpatial::cacheSettings(), Output::commonInit(), Opt::get_nlp_info(), Gis::getAllPlots(), getRegionIds(), Carbon::HWP_eol2energy(), Carbon::initialiseEmissionCounters(), Output::printDebugOutput(), Output::printDebugPixelValues(), regSName2RegId(), ModelCore::updateMapAreas(), ModelCoreSpatial::updateMapAreas(), and ModelCoreSpatial::updateOtherMapData().

Here is the caller graph for this function:

◆ getScenarioIndex()

int getScenarioIndex ( )

Todo:: Check that I can call this function all around the model and not only at the beginning

Definition at line 157 of file ModelData.cpp.

                           {
  vector<string> scenarios = getScenarios(); /// \todo Check that I can call this function all around the model and not only at the beginning
  string currentScenario = MTHREAD->getScenarioName();
  for(int i=0;i<scenarios.size();i++){
    if (currentScenario == scenarios[i]){
      return i;
    }
  }
  msgOut(MSG_CRITICAL_ERROR, "function getScenarioIndex() didn't found the current scenarioName within those returned by getScenarios().");
  return 0;
}

Here is the call graph for this function:

◆ getScenarios()

vector< string > getScenarios ( )

Definition at line 146 of file ModelData.cpp.

                       {
  vector<string> toReturn;
  LLData table = getTable("scenarios");
  for(int i=0;i<table.nrecords();i++){
    string scenarioName = table.getData(i,"id");
    toReturn.push_back(scenarioName);
  }
  return toReturn;
}

Referenced by getScenarioIndex(), ThreadManager::run(), and ThreadManager::runFromConsole().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStringSetting()

string getStringSetting	(	const string &	name_h,
		int	position = `0`,
		int	reg = `WORLD`
	)		const

Definition at line 1113 of file ModelData.cpp.

                                                                            {
  return MTHREAD->MD->getBaseData(name_h,TYPE_STRING,position,reg);
}

Referenced by ModelCoreSpatial::cacheDynamicSettings(), ModelCore::cacheSettings(), Output::commonInit(), Gis::initLayers(), Gis::initLayersPixelData(), ModelCoreSpatial::runManagementModule(), ModelCore::runMarketModule(), ModelCoreSpatial::runMarketModule(), setDefaultSettings(), and setScenarioSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStringVectorSetting()

vector< string > getStringVectorSetting	(	const string &	name_h,
		int	reg = `WORLD`
	)		const

Definition at line 1129 of file ModelData.cpp.

                                                                    {
  return MTHREAD->MD->getVectorBaseData(name_h,TYPE_STRING,reg);
}

Referenced by applyDebugMode(), ModelCore::cacheSettings(), ModelCoreSpatial::cacheSettings(), cacheSettings(), Output::commonInit(), Opt::get_nlp_info(), ModelRegion::getArea(), Pixel::getMultiplier(), Carbon::getStock(), Carbon::HWP_eol2energy(), Carbon::initialiseProductsStocks(), ModelRegion::ModelRegion(), Output::printDebugPixelValues(), and ModelCoreSpatial::sumRegionalForData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTable()

LLData getTable	(	string	tableName_h,
		int	debugLevel = `MSG_CRITICAL_ERROR`
	)

Definition at line 1801 of file ModelData.cpp.

                                                     {
  LLData toReturn(MTHREAD,"");
  for(uint i=0;i<LLDataVector.size();i++){
    if (LLDataVector[i].getTableName() == tableName_h)return LLDataVector[i];
  }
  msgOut(debugLevel,"No table found with name "+tableName_h);
  return toReturn;
}

Referenced by createRegions(), getScenarios(), setDefaultForData(), setDefaultPathogenRules(), setDefaultProdData(), setDefaultProductResourceMatrixLink(), setDefaultSettings(), setForestTypes(), setReclassificationRules(), setScenarioData(), setScenarioForData(), setScenarioPathogenRules(), setScenarioProdData(), setScenarioProductResourceMatrixLink(), and setScenarioSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableFromFile()

LLData getTableFromFile	(	string	tablename,
		string	filename_h
	)

Load and return a data table from a file (instead that from a spreadsheet sheet)

Definition at line 1731 of file ModelData.cpp.

                                                              {
  string fileName = MTHREAD->getBaseDirectory()+filename_h;
  QFile file(fileName.c_str());
  if (!file.open(QFile::ReadOnly)) {
      msgOut(MSG_ERROR, "Cannot open file "+fileName+" for reading.");
  }
  QTextStream in(&file);
  LLData data(MTHREAD, tablename);
  int countRow = 0;
  while (!in.atEnd()) {
    QString line = in.readLine();
    if(line=="") continue; //skipping completelly empty lines, even without separators
    QStringList fields = line.split(';');
    bool emptyLine = true;
    if (countRow==0){ // building headers
      for(uint i =0;i<fields.size();i++){
        data.headers.push_back(fields.at(i).toStdString());
      }
    } else {
      vector<string> record ; //= fields.toVector().toStdVector();
      unsigned int z = fields[0].toStdString().find("#");
      if( z!=string::npos && z == 0) continue; // found "#" on fist position, it's a comment!
      for(uint i =0;i<fields.size();i++){
        string field = fields.at(i).toStdString();
        replace(field.begin(), field.end(), ',', '.');
        record.push_back(field);
        if(field!="") emptyLine = false;
      }
      if(!emptyLine){data.records.push_back(record);};
    }
    countRow++;
  }
  data.clean();
  return data;
}

Referenced by loadInput(), and setScenarioSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTempBool()

bool getTempBool ( )

inline

Definition at line 145 of file ModelData.h.

145{return tempBool;}

Referenced by ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

◆ getTimedData()

double getTimedData	(	const vector< double > &	dated_vector,
		const int &	year_h
	)		const

Return the value for the specified year in a timelly ordered vector, taking the last value if this is smaller than the required position.

Definition at line 1480 of file ModelData.cpp.

                                                                                  {
 
  int position;
  if(year_h==DATA_NOW){
    position = MTHREAD->SCD->getYear()-cached_initialYear;
  } else {
    position = year_h-cached_initialYear;
  }
 
  if(dated_vector.size() > position) {
    return dated_vector[position];
  } else if (dated_vector.size() > 0 ){
    // returning the last available value...
    return dated_vector[dated_vector.size()-1];
  } else {
    msgOut(MSG_CRITICAL_ERROR, "Error in getTimedData: requested value doesn't have any value, even on the first position(year)!");
  }
  return 0;
}

Referenced by dataMapGetValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValueFoundBool()

bool getValueFoundBool ( )

inline

Definition at line 147 of file ModelData.h.

147{return valueFoundBool;}

◆ getVectorBaseData()

vector< string > getVectorBaseData	(	const string &	name_h,
		int	type_h,
		int	regId_h = `WORLD`
	)

private

Definition at line 1073 of file ModelData.cpp.

                                                                          {
  vector <int> regIds;
  if(regId_h == WORLD){
    regIds.push_back(WORLD);
  } else if(getRegion(regId_h)->getRegLevel()==1){
    regIds.push_back(regId_h);
    regIds.push_back(WORLD);
  } else if (getRegion(regId_h)->getRegLevel()==2) {
    regIds.push_back(regId_h);
    regIds.push_back(getRegion(regId_h)->getParRegId());
    regIds.push_back(WORLD);
  } else {
    msgOut(MSG_CRITICAL_ERROR, "Error in getBaseData(). Data requested for a unknown region level.");
  }
 
  for (uint j=0; j<regIds.size();j++){
    int regId = regIds[j];
    for (uint i=0; i<programSettingsVector.size();i++){
      if (programSettingsVector.at(i).name == name_h & programSettingsVector.at(i).regId == regId){
        int type = programSettingsVector.at(i).type;
        if(type != type_h){msgOut(MSG_CRITICAL_ERROR, "mismatching type in calling getVectorBaseData() for "+name_h);}
        return programSettingsVector.at(i).values;
      }
    }
  }
  msgOut(MSG_CRITICAL_ERROR, "Error calling getVectorBaseData() for "+ name_h +". No setting option or macro data found with this name.");
  vector <string> toReturn;
  return toReturn;
}

Referenced by getBoolVectorSetting(), getDoubleVectorSetting(), getIntVectorSetting(), and getStringVectorSetting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadInput()

void loadInput ( )

Unzip the OpenOffice input file (NEW 2008.05.13)

Definition at line 1527 of file ModelData.cpp.

                    {
  msgOut(MSG_INFO, "Loading input files (this can take a few minutes)...");
  //QString iFile("data/ffsmInput.ods");
  QString iFile(MTHREAD->getInputFileName().c_str());
  //cout << "PIPPO !!!!! " << MTHREAD->getInputFileName().c_str() << endl;
 
  //std::random_device rd;
  //std::mt19937 localgen(rd());
  std::mt19937 localgen(time(0));
  std::uniform_int_distribution<> dis(10, 1000000);
  int randomNumber = dis(localgen);
 
  QString oDir((MTHREAD->getBaseDirectory()+"tempInput-"+MTHREAD->getScenarioName()+i2s(randomNumber)).c_str());
  string forDataCachedFilename = MTHREAD->getBaseDirectory()+"cachedInput/forData.csv";
  string prodDataCachedFilename = MTHREAD->getBaseDirectory()+"cachedInput/prodData.csv";
  
  // removing output directory if exist..
  QDir oQtDir(oDir);
 
  if(oQtDir.exists()){
    bool deleted;
    deleted = delDir(oDir);
    if(deleted){msgOut(MSG_DEBUG,"Correctly deleted old temporary data");}
    else {msgOut(MSG_WARNING, "I could not delete old temporary data dir (hopefully we'll overrite the input files)");}
  }
 
  if (!QFile::exists(iFile))
  {
    cout << "File does not exist." << endl << endl;
    //return false;
  }
  UnZip::ErrorCode ec;
  UnZip uz;
  ec = uz.openArchive(iFile);
  if (ec != UnZip::Ok)  {
        //cout << "Failed to open archive: " << uz.formatError(ec).toAscii().data() << endl << endl; // Qt4
        cout << "Failed to open archive: " << uz.formatError(ec).toLatin1().data() << endl << endl;  // Qt5
    //return false;
  }
  ec = uz.extractAll(oDir);
  if (ec != UnZip::Ok){
    //cout << "Extraction failed: " << uz.formatError(ec).toAscii().data() << endl << endl; // Qt4
    cout << "Extraction failed: " << uz.formatError(ec).toLatin1().data() << endl << endl;  // Qt5
    uz.closeArchive();
    //return false;
  }
  
  // loading input file into memory...
  string inputXMLFileName = MTHREAD->getBaseDirectory()+"tempInput-"+MTHREAD->getScenarioName()+i2s(randomNumber)+"/content.xml";
  //string inputXMLFileName = MTHREAD->getBaseDirectory()+"test/content.xml";
  //cout << "inputXMLFileName: " << inputXMLFileName << endl;
  //mainDocument = new InputDocument();
  mainDocument.setWorkingFile(inputXMLFileName);
  //InputNode documentContent = mainDocument.getNodeByName("office:document-content");
  //InputNode documentBody = mainDocument.getNodeByName("office:body");
  //InputNode mainNode = mainDocument.getNodeByName("spreadsheet");
  //InputNode pippo = mainDocument.getNodeByName("pippo-pippo");
  //InputNode table = mainDocument.getNodeByName("table");
  //cout << "Test result: " << table.getStringContent() << endl;
 
 
  vector <InputNode> tables = mainDocument.getNodesByName("table");
  for(uint i=0;i<tables.size();i++){
    string tableName = tables[i].getStringAttributeByName("name");
    //cout <<tableName<<endl;
    if( (tableName == "forData" || tableName == "prodData") && QFile::exists(forDataCachedFilename.c_str()) )  {
      msgOut(MSG_INFO,"Attenction, using cached data (csv) for "+tableName);
      string fileName = MTHREAD->getBaseDirectory()+"cachedInput/"+tableName+".csv";
      LLDataVector.push_back(MTHREAD->MD->getTableFromFile(tableName, fileName));
      continue;
    }
    LLData data(MTHREAD,tables[i].getStringAttributeByName("name"));
    vector <InputNode> rows = tables[i].getNodesByName("table-row",MSG_NO_MSG,true);
    if(rows.size()<2) continue; //empty table or only with headers
    // building headers..
    vector <InputNode> cells = rows[0].getNodesByName("table-cell",MSG_NO_MSG,true);
    for (uint y=0; y<cells.size(); y++){
      int repeated = 1;
      if( cells[y].hasAttributeByName("number-columns-repeated")){
        repeated = cells[y].getIntAttributeByName("number-columns-repeated");
      }
      for (int q=0;q<repeated;q++){
        if( !cells[y].hasChildNode("p") ){
          data.headers.push_back(""); // empty header
        } else {
          data.headers.push_back(cells[y].getNodeByName("p",MSG_NO_MSG,true).getStringContent());
        }
      }
    }
    // loading data...
    for (uint j=1; j<rows.size();j++){
      //cout << j << endl;
      vector <InputNode> cells = rows[j].getNodesByName("table-cell",MSG_NO_MSG,true);
      //vector <InputNode> cells = rows[j].getChildNodes();
      if (cells.size()<1) continue;
      vector<string> record;
      // checking the first cell is not a comment nor is empty..
      int childCount = cells[0].getChildNodesCount();
      if (childCount == 0 || !cells[0].hasChildNode("p")) continue; // empty line, first column empty!
      string fistCol = cells[0].getNodeByName("p",MSG_NO_MSG,true).getStringContent();
      unsigned int z;
      z = fistCol.find("#");
      if( z!=string::npos && z == 0) continue; // found "#" on fist position, it's a comment!
      for (uint y=0; y<cells.size(); y++){
        int repeated = 1;
        if( cells[y].hasAttributeByName("number-columns-repeated")){
          repeated = cells[y].getIntAttributeByName("number-columns-repeated");
        }
        for (int q=0;q<repeated;q++){
          if( !cells[y].hasChildNode("p") ){
            record.push_back(""); // empty header
          } else {
            // changed 20120625 as for float values the content of p is the visualised value, not the full memorised one.
            // this is strange because  tought I already tested it.. but maybe is changed the format??
            if(cells[y].getStringAttributeByName("value-type")=="float"){
              record.push_back(cells[y].getStringAttributeByName("value"));
            } else {
              record.push_back(cells[y].getNodeByName("p",MSG_NO_MSG,true).getStringContent());
            }
          }
        }
      }
      data.records.push_back(record);
    }
    data.clean();
    LLDataVector.push_back(data);
  }
 
  //debug !!!
  /*for (uint i=0; i<LLDataVector.size();i++){
    cout << "***************** NEW TABLE: " << LLDataVector[i].tableName << endl;
    //cout << "***** Headers: "<< endl;
    int headerSize = LLDataVector[i].headers.size();
    bool ok = true;
    cout << "Header size: " << headerSize << endl;
    //for (uint j=0; j<LLDataVector[i].headers.size();j++){
    //  cout << "["<<j<<"] " << LLDataVector[i].headers[j] << endl;
    //}
    //cout << "***** Records: " << endl;
    for (uint j=0; j<LLDataVector[i].records.size();j++){
      //cout << "** Record "<<j<<":"<<endl; 
      if(LLDataVector[i].records[j].size() != headerSize){
        cout << "There is a problem on record " << j <<"!"<< endl;
        cout << "His size is: "<< LLDataVector[i].records[j].size() << endl;
        ok = false;
      }
      //for (uint y=0; y<LLDataVector[i].records[j].size();y++){
      //  cout << "["<<y<<"] " << LLDataVector[i].records[j][y] << endl;
      //}
    }
    if(!ok) {cout <<"Problems with this table :-( !"<<endl;}
  }*/
 
 
 
  // deleting output directory if exist...
  if(oQtDir.exists()){
    bool deleted;
    deleted = delDir(oDir);
    if(deleted){msgOut(MSG_DEBUG,"Correctly deleted old temporary data");}
    else {msgOut(MSG_WARNING, "I could not delete old temporary data dir (hopefully we'll overrite the input files)");}
  }
}

Referenced by MainProgram::MainProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeKeyForData()

string makeKeyForData	(	const string &	parName,
		const string &	regId,
		const string &	forType,
		const string &	diamClass
	)		const

inline

Definition at line 173 of file ModelData.h.

173{return parName+"#"+regId+"#"+forType+"#"+diamClass+"#";}

Referenced by applyOverrides(), getForData(), setDefaultForData(), setForData(), and setScenarioForData().

Here is the caller graph for this function:

◆ makeKeyProdData()

string makeKeyProdData	(	const string &	parName,
		const string &	regId,
		const string &	prod,
		const string &	freeDim = `""`
	)		const

inline

Definition at line 172 of file ModelData.h.

172{return parName+"#"+regId+"#"+prod+"#"+freeDim+"#";}

Referenced by applyOverrides(), getProdData(), setDefaultProdData(), setProdData(), and setScenarioProdData().

Here is the caller graph for this function:

◆ regId2RegSName()

string regId2RegSName ( const int & regId_h ) const

Definition at line 408 of file ModelData.cpp.

                                                    {
  ModelRegion* reg = MTHREAD->MD->getRegion(regId_h);
  return reg->getRegSName();
}

Referenced by Output::printCarbonBalance(), Output::printDebugOutput(), Output::printDetailedHV(), Output::printForestData(), and Output::printProductData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ regionExist()

bool regionExist ( const int & regId_h ) const

Definition at line 356 of file ModelData.cpp.

                                                 {
  for (int i=0; i< regionsVector.size();i++){
    if(regionsVector[i].getRegId()==regId_h){
      return true;
    }
  }
  return false;
}

Referenced by applyOverrides().

Here is the caller graph for this function:

◆ regSName2RegId()

int regSName2RegId ( const string & regSName_h ) const

Definition at line 414 of file ModelData.cpp.

                                                         {
  ModelRegion* reg;
  for(uint i=0; i<3; i++){
    vector <int> regIds =  MTHREAD->MD->getRegionIds(i, false);
    for(uint j=0;j<regIds.size();j++){
      reg = MTHREAD->MD->getRegion(regIds[j]);
      if(reg->getRegSName()==regSName_h) {return regIds[j];}
    }
  }
  msgOut(MSG_CRITICAL_ERROR,"Regional short name not found.");
}

Here is the call graph for this function:

◆ setBaseDiretory()

void setBaseDiretory ( string baseDirectory_h )

inline

Definition at line 183 of file ModelData.h.

183{baseDirectory=baseDirectory_h;}

Referenced by MainProgram::MainProgram().

Here is the caller graph for this function:

◆ setDefaultForData()

void setDefaultForData ( )

Definition at line 481 of file ModelData.cpp.

                            {
  msgOut(MSG_DEBUG,"Loading forest sector data..");
  LLData table = getTable("forData");
  int nheaders = table.nheaders();
  for (int i=0; i< table.nrecords();i++){
    vector <double> values;
    for (int z=0;z<nheaders-4;z++){ // don't consider parName, region, forType and diamClass headers
      string toSearch = "value_"+i2s(z);
      string value = table.getData(i,toSearch);
      if (value != ""){
        values.push_back(s2d(value));
      }
    }
        string keys = makeKeyForData(table.getData(i,"parName"), table.getData(i,"region"),table.getData(i,"forType"),table.getData(i,"freeDim"));
    forDataMap.insert(std::pair<string, vector<double> >(keys, values));
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultPathogenRules()

void setDefaultPathogenRules ( )

Definition at line 678 of file ModelData.cpp.

                                  {
 
  if(!getBoolSetting("usePathogenModule")) return;
  msgOut(MSG_DEBUG,"Loading pathogen rules..");
  LLData table = getTable("pathRules");
  int nheaders = table.nheaders();
  for (int i=0; i< table.nrecords();i++){
    pathRule PR;
    PR.forType = table.getData(i,"forType");
    PR.dClass = table.getData(i,"dClass");
    PR.pathId = table.getData(i,"path_name");
    PR.pres_min = s2d(table.getData(i,"pres_min"));
 
    vector <double> values;
    for (int z=0;z<nheaders-4;z++){ // don't consider forType, dClass, path_name and pres_min  headers
      string toSearch = "year_"+i2s(z);
      string value = table.getData(i,toSearch);
      if (value != ""){
        values.push_back(s2d(value));
      }
    }
    PR.mortCoefficents = values;
 
    pathRules.push_back(PR);
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultProdData()

void setDefaultProdData ( )

Definition at line 531 of file ModelData.cpp.

                             {
 
  msgOut(MSG_DEBUG,"Loading products data..");
  LLData table = getTable("prodData");
  int nheaders = table.nheaders();
 
  for (int i=0; i< table.nrecords();i++){
//    prodData PDATA;
//    PDATA.parName = table.getData(i,"parName");
//    PDATA.region = s2i(table.getData(i,"region"));
//    PDATA.prod = table.getData(i,"prod");
//    PDATA.freeDim = table.getData(i,"freeDim");
    vector <double> values;
    for (int z=0;z<nheaders-4;z++){ // don't consider parName, region, prod and freeDim headers
      string toSearch = "value_"+i2s(z);
      string value = table.getData(i,toSearch);
      if (value != ""){
        values.push_back(s2d(value));
      }
    }
//    PDATA.values = values;
//    prodDataVector.push_back(PDATA);
    string keys = makeKeyProdData(table.getData(i,"parName"), table.getData(i,"region"),table.getData(i,"prod"),table.getData(i,"freeDim"));
    prodDataMap.insert(std::pair<string, vector<double> >(keys, values));
    //giving a link to it to its own region:
//    getRegion(PDATA.region)->addProdData(&PDATA);
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultProductResourceMatrixLink()

void setDefaultProductResourceMatrixLink ( )

Definition at line 618 of file ModelData.cpp.

                                              {
  msgOut(MSG_DEBUG,"Loading forest resource to primary products io matrix..");
  LLData table = getTable("forToProd");
  for (int i=0; i< table.nrecords();i++){
    forToProd F2PDATA;
    F2PDATA.product = table.getData(i,"product");
    F2PDATA.forType = table.getData(i,"forType");
    F2PDATA.dClass = table.getData(i,"dClass");
    F2PDATA.maxYears = s2i(table.getData(i,"maxYears"));
    forToProdVector.push_back(F2PDATA);
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultSettings()

void setDefaultSettings ( )

Definition at line 194 of file ModelData.cpp.

                             {
 
  LLData table = getTable("settings");
  int nheaders = table.nheaders();
  for (int i=0; i< table.nrecords();i++){
    BasicData SETT;
    SETT.name = table.getData(i,"name");
    string type = table.getData(i,"type");
    SETT.type = getType(type);
    string region_s= table.getData(i,"region");
    SETT.regId = region_s==""?WORLD:s2i(table.getData(i,"region"));
    SETT.comment = table.getData(i,"comment");
    vector <string> values;
    for (int z=0;z<nheaders-4;z++){ // don't consider name, type, comment and region headers
      string toSearch = "value_"+i2s(z);
      string value = table.getData(i,toSearch);
      if (value != ""){
        values.push_back(value);
      }
    }
    SETT.values = values;
    programSettingsVector.push_back(SETT);
  }  
 
  msgOut(MSG_INFO,"### USING SCENARIO: "+MTHREAD->getScenarioName()+" ###");
  
  setOutputDirectory(getStringSetting("outputDirname").c_str());
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setErrorLevel()

void setErrorLevel ( int errorLevel_h )

inline

Definition at line 143 of file ModelData.h.

143{errorLevel=errorLevel_h;}

Referenced by ModelCore::computeCumulativeData(), ModelCoreSpatial::computeCumulativeData(), Output::print(), Output::printFinalOutput(), and ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

◆ setForData()

void setForData	(	const double &	value_h,
		const string &	type_h,
		const int &	regId_h,
		const string &	forType_h,
		const string &	freeDim_h,
		const int &	year = `DATA_NOW`,
		const bool &	allowCreate = `false`
	)

Definition at line 1412 of file ModelData.cpp.

                                                                                                                                                                                {
 
  vector<int> regIds;
  vector <string> dClasses;
  vector <string> fTypes;
  string key;
  DataMap::const_iterator p;
  bool found = false;
  bool tempFound = false;
 
  if (forType_h == FT_ALL){
    fTypes = getForTypeIds();
  } else {
    fTypes.push_back(forType_h);
  }
 
    if(freeDim_h == DIAM_ALL){
    dClasses = diamClasses;
    } else if (freeDim_h == DIAM_PROD){
    dClasses = getDiameterClasses(true);
    } else if (freeDim_h == DIAM_FIRST){
    dClasses.push_back(diamClasses.at(0));
  } else  {
        dClasses.push_back(freeDim_h);
  }
 
  // Make sure to set the new value to all l2 regions if requested for a reg1 level
  if(getRegion(regId_h)->getRegLevel()==2){
    regIds.push_back(regId_h);
  } else if (getRegion(regId_h)->getRegLevel()==1) {
    for(uint i=0;i<getRegion(regId_h)->getNChildren();i++){
      regIds.push_back(getRegion(regId_h)->getChildren()[i]->getRegId());
    }
  } else {
    msgOut(MSG_CRITICAL_ERROR, "Error in setProdData(). Setting a value for the whole World is not supported.");
  }
  int regIdsS = regIds.size();
 
  for(uint r=0;r< regIds.size();r++){
    for(uint i=0;i<dClasses.size();i++){
      for (uint y=0;y<fTypes.size();y++){
        key = makeKeyForData(type_h,i2s(regIds[r]),fTypes[y],dClasses[i]);
        tempFound = dataMapSetValue(forDataMap,key,value_h, year,true);
        if(tempFound) found = true;
      }
    }
  }
 
  if(!found){
    if(!allowCreate){
            msgOut(MSG_CRITICAL_ERROR, "Error in setForData: no combination found for "+type_h+", "+i2s(regId_h)+", "+forType_h+", "+i2s(year)+", "+freeDim_h+". You can allow new variables to be created using the \"allowCreate\" flag.");
    } else {
      for(uint r=0;r< regIds.size();r++){
        for(uint i=0;i<dClasses.size();i++){
          for (uint y=0;y<fTypes.size();y++){
            key = makeKeyForData(type_h,i2s(regIds[r]),fTypes[y],dClasses[i]);
            vector <double> values;
            setTimedData(value_h,values,year,MSG_NO_MSG);
            forDataMap.insert(DataPair(key,values));
          }
        }
      }
    }
  }
}

Referenced by Opt::sfd(), ModelCore::sfd(), and ModelCoreSpatial::sfd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setForestTypes()

void setForestTypes ( )

Definition at line 648 of file ModelData.cpp.

                         {
  LLData table = getTable("forTypes");
  for (int i=0; i< table.nrecords();i++){
    forType FTYPE;
    FTYPE.forTypeId = table.getData(i,"forTypeId");
    FTYPE.forLabel = table.getData(i,"forLabel");
    FTYPE.memType = s2i(table.getData(i,"memType"));
    FTYPE.forLayer = table.getData(i,"forLayer");
    FTYPE.ereditatedFrom = table.getData(i,"ereditatedFrom");
    if(FTYPE.memType == 3 && !getBoolSetting("useSpExplicitForestTypes")) continue;
    forTypes.push_back(FTYPE);
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOutputDirectory()

void setOutputDirectory ( const char * output_dirname_h )

Definition at line 990 of file ModelData.cpp.

                                                         {
 
  if (strlen(output_dirname_h)==0){
    outputDirname=baseDirectory+"output/";
  }
  else {
    outputDirname=output_dirname_h;
  }  
  MTHREAD->setOutputDirName(outputDirname); //for the GUI
}  

Referenced by setDefaultSettings(), and setScenarioSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProdData()

void setProdData	(	const double &	value_h,
		const string &	type_h,
		const int &	regId_h,
		const string &	prodId_h,
		const int &	year = `DATA_NOW`,
		const bool &	allowCreate = `false`,
		const string &	freeDim_h = `""`
	)

Basic function to set products-related data. It can change an existing value or extend in time a serie, but it requires the keys (par. name/regId/prodId/freedim) to be already present in the data. @value_h New value to change with/add It addmits the following "filters": @type_h Name of the specific parameter requested @regId_h Set a specific level 2 region, or all its childred l2 region if a reg1 level is specified. @prodId_h Product. It accept three keywords, for changing/inserting the new value to all products, primary products or secondary products, namelly PROD_ALL, PROD_PRI, PROD_SEC. @year Unless specified, set the value of the current year. If array is smaller (e.g. because it is time-independent) fill all the values till the requested one. @create If true, allow creation of new data if not found. Default false (rise an error) @freeDim_h If specified, look exactly for it, otherwise simply doesn't filter for it.

Definition at line 1352 of file ModelData.cpp.

                                                                                                                                                                                {
 
  vector<int> regIds;
  string key;
  DataMap::const_iterator p;
  vector <string> products;
 
  if(prodId_h == PROD_PRI){
    products = priProducts;
  } else if (prodId_h == PROD_SEC){
    products = secProducts;
  } else if (prodId_h == PROD_ALL){
    products = allProducts;
  } else  {
    products.push_back(prodId_h);
  }
 
  // Make sure to set the new value to all l2 regions if requested fora reg1 level
  if(getRegion(regId_h)->getRegLevel()==2){
    regIds.push_back(regId_h);
  } else if (getRegion(regId_h)->getRegLevel()==1) {
    for(uint i=0;i<getRegion(regId_h)->getNChildren();i++){
      regIds.push_back(getRegion(regId_h)->getChildren()[i]->getRegId());
    }
  } else {
    msgOut(MSG_CRITICAL_ERROR, "Error in setProdData(). Setting a value for the whole World is not supported.");
  }
 
  bool found = false;
  bool tempFound = false;
 
  for(uint r=0;r< regIds.size();r++){
    for(uint i=0;i<products.size();i++){
      key = makeKeyProdData(type_h,i2s(regIds[r]),products[i],freeDim_h);
      tempFound = dataMapSetValue(prodDataMap,key,value_h, year,true);
      if(tempFound) found = true;
    }
  }
 
  if(!found){
    if(!allowCreate){
      msgOut(MSG_CRITICAL_ERROR, "Error in setProdData: no combination found for "+type_h+", "+i2s(regId_h)+", "+prodId_h+", "+i2s(year)+", "+freeDim_h+". You can allow new variables to be created using the \"allowCreate\" flag.");
    } else {
      for(uint r=0;r< regIds.size();r++){
        for(uint i=0;i<products.size();i++){
          key = makeKeyProdData(type_h,i2s(regIds[r]),products[i],freeDim_h);
          vector <double> values;
          setTimedData(value_h,values,year,MSG_NO_MSG);
          prodDataMap.insert(DataPair(key,values));
        }
      }
    }
  }
 
}

Referenced by ModelCore::spd(), ModelCoreSpatial::spd(), and Opt::spd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setReclassificationRules()

void setReclassificationRules ( )

Definition at line 663 of file ModelData.cpp.

                                   {
 
  msgOut(MSG_DEBUG,"Loading (but not yet applying) reclassification rules..");
  LLData table = getTable("reclRules");
  for (int i=0; i< table.nrecords();i++){
    reclRule RL;
    RL.regId = s2i(table.getData(i,"regID"));
    RL.forTypeIn = table.getData(i,"forTypeIn");
    RL.forTypeOut = table.getData(i,"forTypeOut");
    RL.coeff = s2d(table.getData(i,"coeff"));
    reclRules.push_back(RL);
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setScenarioData()

void setScenarioData ( )

Set the infos about this scenario (long description and overriding tables)

Definition at line 170 of file ModelData.cpp.

                          {
  LLData table = getTable("scenarios");
  string choosenScenario = MTHREAD->getScenarioName();
  for(int i=0;i<table.nrecords();i++){
    string recordScenarioName = table.getData(i,"id");
    if (recordScenarioName == choosenScenario){
      scenario.id             = recordScenarioName;
      scenario.shortDesc      = table.getData(i,"shortDesc");
      scenario.longDesc       = table.getData(i,"longDesc");
      scenario.settingTable   = table.getData(i,"settingTable");
      scenario.forDataTable   = table.getData(i,"forDataTable");
      scenario.prodDataTable  = table.getData(i,"prodDataTable");
      scenario.forToProdTable = table.getData(i,"forToProdTable");
      scenario.pathTable      = table.getData(i,"pathTable");
      scenario.settingFile    = table.getData(i,"settingFile");
      return;
    }
  }
  msgOut(MSG_CRITICAL_ERROR, "Scenario not found!");
 
 
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setScenarioForData()

void setScenarioForData ( )

Definition at line 500 of file ModelData.cpp.

                             {
 
  if(scenario.forDataTable==""){return;}
  LLData table = getTable(scenario.forDataTable, MSG_CRITICAL_ERROR);
 
  int nheaders = table.nheaders();
  for(int i=0; i< table.nrecords(); i++){
    bool found = false;
        string key = makeKeyForData(table.getData(i,"parName"),table.getData(i,"region"),table.getData(i,"forType"),table.getData(i,"freeDim"));
    vector <double> values;
    for (int z=0;z<nheaders-4;z++){ // don't consider parName, region, forType and diamClass headers
      string toSearch = "value_"+i2s(z);
      string value = table.getData(i,toSearch);
      if (value != ""){
        values.push_back(s2d(value));
      }
    }
    map <string, vector < double > >::iterator p;
    p=forDataMap.find(key);
    if(p != forDataMap.end()) {
      // updating an existing record
      p->second = values;
    }
    else {
      // new one, adding it
      forDataMap.insert(std::pair<string, vector<double> >(key, values));
    }
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setScenarioPathogenRules()

void setScenarioPathogenRules ( )

Definition at line 706 of file ModelData.cpp.

                                   {
 
  if(scenario.pathTable==""){return;}
  LLData table = getTable(scenario.pathTable, MSG_CRITICAL_ERROR); //this scenario could not have an associated setting sheet
 
  int nheaders = table.nheaders();
  for (int i=0; i< table.nrecords();i++){
    pathRule PR;
    PR.forType = table.getData(i,"forType");
    PR.dClass = table.getData(i,"dClass");
    PR.pathId = table.getData(i,"path_name");
    PR.pres_min = s2d(table.getData(i,"pres_min"));
 
    vector <double> values;
    for (int z=0;z<nheaders-4;z++){ // don't consider forType, dClass, path_name and pres_min  headers
      string toSearch = "year_"+i2s(z);
      string value = table.getData(i,toSearch);
      if (value != ""){
        values.push_back(s2d(value));
      }
    }
    PR.mortCoefficents = values;
 
    bool found = false;
    for(uint i=0;i<pathRules.size();i++){
      if(    pathRules[i].forType == PR.forType
          && pathRules[i].dClass == PR.dClass
          && pathRules[i].pathId == PR.pathId
         ){
        pathRules[i].pres_min = PR.pres_min;
        pathRules[i].mortCoefficents = PR.mortCoefficents;
        found = true;
        break;
      }
    }
    if(!found){
      pathRules.push_back(PR);
    }
  } // end for each table record
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setScenarioProdData()

void setScenarioProdData ( )

Definition at line 561 of file ModelData.cpp.

                              {
 
  if(scenario.prodDataTable==""){return;}
  LLData table = getTable(scenario.prodDataTable, MSG_CRITICAL_ERROR); //this scenario could not have an associated setting sheet
 
  int nheaders = table.nheaders();
  int debug = table.nrecords();
  for(int i=0; i< table.nrecords(); i++){
    //prodData PDATA;
    bool found = false;
    string key = makeKeyProdData(table.getData(i,"parName"),table.getData(i,"region"),table.getData(i,"prod"),table.getData(i,"freeDim"));
 
    //PDATA.parName = table.getData(i,"parName");
    //PDATA.region = s2i(table.getData(i,"region"));
    //PDATA.prod = table.getData(i,"prod");
    //PDATA.freeDim = table.getData(i,"freeDim");
    vector <double> values;
    for (int z=0;z<nheaders-4;z++){// don't consider parName, region, prod and freeDim headers
      string toSearch = "value_"+i2s(z);
      string value = table.getData(i,toSearch);
      if (value != ""){
        values.push_back(s2d(value));
      }
    }
    //PDATA.values = values;
    //for(uint i=0;i<prodDataVector.size();i++){
    //  if(prodDataVector[i].parName == PDATA.parName
    //     && prodDataVector[i].region == PDATA.region
    //     && prodDataVector[i].prod == PDATA.prod
    //     && prodDataVector[i].freeDim == PDATA.freeDim){
    //    // existing prodData..
    //    prodDataVector[i].values = PDATA.values;
    //    found = true;
    //    break;
    //  }
    //}
    //if(!found){
    //  // new one, adding it
    //  prodDataVector.push_back(PDATA);
    //  //giving a link to it to its own region:
    //  getRegion(PDATA.region)->addProdData(&PDATA);
    //}
 
    map <string, vector < double > >::iterator p;
    p=prodDataMap.find(key);
    if(p != prodDataMap.end()) {
      // updating an existing record
      p->second = values;
    }
    else {
      // new one, adding it
      prodDataMap.insert(std::pair<string, vector<double> >(key, values));
    }
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setScenarioProductResourceMatrixLink()

void setScenarioProductResourceMatrixLink ( )

Definition at line 632 of file ModelData.cpp.

                                               {
  if(scenario.forToProdTable==""){return;}
  LLData table = getTable(scenario.forToProdTable, MSG_CRITICAL_ERROR); //this scenario could not have an associated setting sheet
 
  int nheaders = table.nheaders();
  forToProdVector.clear();
  for (int i=0; i< table.nrecords();i++){
    forToProd F2PDATA;
    F2PDATA.product = table.getData(i,"product");
    F2PDATA.forType = table.getData(i,"forType");
    F2PDATA.dClass = table.getData(i,"dClass");
    forToProdVector.push_back(F2PDATA);
  }
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setScenarioSettings()

void setScenarioSettings ( )

Definition at line 224 of file ModelData.cpp.

                              {
 
  if(scenario.settingTable=="" && scenario.settingFile=="") {return;}
  if(scenario.settingTable!="" && scenario.settingFile!="") {
   msgOut(MSG_CRITICAL_ERROR,"Scenario-specific settings has been indicated to be loaded from BOTH from the spreadsheet and a file. Choose one of them.");
  }
  LLData table(MTHREAD,"settings");
  if(scenario.settingTable!=""){
    table = getTable(scenario.settingTable, MSG_CRITICAL_ERROR); //this scenario could not have an associated setting sheet
  } else {
    table = getTableFromFile("settings",scenario.settingFile);
  }
 
 
 
  int nheaders = table.nheaders();
  for(int i=0; i< table.nrecords(); i++){
    string name = table.getData(i,"name");
    string stype = table.getData(i,"type");
    int type = getType(stype);
    string region_s= table.getData(i,"region");
    int    regId = region_s==""?WORLD:s2i(table.getData(i,"region"));
    string comment = table.getData(i,"comment");
    vector <string> values;
    for (int z=0;z<nheaders-4;z++){ // don't consider name, type and comment headers
      string toSearch = "value_"+i2s(z);
      string value = table.getData(i,toSearch);
      if (value != ""){
        values.push_back(value);
      }
    }
    bool found = false;
    for(uint i=0;i<programSettingsVector.size();i++){
      if(programSettingsVector[i].name == name && programSettingsVector[i].regId == regId){
        programSettingsVector[i].values = values;
        programSettingsVector[i].type = type;
        programSettingsVector[i].comment = comment;
        found = true;
        break;
      }
    }
    if(!found){
      BasicData SETT;
      SETT.name = name;
      SETT.type = type;
      SETT.regId = regId;
      SETT.comment = comment;
      SETT.values = values;
      programSettingsVector.push_back(SETT);
    }
 
  }
 
  setOutputDirectory(getStringSetting("outputDirname").c_str());
}

Referenced by Init::setInitLevel1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSpace()

void setSpace ( )

◆ setTempBool()

void setTempBool ( bool tempBool_h )

inline

Definition at line 146 of file ModelData.h.

146{tempBool = tempBool_h;}

Referenced by ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

◆ setTimedData()

void setTimedData	(	const double &	value_h,
		vector< double > &	dated_vector,
		const int &	year_h,
		const int &	MSG_LEVEL = `MSG_WARNING`
	)

Definition at line 1501 of file ModelData.cpp.

                                                                                                                   {
 
  int position;
  if(year_h==DATA_NOW){
    position = MTHREAD->SCD->getYear()-cached_initialYear;
  } else {
    position = year_h-cached_initialYear;
  }
 
  int originalVectorSize = dated_vector.size();
  if(dated_vector.size() > position) {
    dated_vector[position]=value_h;
  } else {
    // extending the vector and filling it with the incoming value, but issuing a warning if done for more than one year
 
    for(uint i=0;i<position-originalVectorSize+1;i++){
      dated_vector.push_back(value_h);
    }
    if(position-originalVectorSize > 0 ){
      msgOut(MSG_LEVEL, "setTimedData: a dated vector has been filled several years ("+i2s(1+position-originalVectorSize)+") with incoming values to reach desidered position in time.");
    }
  }
}

Referenced by dataMapSetValue(), setForData(), and setProdData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setValueFoundBool()

void setValueFoundBool ( bool valueFoundBool_h )

inline

Definition at line 148 of file ModelData.h.

148{valueFoundBool = valueFoundBool_h;}

◆ unpackKeyForData()

void unpackKeyForData	(	const string &	key,
		string &	parName,
		int &	regId,
		string &	forType,
		string &	diamClass
	)		const

Definition at line 1922 of file ModelData.cpp.

                                                                                                                   {
  int parNameDelimiter = key.find("#",0);
  int regIdDelimiter = key.find("#",parNameDelimiter+1);
  int forTypeDelimiter = key.find("#",regIdDelimiter+1);
  int diamClassDelimiter = key.find("#",forTypeDelimiter+1);
  if (diamClassDelimiter == string::npos){
    msgOut(MSG_CRITICAL_ERROR, "Error in unpacking a key in the map of production data.");
  }
  parName.assign(key,0,parNameDelimiter);
  string regIdString="";
  regIdString.assign(key,parNameDelimiter+1,regIdDelimiter-parNameDelimiter-1);
  regId = s2i(regIdString);
  forType.assign(key,regIdDelimiter+1,forTypeDelimiter-regIdDelimiter-1);
  diamClass.assign(key,forTypeDelimiter+1,diamClassDelimiter-forTypeDelimiter-1);
 
}

Referenced by applyOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unpackKeyProdData()

void unpackKeyProdData	(	const string &	key,
		string &	parName,
		int &	regId,
		string &	prod,
		string &	freeDim
	)		const

Definition at line 1903 of file ModelData.cpp.

                                                                                                               {
 
  int parNameDelimiter = key.find("#",0);
  int regIdDelimiter = key.find("#",parNameDelimiter+1);
  int prodDelimiter = key.find("#",regIdDelimiter+1);
  int freeDimDelimiter = key.find("#",prodDelimiter+1);
  if (freeDimDelimiter == string::npos){
    msgOut(MSG_CRITICAL_ERROR, "Error in unpacking a key in the map of production data.");
  }
  parName.assign(key,0,parNameDelimiter);
  string regIdString="";
  regIdString.assign(key,parNameDelimiter+1,regIdDelimiter-parNameDelimiter-1);
  regId = s2i(regIdString);
  prod.assign(key,regIdDelimiter+1,prodDelimiter-regIdDelimiter-1);
  freeDim.assign(key,prodDelimiter+1,freeDimDelimiter-prodDelimiter-1);
 
}

Referenced by applyOverrides().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ Output::printForestData

void Output::printForestData ( bool finalFlush )

friend

◆ Output::printProductData

void Output::printProductData ( bool finalFlush )

friend

Member Data Documentation

◆ allProducts

vector<string> allProducts

private

Definition at line 237 of file ModelData.h.

Referenced by cacheSettings(), getProdData(), and setProdData().

◆ baseDirectory

string baseDirectory

private

Definition at line 215 of file ModelData.h.

Referenced by getBaseDirectory(), getFilenameByType(), setBaseDiretory(), and setOutputDirectory().

◆ cached_initialYear

int cached_initialYear

private

Definition at line 234 of file ModelData.h.

Referenced by cacheSettings(), getCachedInitialYear(), getTimedData(), and setTimedData().

◆ deathTimberInventory

map<iisskey, double > deathTimberInventory

private

Map that register the death of biomass still usable as timber by year, l2_region, forest type and diameter class [Mm^3 wood].

Definition at line 230 of file ModelData.h.

Referenced by deathTimberInventory_get(), deathTimberInventory_incr(), deathTimberInventory_incrOrAdd(), getAvailableDeathTimber(), and getDeathTimberInventory().

◆ diamClasses

vector<string> diamClasses

private

Diameter classes.

Definition at line 233 of file ModelData.h.

Referenced by cacheSettings(), getAvailableAliveTimber(), getAvailableDeathTimber(), getDiameterClasses(), getForData(), and setForData().

◆ errorLevel

int errorLevel

private

Definition at line 244 of file ModelData.h.

Referenced by dataMapSetValue(), getErrorLevel(), getForData(), getProdData(), ModelData(), and setErrorLevel().

◆ forDataMap

map<string, vector<double> > forDataMap

private

Forestry data.

Definition at line 217 of file ModelData.h.

Referenced by applyOverrides(), getForData(), setDefaultForData(), setForData(), and setScenarioForData().

◆ forToProdVector

vector<forToProd> forToProdVector

private

Vector of coefficients from forest resources to primary products.

Definition at line 219 of file ModelData.h.

Referenced by assessProdPossibility(), getMaxYearUsableDeathTimber(), getMaxYearUsableDeathTimber(), setDefaultProductResourceMatrixLink(), and setScenarioProductResourceMatrixLink().

◆ forTypes

vector<forType> forTypes

private

Vector of forest types.

Definition at line 226 of file ModelData.h.

Referenced by getForType(), getForType(), getForTypeChilds(), getForTypeIds(), getForTypeParentId(), getForTypeParents(), getNForTypes(), getNForTypesChilds(), and setForestTypes().

◆ iFilesVector

vector<IFiles> iFilesVector

private

List of all input files. Simple (struct)

Definition at line 221 of file ModelData.h.

Referenced by getFilenameByType(), and getIFilesVector().

◆ inputFilename

string inputFilename

private

Definition at line 213 of file ModelData.h.

◆ l2r

vector< vector <int> > l2r

private

Region2 ids.

Definition at line 229 of file ModelData.h.

◆ LLDataVector

vector<LLData> LLDataVector

private

Vector of Low Level Data.

Definition at line 223 of file ModelData.h.

Referenced by getTable(), and loadInput().

◆ mainDocument

InputNode mainDocument

private

For each agricultural soil type (as defined in the setting "agrLandTypes") this list define the objects that can be placed on that soil type.

the main input document, loaded in memory at unzipping stage

Definition at line 243 of file ModelData.h.

Referenced by loadInput().

◆ outputDirname

string outputDirname

private

Definition at line 214 of file ModelData.h.

Referenced by getOutputDirectory(), and setOutputDirectory().

◆ pathRules

vector<pathRule> pathRules

private

Vector of pathogen rules.

Definition at line 228 of file ModelData.h.

Referenced by getPathMortalityRule(), setDefaultPathogenRules(), and setScenarioPathogenRules().

◆ priProducts

vector<string> priProducts

private

Definition at line 235 of file ModelData.h.

Referenced by cacheSettings(), getAllocableProductIdsFromDeathTimber(), getProdData(), and setProdData().

◆ prodDataMap

map<string, vector<double> > prodDataMap

private

Product data.

Definition at line 218 of file ModelData.h.

Referenced by applyOverrides(), getProdData(), setDefaultProdData(), setProdData(), and setScenarioProdData().

◆ programSettingsVector

vector<BasicData> programSettingsVector

private

Setting data. Simple (struct)

Definition at line 222 of file ModelData.h.

Referenced by addSetting(), applyDebugMode(), getBaseData(), getVectorBaseData(), setDefaultSettings(), and setScenarioSettings().

◆ reclRules

vector<reclRule> reclRules

private

Vector of reclassification rules.

Definition at line 227 of file ModelData.h.

Referenced by applyOverrides(), getNReclRules(), getReclRule(), and setReclassificationRules().

◆ regionsVector

vector<ModelRegion> regionsVector

private

Vector of modelled regions.

Definition at line 224 of file ModelData.h.

Referenced by applyDebugMode(), createRegions(), getAllRegions(), getRegion(), getRegionIds(), and regionExist().

◆ scenario

scenarioData scenario

Definition at line 202 of file ModelData.h.

Referenced by setScenarioData(), setScenarioForData(), setScenarioPathogenRules(), setScenarioProdData(), setScenarioProductResourceMatrixLink(), and setScenarioSettings().

◆ secProducts

vector<string> secProducts

private

Definition at line 236 of file ModelData.h.

Referenced by cacheSettings(), getProdData(), and setProdData().

◆ tempBool

bool tempBool

private

a temporary bool variable used for various functions

Definition at line 239 of file ModelData.h.

Referenced by dataMapGetValue(), getForData(), getProdData(), getTempBool(), ModelData(), and setTempBool().

◆ valueFoundBool

bool valueFoundBool

private

a bool used in getForData() and getProdData() to communicate they didn't found a variable

Definition at line 240 of file ModelData.h.

Referenced by getForData(), getProdData(), getValueFoundBool(), ModelData(), and setValueFoundBool().

The documentation for this class was generated from the following files:

/exports/ffsm/src_latest/src/ModelData.h
/exports/ffsm/src_latest/src/ModelData.cpp

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ModelData()

◆ ~ModelData()

Member Function Documentation

◆ addSetting() [1/2]

◆ addSetting() [2/2]

◆ applyDebugMode()

◆ applyOverrides()

◆ assessProdPossibility()

◆ cacheSettings()

◆ calculateAnnualisedEquivalent() [1/2]

◆ calculateAnnualisedEquivalent() [2/2]

◆ createCombinationsVector()

◆ createRegions()

◆ dataMapCheckExist()

◆ dataMapGetValue()

◆ dataMapSetValue()

◆ deathTimberInventory_get()

◆ deathTimberInventory_incr()

◆ deathTimberInventory_incrOrAdd()

◆ delDir()

◆ getAllocableProductIdsFromDeathTimber()

◆ getAllRegions()

◆ getAvailableAliveTimber()

◆ getAvailableDeathTimber()

◆ getBaseData()

◆ getBaseDirectory()

◆ getBoolSetting()

◆ getBoolVectorSetting()

◆ getCachedInitialYear()

◆ getDeathTimberInventory()

◆ getDiameterClasses()

◆ getDoubleSetting()

◆ getDoubleVectorSetting()

◆ getErrorLevel()

◆ getFilenameByType()

◆ getFilenamesByDir()

◆ getForData()

◆ getForType() [1/2]

◆ getForType() [2/2]

◆ getForTypeChilds()

◆ getForTypeChilds_pos()

◆ getForTypeCounter()

◆ getForTypeIds()

◆ getForTypeParentId()

◆ getForTypeParents()

◆ getIFilesVector()

◆ getIntSetting()

◆ getIntVectorSetting()

◆ getMaxYearUsableDeathTimber() [1/2]

◆ getMaxYearUsableDeathTimber() [2/2]

◆ getNForTypes()

◆ getNForTypesChilds()

◆ getNReclRules()

◆ getOutputDirectory()

◆ getPathMortalityRule()

◆ getProdData()

◆ getReclRule()

◆ getRegion()

◆ getRegionIds() [1/2]

◆ getRegionIds() [2/2]

◆ getScenarioIndex()

◆ getScenarios()

◆ getStringSetting()

◆ getStringVectorSetting()

◆ getTable()

◆ getTableFromFile()

◆ getTempBool()

◆ getTimedData()

◆ getValueFoundBool()

◆ getVectorBaseData()

◆ loadInput()

◆ makeKeyForData()