BaseClass Class Reference

Base class for the regmas application. More...

#include <BaseClass.h>

Inheritance diagram for BaseClass:

Collaboration diagram for BaseClass:

Public Member Functions
	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

Protected Attributes
ThreadManager *	MTHREAD
	Pointer to the Thread manager.

Private Member Functions
void	msgOut2 (const int &msgCode_h, const string &msg_h, const bool &refreshGUI_h) const
	Do the job of the overloaded functions.

Detailed Description

Base class for the regmas application.

This class is the base class for all classes in regmas. \ It provides common methods in all parts of the application for printing the output, converting strings vs. values or regularly "ping" the GUI. \

Author

Antonello Lobianco

Definition at line 239 of file BaseClass.h.

Constructor & Destructor Documentation

BaseClass()

BaseClass

(

)

Definition at line 31 of file BaseClass.cpp.

{
  MTHREAD=NULL;
}

~BaseClass()

~BaseClass

(

)

Definition at line 36 of file BaseClass.cpp.

{
 
}

Member Function Documentation

b2s() [1/2]

string b2s

(

const bool &

bool_h

)

const

bool to string conversion

Definition at line 239 of file BaseClass.cpp.

                                       {
  if (bool_h) return "true";
  else return "false";
}

b2s() [2/2]

vector< string > b2s

(

const vector< bool > &

bool_h

)

const

bool to string conversion (vector)

Definition at line 299 of file BaseClass.cpp.

                                                {
  vector <string> valuesAsString;
  for (uint i=0;i<bool_h.size();i++){
    if(bool_h[i]) valuesAsString.push_back("true");
    else valuesAsString.push_back("false");
  }
  return valuesAsString;
}

changeMapValue()

template<typename K , typename V >

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

inline

Change the value stored in a map given the key and the new value.

Definition at line 299 of file BaseClass.h.

                                                                                                                                                   {
      typename map<K, V>::iterator p;
      p=mymap.find(key);
      if(p != mymap.end()) {
          p->second = value;
          return;
      }
      else {
          msgOut(error_level, "Error in finding a value in a map (no value found)");
      }
  }

Here is the call graph for this function:

d2s() [1/2]

string d2s

(

const double &

double_h

)

const

double to string conversion

Definition at line 229 of file BaseClass.cpp.

                                           {
  //ostringstream out;
  //out<<double_h;
  //return out.str();
  char  outChar[24];
  snprintf ( outChar, sizeof(outChar), "%f", double_h );
  return string(outChar);
}

Referenced by Layers::countMyPixels(), d2s(), Layers::filterExogenousDataset(), Gis::getAllPlotsByValue(), Gis::getAllPlotsByValue(), Gis::getRandomPlotByValue(), msgOut(), Layers::print(), Gis::printDebugValues(), ModelCoreSpatial::runBiologicalModule(), ModelCoreSpatial::runManagementModule(), ModelCoreSpatial::runMarketModule(), and Gis::setSpace().

Here is the caller graph for this function:

d2s() [2/2]

vector< string > d2s

(

const vector< double > &

double_h

)

const

double to string conversion (vector)

Definition at line 290 of file BaseClass.cpp.

                                                    {
  vector <string> valuesAsString;
  for (uint i=0;i<double_h.size();i++){
        valuesAsString.push_back(d2s(double_h[i]));
  }
  return valuesAsString;
}

Here is the call graph for this function:

debugMap() [1/2]

template<typename V >

void debugMap ( const map< iisskey, V > &  mymap )

inline

Debug a map.

Definition at line 368 of file BaseClass.h.

                                                                    {
    iisskey mykey(NULL,NULL,"","");
    debugMap(mymap, mykey);
  }

Referenced by debugMap().

Here is the call graph for this function:

Here is the caller graph for this function:

debugMap() [2/2]

template<typename K , typename V >

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

inline

Definition at line 372 of file BaseClass.h.

                                                                                        {
    cout<<"Debugging a map" << endl;
    for (auto const &themap: mymap) {
      if(themap.first.filter(key)){
       cout << themap.first.print() <<  '\t' << themap.second << endl;
      }
    }
  }

findMap()

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

inline

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

Definition at line 286 of file BaseClass.h.

                                                                                                                                                                                    {
    typename map<K, V>::const_iterator p;
    p=mymap.find(key);
    if(p != mymap.end()) {
      return p->second;
    }
    else {
      msgOut(error_level, "Error in finding a value in a map (no value found)");
      return notFoundValue;
    }
  }

Referenced by ModelData::deathTimberInventory_get(), ModelData::getAvailableDeathTimber(), Carbon::getCumSavedEmissions(), Carbon::getStock(), Carbon::HWP_eol2energy(), Output::printDetailedHV(), ModelCoreSpatial::runManagementModule(), ModelCoreSpatial::sumRegionalForData(), and ModelCoreSpatial::updateMapAreas().

Here is the call graph for this function:

Here is the caller graph for this function:

getAvg()

template<typename K >

double getAvg ( const vector< K > &  v )

inline

Returns the average of the elements in the vector.

Definition at line 399 of file BaseClass.h.

                                                             {
    return v.size()==0 ? 0.0 : vSum(v)/ ( (double) v.size() );
  }

Referenced by ModelCoreSpatial::assignSpMultiplierPropToVols().

Here is the call graph for this function:

Here is the caller graph for this function:

getMax()

template<typename K >

K getMax ( const vector< K > &  v )

inline

Returns the value of the maximum element in the vector (the last one in case of multiple equivalent maxima)

Definition at line 391 of file BaseClass.h.

                                                       {
    return *minmax_element(v.begin(), v.end()).second;
  }

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

Here is the caller graph for this function:

getMaxPos()

template<typename K >

int getMaxPos ( const vector< K > &  v )

inline

Returns the position of the maximum element in the vector (the last one in case of multiple equivalent maxima)

Definition at line 383 of file BaseClass.h.

                                                             {
    return (minmax_element(v.begin(), v.end()).second - v.begin());
  }

Referenced by ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

getMin()

template<typename K >

K getMin ( const vector< K > &  v )

inline

Returns the value of the minimum element in the vector (the first one in case of multiple equivalent minima)

Definition at line 395 of file BaseClass.h.

                                                        {
    return *minmax_element(v.begin(), v.end()).first;
  }

getMinPos()

template<typename K >

int getMinPos ( const vector< K > &  v )

inline

Returns the position of the minimum element in the vector (the first one in case of multiple equivalent minima)

Definition at line 387 of file BaseClass.h.

                                                             {
    return (minmax_element(v.begin(), v.end()).first - v.begin());
  }

getPos()

template<typename K >

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

inline

Definition at line 421 of file BaseClass.h.

                                                                                                                      {
    for(unsigned int i=0; i<v.size(); i++){
      if(v[i]== element) return i;
    }
    msgOut(msgCode_h, "Element not found in vector in getPos()");
    return -1;
  }

Referenced by ModelCoreSpatial::runManagementModule().

Here is the call graph for this function:

Here is the caller graph for this function:

getSd()

template<typename K >

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

inline

Returns the sd of the elements of a vector. Default to sample sd.

See http://stackoverflow.com/questions/7616511/calculate-mean-and-standard-deviation-from-a-vector-of-samples-in-c-using-boos where there is also an example for covariance

Definition at line 408 of file BaseClass.h.

                                                                              {
    if (v.size()==0) return 0.0;
    int sampleCorrection = sample==true?1:0;
    double sum = std::accumulate(std::begin(v), std::end(v), 0.0);
    double m =  sum / v.size();
    double accum = 0.0;
    std::for_each (std::begin(v), std::end(v), [&](const double d) {
      accum += (d - m) * (d - m);
    });
    double stdev = sqrt(accum / ( (double) (v.size()-sampleCorrection)));
    return stdev;
  }

Referenced by ModelCoreSpatial::assignSpMultiplierPropToVols().

Here is the caller graph for this function:

getType()

int getType

(

const string &

type_h

)

const

Return a type according to enum TYPE_* from a string (eg: "string" -> TYPE_STRING (2))

Definition at line 310 of file BaseClass.cpp.

                                            {
  int toReturn=0;
  if (type_h == "int")         toReturn = TYPE_INT;
  else if (type_h == "double") toReturn = TYPE_DOUBLE;
  else if (type_h == "string") toReturn = TYPE_STRING;
  else if (type_h == "bool")   toReturn = TYPE_BOOL;
  else msgOut(MSG_CRITICAL_ERROR, "Unknow type "+type_h+".");
  return toReturn;
}

Referenced by ModelData::setDefaultSettings(), and ModelData::setScenarioSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

i2s() [1/2]

string i2s

(

const int &

int_h

)

const

integer to string conversion

Definition at line 219 of file BaseClass.cpp.

                                     {
  //ostringstream out;
  //out<<int_h;
  //return out.str();
  char  outChar[24];
  snprintf ( outChar, sizeof(outChar), "%d", int_h );
  return string(outChar);
}

Referenced by Layers::addLegendItems(), ModelData::applyOverrides(), ModelCoreSpatial::assignSpMultiplierPropToVols(), Opt::calculateNumberVariablesConstrains(), LLData::clean(), ModelCoreSpatial::computeEconomicBalances(), ThreadManager::computeQuery(), Layers::countMyPixels(), Opt::eval_constraints(), Opt::eval_obj(), Opt::finalize_solution(), Opt::get_starting_point(), Gis::getAllPlotsByValue(), Opt::getBoundByIndex(), LLData::getData(), Opt::getDetailedBoundByVarAndIndex(), Opt::getDomainElements(), Pixel::getDoubleValue(), ModelData::getFilenamesByDir(), ModelData::getForData(), Pixel::getPastRegArea(), Pixel::getPathMortality(), ModelData::getProdData(), ModelData::getRegion(), Pixel::getSTData(), i2s(), ModelCore::initMarketModule(), ModelCoreSpatial::initMarketModule(), Output::initOptimisationLog(), Opt::intermediate_callback(), ModelCoreSpatial::loadExogenousForestLayers(), ModelData::loadInput(), msgOut(), Gis::pack(), Layers::print(), Layers::printBinMap(), Output::printDebugPixelValues(), Gis::printDebugValues(), Output::printDetailedHV(), Output::printOptLog(), Output::printProductData(), ModelCoreSpatial::registerCarbonEvents(), Scheduler::run(), ModelCoreSpatial::runInitPeriod(), ModelCoreSpatial::runManagementModule(), ModelCore::runMarketModule(), ModelCoreSpatial::runMarketModule(), ModelData::setDefaultForData(), ModelData::setDefaultPathogenRules(), ModelData::setDefaultProdData(), ModelData::setDefaultSettings(), ModelData::setForData(), Init::setInitLevel1(), Init::setInitLevel6(), ModelData::setProdData(), ModelData::setScenarioForData(), ModelData::setScenarioPathogenRules(), ModelData::setScenarioProdData(), ModelData::setScenarioSettings(), ModelData::setTimedData(), InputNode::setWorkingFile(), ModelCoreSpatial::sumRegionalForData(), Opt::unpack(), and ThreadManager::upgradeYearSBLabel().

i2s() [2/2]

vector< string > i2s

(

const vector< int > &

int_h

)

const

integer to string conversion (vector)

Definition at line 281 of file BaseClass.cpp.

                                              {
  vector <string> valuesAsString;
  for (uint i=0;i<int_h.size();i++){
        valuesAsString.push_back(i2s(int_h[i]));
  }
  return valuesAsString;
}

Here is the call graph for this function:

incrMapValue()

template<typename K , typename V >

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

inline

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

Definition at line 312 of file BaseClass.h.

                                                                                                                                                 {
      typename map<K, V>::iterator p;
      p=mymap.find(key);
      if(p != mymap.end()) {
          p->second = p->second + value;
          return;
      }
      else {
          msgOut(error_level, "Error in finding a value in a map (no value found)");
      }
  }

Referenced by Carbon::addSavedEmissions(), ModelData::deathTimberInventory_incr(), and ModelCoreSpatial::runManagementModule().

Here is the call graph for this function:

Here is the caller graph for this function:

incrOrAddMapValue()

template<typename K , typename V >

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

inline

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

Definition at line 325 of file BaseClass.h.

                                                                                                           {
      typename map<K, V>::iterator p;
      p=mymap.find(key);
      if(p != mymap.end()) {
          // We found the key, we gonna add the value..
          p->second = p->second + value;
          return;
      }
      else {
          // We didn't find the key, we gonna add it together with the value
          pair<K,V> myPair(key,value);
          mymap.insert(myPair);
      }
  }

Referenced by ModelData::deathTimberInventory_incrOrAdd(), Carbon::registerDeathBiomass(), Carbon::registerHarvesting(), and ModelCoreSpatial::sumRegionalForData().

Here is the caller graph for this function:

inVector()

template<typename K >

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

inline

Definition at line 429 of file BaseClass.h.

                                                                               {
     for(unsigned int i=0; i<v.size(); i++){
       if(v[i]== element) return true;
     }
     return false;
  }

Referenced by ModelData::getForTypeParents().

Here is the caller graph for this function:

msgOut() [1/3]

void msgOut	(	const int &	msgCode_h,
		const double &	msg_h,
		const bool &	refreshGUI_h = true
	)		const

Overloaded function to print the output log.

Overloaded method for the output log:

Parameters

msgCode_h	MSG_DEBUG, MSG_INFO, MSG_WARNING, MSG_ERROR, MSG_CRITICAL_ERROR
msg_h	message text (double)
refreshGUI_h	use this call to "ping" the GUI (optional, default=true)

Definition at line 78 of file BaseClass.cpp.

                                                                                           {
  msgOut2(msgCode_h, d2s(msg_h), refreshGUI_h);
 
}

Here is the call graph for this function:

msgOut() [2/3]

void msgOut	(	const int &	msgCode_h,
		const int &	msg_h,
		const bool &	refreshGUI_h = true
	)		const

Overloaded function to print the output log.

Overloaded method for the output log:

Parameters

msgCode_h	MSG_DEBUG, MSG_INFO, MSG_WARNING, MSG_ERROR, MSG_CRITICAL_ERROR
msg_h	message text (int)
refreshGUI_h	use this call to "ping" the GUI (optional, default=true)

Definition at line 65 of file BaseClass.cpp.

                                                                                        {
  msgOut2(msgCode_h, i2s(msg_h), refreshGUI_h);
}

Here is the call graph for this function:

msgOut() [3/3]

void msgOut	(	const int &	msgCode_h,
		const string &	msg_h,
		const bool &	refreshGUI_h = true
	)		const

Overloaded function to print the output log.

Overloaded method for the output log:

Parameters

msgCode_h	MSG_DEBUG, MSG_INFO, MSG_WARNING, MSG_ERROR, MSG_CRITICAL_ERROR
msg_h	message text (string)
refreshGUI_h	use this call to "ping" the GUI (optional, default=true)

Definition at line 50 of file BaseClass.cpp.

                                                                                           {
 
  msgOut2(msgCode_h, msg_h, refreshGUI_h);
 
}

Referenced by Gis::addLayer(), Layers::addLegendItem(), Gis::addLegendItem(), Layers::addLegendItems(), Carbon::addSavedEmissions(), ModelData::addSetting(), ModelData::applyOverrides(), Gis::applySpatialStochasticValues(), ModelCoreSpatial::assignSpMultiplierPropToVols(), Opt::buildPositionVector(), ModelCoreSpatial::cacheDynamicSettings(), ModelCoreSpatial::cachePixelExogenousData(), ModelCore::cacheSettings(), ModelCoreSpatial::cacheSettings(), Opt::calculateNumberVariablesConstrains(), changeMapValue(), Pixel::changeValue(), LLData::clean(), Output::cleanScenario(), ModelCore::computeCumulativeData(), ModelCoreSpatial::computeCumulativeData(), ModelCore::computeInventary(), ModelCoreSpatial::computeInventary(), Gis::countItems(), Layers::countMyPixels(), ModelData::delDir(), Layers::filterExogenousDataset(), Opt::finalize_solution(), findMap(), Opt::gdt(), Opt::get_starting_point(), Gis::getAllPlots(), Gis::getAllPlotsByValue(), Gis::getAllPlotsByValue(), ModelRegion::getArea(), ModelRegion::getArea(), ModelData::getBaseData(), InputNode::getBoolContent(), Opt::getBoundByIndex(), Opt::getConNumber(), Opt::getConstrainByIndex(), Opt::getConstrainDirectionByIndex(), Carbon::getCumSavedEmissions(), LLData::getData(), Opt::getDomainElements(), InputNode::getDoubleAttributeByName(), Pixel::getDoubleValue(), ModelData::getFilenamesByDir(), ModelData::getForData(), ModelData::getForType(), ModelData::getForTypeCounter(), ModelData::getForTypeParentId(), InputNode::getIntAttributeByName(), Gis::getLayer(), ModelData::getMaxYearUsableDeathTimber(), Pixel::getMyRegion(), InputNode::getNodeByName(), InputNode::getNodesByName(), Output::getOutputFieldDelimiter(), Pixel::getPastRegArea(), Pixel::getPixelsAtDistLevel(), getPos(), ModelData::getProdData(), Gis::getRandomPlotByValue(), ModelData::getRegion(), ModelData::getScenarioIndex(), Sandbox::getSetting(), Pixel::getSpModifier(), Carbon::getStock(), InputNode::getStringAttributeByName(), ModelData::getTable(), ModelData::getTableFromFile(), ModelData::getTimedData(), getType(), ModelRegion::getValue(), ModelData::getVectorBaseData(), Opt::gip(), Opt::gix(), Opt::gix_uncached(), incrMapValue(), Output::initCarbonBalance(), Output::initDebugOutput(), Output::initDebugPixelValues(), Carbon::initialiseDeathBiomassStocks(), Carbon::initialiseProductsStocks(), ModelCoreSpatial::initializePixelArea(), ModelCoreSpatial::initializePixelVolumes(), Gis::initLayers(), ModelCore::initMarketModule(), ModelCoreSpatial::initMarketModule(), Output::initOptimisationLog(), Output::initOutputForestData(), Output::initOutputMaps(), Output::initOutputProductData(), Opt::intermediate_callback(), ModelData::loadInput(), Gis::loadLayersDataFromFile(), normSample(), normSample(), Layers::print(), Gis::printBinMaps(), Output::printCarbonBalance(), Output::printDebugOutput(), Output::printDebugPixelValues(), Gis::printDebugValues(), Output::printDetailedHV(), Output::printForestData(), Gis::printLayers(), Output::printOptLog(), Output::printProductData(), ModelData::regSName2RegId(), Gis::resetLayer(), ModelCoreSpatial::resetPixelValues(), Scheduler::run(), ModelCore::runBiologicalModule(), ModelCoreSpatial::runBiologicalModule(), ModelCoreSpatial::runInitPeriod(), ModelCore::runManagementModule(), ModelCoreSpatial::runManagementModule(), ModelCore::runMarketModule(), ModelCoreSpatial::runMarketModule(), s2b(), s2d(), ModelData::setDefaultForData(), ModelData::setDefaultPathogenRules(), ModelData::setDefaultProdData(), ModelData::setDefaultProductResourceMatrixLink(), ModelData::setDefaultSettings(), ModelData::setForData(), Init::setInitLevel(), Init::setInitLevel1(), Init::setInitLevel6(), Pixel::setPastRegArea(), ModelData::setProdData(), ModelData::setReclassificationRules(), ModelData::setScenarioData(), ModelData::setScenarioSettings(), Gis::setSpace(), ModelData::setTimedData(), InputNode::setWorkingFile(), ModelCoreSpatial::sumRegionalForData(), Pixel::swap(), Gis::unpack(), Opt::unpack(), ModelData::unpackKeyForData(), ModelData::unpackKeyProdData(), Gis::updateImage(), ModelCore::updateMapAreas(), and ModelCoreSpatial::updateMapAreas().

Here is the call graph for this function:

msgOut2()

void msgOut2 ( const int &  msgCode_h, const string &  msg_h, const bool &  refreshGUI_h  ) const

private

Do the job of the overloaded functions.

Convenient (private) function to actually do the job of the overloaded functions

Definition at line 88 of file BaseClass.cpp.

                                                                                            {
 
  string prefix;
  switch (msgCode_h){
  case MSG_NO_MSG:
    return;
  case MSG_DEBUG:
    prefix="*DEBUG: ";
    break;
  case MSG_INFO:
    prefix="**INFO: ";
    break;
  case MSG_WARNING:
    prefix="**WARNING: ";
    break;
  case MSG_ERROR:
    prefix="***ERROR: ";
    break;
  case MSG_CRITICAL_ERROR:
    prefix="****CRITICAL ERROR: ";
    break;
  default:
    cerr<<"I got an unknow error code: "<<msgCode_h<<" ("<<msg_h<<")"<<endl;
    exit(EXIT_FAILURE);
  }
 
  string message = prefix+msg_h;
  if (MTHREAD && MTHREAD->usingGUI()){
    MTHREAD->msgOut(msgCode_h, message);
  }
  else {
    string totalMsg = prefix+msg_h;
    cout<< totalMsg <<endl;
  }
 
  if(refreshGUI_h) {refreshGUI();}
 
  //if(msgCode_h==MSG_CRITICAL_ERROR){
  //  if (MTHREAD && MTHREAD->usingGUI()){
  //    throw(2);
  //  }
  //  else {
  //    throw(2);
  //    exit(EXIT_FAILURE);
  //  }
  //}
 
  if(msgCode_h==MSG_CRITICAL_ERROR){ // I can't throw an exception for any case, as code would resume from where it has been caught, not from here..
    throw(msgCode_h);
  }
 
}

Referenced by msgOut(), msgOut(), and msgOut().

Here is the call graph for this function:

Here is the caller graph for this function:

normSample() [1/2]

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).

It doesn't require the normal_distribution to be passed to it, but due to including MTHREAD its definition can't be placed in the header and hence it can not be templated, so it works only with doubles.

Definition at line 330 of file BaseClass.cpp.

                                                                                                              {
  if(minval != NULL  && maxval != NULL){
    if (maxval <= minval){
      msgOut(MSG_CRITICAL_ERROR,"Error in normSample: the maxvalue is lower than the minvalue");
    }
  }
  for(;;){
    normal_distribution<double> d(avg,stdev);
    double c = d(*MTHREAD->gen);
    if( (minval == NULL || c >= minval) && (maxval == NULL || c <= maxval) ){
      return c;
    }
  }
  return minval;
}

Referenced by Gis::applySpatialStochasticValues().

Here is the call graph for this function:

Here is the caller graph for this function:

normSample() [2/2]

template<typename K >

K normSample ( normal_distribution< K > &  d, std::mt19937 &  gen, const K &  minval = NULL, const K &  maxval = NULL  ) const

inline

Sample from a normal distribution with bounds. Faster (half time) as the normal_distribution is made only once.

Definition at line 443 of file BaseClass.h.

                                                                                                                                    {
    if(minval != NULL  && maxval != NULL){
      if (maxval <= minval){
        msgOut(MSG_CRITICAL_ERROR,"Error in normSample: the maxvalue is lower than the minvalue");
      }
    }
    for(;;){
      K c = d(gen);
      if( (minval == NULL || c >= minval) && (maxval == NULL || c <= maxval) ){
        return c;
      }
    }
    return minval;
  }

Here is the call graph for this function:

positionsToContent()

template<typename T >

vector< T > positionsToContent ( const vector< T > &  vector_h, const vector< int > &  positions  )

inline

Return a vector of content from a vector and a vector of positions (int)

Definition at line 359 of file BaseClass.h.

                                                                                                                {
      vector <T> toReturn;
      for(uint i=0; i<positions.size(); i++){
          toReturn.push_back(vector_h.at(positions[i]));
      }
      return toReturn;
  }

Referenced by ModelCoreSpatial::computeInventary().

Here is the caller graph for this function:

refreshGUI()

void refreshGUI

(

)

const

Ping to periodically return the control to the GUI.

Definition at line 142 of file BaseClass.cpp.

                          {
  if (MTHREAD && MTHREAD->usingGUI()){
    MTHREAD->refreshGUI();
  }
}

Referenced by Gis::applyForestReclassification(), Gis::loadLayersDataFromFile(), msgOut2(), MainProgram::run(), and Gis::updateImage().

Here is the call graph for this function:

Here is the caller graph for this function:

resetMapValues()

template<typename K , typename V >

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

inline

Reset all values stored in a map to the specified one.

Definition at line 341 of file BaseClass.h.

                                                                                          {
      typename map<K, V>::iterator p;
      for(p=mymap.begin(); p!=mymap.end(); p++) {
          p->second =value;
      }
  }

Referenced by ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

s2b() [1/2]

bool s2b

(

const string &

string_h

)

const

string to bool conversion

Includes conversion checks.

Definition at line 208 of file BaseClass.cpp.

                                            {
  if (string_h == "true" || string_h == "vero" || string_h == "TRUE" || string_h == "VRAI" || string_h == "1" || string_h == "True")
    return true;
  else if (string_h == "false" || string_h == "falso" || string_h == "FALSE" || string_h == "FAUX" || string_h == "0" || string_h == "" || string_h == "False")
    return false;
 
  msgOut(MSG_CRITICAL_ERROR,"Conversion string to bool failed. Some problems with the data? (got\""+string_h+"\")");
  return true;
}

Referenced by ModelData::createRegions(), ModelData::getBoolSetting(), ModelData::getBoolVectorSetting(), and s2b().

Here is the call graph for this function:

Here is the caller graph for this function:

s2b() [2/2]

vector< bool > s2b

(

const vector< string > &

string_h

)

const

string to bool conversion (vector)

Includes conversion checks.

Definition at line 272 of file BaseClass.cpp.

                                                   {
  vector <bool> valuesAsBool;
  for (uint i=0;i<string_h.size();i++){
    valuesAsBool.push_back(s2b(string_h[i]));
  }
  return valuesAsBool;
}

Here is the call graph for this function:

s2d() [1/3]

double s2d

(

const string &

string_h

)

const

string to double conversion

Definition at line 171 of file BaseClass.cpp.

                                            {
  if (string_h == "") return 0.;
  double valueAsDouble;
  istringstream totalSString( string_h );
  totalSString >> valueAsDouble;
  return valueAsDouble;
  /*
  if (string_h == "") return 0.;
  try {
    return stod(string_h); // stod want dot as decimal separator in console mode and comma in gui mode. Further the decimal digits left are only 2 !!
  } catch (...) {
    if (string_h == "") return 0.;
    else {
      msgOut(MSG_CRITICAL_ERROR,"Conversion string to double failed. Some problems with the data? (got\""+string_h+"\")");
    }
  }
  return 0.;
  */
}

Referenced by ModelData::getDoubleSetting(), ModelData::getDoubleVectorSetting(), s2d(), s2d(), ModelData::setDefaultForData(), ModelData::setDefaultPathogenRules(), ModelData::setDefaultProdData(), ModelData::setReclassificationRules(), ModelData::setScenarioForData(), ModelData::setScenarioPathogenRules(), and ModelData::setScenarioProdData().

Here is the caller graph for this function:

s2d() [2/3]

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

string to double conversion

Includes comma to dot conversion if needed.

Definition at line 194 of file BaseClass.cpp.

                                                                       {
  if(replaceComma){
    string valueAsString = string_h;
    // replace commas with dots. This is not needed when directly reading the input nodes as double, as the Qt function to Double does the same.
    replace(valueAsString.begin(), valueAsString.end(), ',', '.');
    return s2d(valueAsString);
  }
  return s2d(string_h);
  msgOut(MSG_CRITICAL_ERROR, "debug me please!");
  return 0.;
}

Here is the call graph for this function:

s2d() [3/3]

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

string to double conversion (vector)

Includes comma to dot conversion if needed.

Definition at line 255 of file BaseClass.cpp.

                                                                              {
  vector <double> valuesAsDouble;
  for (uint i=0;i<string_h.size();i++){
    if(replaceComma){
      string valueAsString = string_h[i];
      // replace commas with dots. This is not needed when directly reading the input nodes as double, as the Qt function to Double does the same.
      replace(valueAsString.begin(), valueAsString.end(), ',', '.');
      valuesAsDouble.push_back(s2d(valueAsString));
    } else {
      valuesAsDouble.push_back(s2d(string_h[i]));
    }
  }
  return valuesAsDouble;
}

Referenced by s2d().

Here is the call graph for this function:

Here is the caller graph for this function:

s2i() [1/2]

int s2i

(

const string &

string_h

)

const

string to integer conversion

Definition at line 149 of file BaseClass.cpp.

                                             {
  if (string_h == "") return 0;
  int valueAsInteger;
  stringstream ss(string_h);
  ss >> valueAsInteger;
  return valueAsInteger;
  /*
  // I can't use stoi as of bug in MinGW
  try {
    return stoi(string_h);
  } catch (...) {
    if (string_h == "") return 0;
    else {
      msgOut(MSG_CRITICAL_ERROR,"Conversion string to integer failed. Some problems with the data? (got\""+string_h+"\")");
    }
  }
  return 0;
  */
 
}

Referenced by ModelData::createRegions(), ModelData::getIntSetting(), ModelData::getIntVectorSetting(), s2i(), ModelData::setDefaultProductResourceMatrixLink(), ModelData::setDefaultSettings(), ModelData::setForestTypes(), ModelData::setReclassificationRules(), ModelData::setScenarioSettings(), Gis::unpack(), ModelData::unpackKeyForData(), and ModelData::unpackKeyProdData().

Here is the caller graph for this function:

s2i() [2/2]

vector< int > s2i

(

const vector< string > &

string_h

)

const

string to integer conversion (vector)

Definition at line 245 of file BaseClass.cpp.

                                                    {
  vector <int> valuesAsInteger;
  for (uint i=0;i<string_h.size();i++){
    valuesAsInteger.push_back(s2i(string_h[i]));
  }
  return valuesAsInteger;
}

Here is the call graph for this function:

stringTo()

template<typename T >

T stringTo

(

const std::string &

s

)

const

Definition at line 348 of file BaseClass.cpp.

                                            {
  std::istringstream iss(s);
  T x;
  iss >> x;
  return x;
}

tokenize()

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

Tokenize a string using a delimiter (default is space)

Definition at line 374 of file BaseClass.cpp.

                                                                                            {
    // Skip delimiters at beginning.
    string::size_type lastPos = str.find_first_not_of(delimiter, 0);
    // Find first "non-delimiter".
    string::size_type pos     = str.find_first_of(delimiter, lastPos);
 
    while (string::npos != pos || string::npos != lastPos)
    {
        // Found a token, add it to the vector.
        tokens.push_back(str.substr(lastPos, pos - lastPos));
        // Skip delimiters.  Note the "not_of"
        lastPos = str.find_first_not_of(delimiter, pos);
        // Find next "non-delimiter"
        pos = str.find_first_of(delimiter, lastPos);
    }
}

Referenced by Output::cleanScenario().

Here is the caller graph for this function:

toString() [1/2]

template<typename T >

std::string toString

(

const T &

x

)

const

Definition at line 322 of file BaseClass.cpp.

                                    {
  std::ostringstream oss;
  oss << x;
  return oss.str();
}

toString() [2/2]

template<typename T >

string toString

(

const T &

x

)

const

untokenize()

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

Definition at line 392 of file BaseClass.cpp.

                                                                                        {
  // add initial loken in str is not empty
  if(str != ""){
    str += delimiter;
  }
  for(int i=0;i<tokens.size();i++){
    str += tokens[i];
    // don't add final delimiter
    if(i != (tokens.size()-1)){
       str += delimiter;
    }
  }
}

vectorToMap()

template<typename K , typename V >

map< K, V > vectorToMap ( const vector< K > &  keys, const V &  value = 0.0  )

inline

Returns a map built using the given vector and the given (scalar) value as keys/values pairs.

Definition at line 349 of file BaseClass.h.

                                                                                                      {
      map<K,V> returnMap;
      for(unsigned int i=0; i<keys.size();i++){
          pair<K,V> apair(keys[i],value);
          returnMap.insert(apair);
      }
      return returnMap;
  }

Referenced by ModelCoreSpatial::runManagementModule().

Here is the caller graph for this function:

vSum() [1/4]

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

inline

Definition at line 277 of file BaseClass.h.

{return accumulate(vector_h.begin(),vector_h.end(),0.);};

vSum() [2/4]

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

inline

Definition at line 276 of file BaseClass.h.

{return accumulate(vector_h.begin(),vector_h.end(),0);};

Referenced by ModelCoreSpatial::assignSpMultiplierPropToVols(), ModelRegion::getArea(), ModelRegion::getArea(), getAvg(), ModelCoreSpatial::initializePixelArea(), ModelCoreSpatial::loadExogenousForestLayers(), Output::printDebugPixelValues(), ModelCoreSpatial::runManagementModule(), ModelCoreSpatial::sumRegionalForData(), ModelCoreSpatial::updateMapAreas(), and ModelCoreSpatial::updateOtherMapData().

Here is the caller graph for this function:

vSum() [3/4]

double vSum

(

const vector< vector< double > > &

vector_h

)

const

Definition at line 365 of file BaseClass.cpp.

                                                             {
  double toReturn = 0.0;
  for(vector < vector<double> >::const_iterator j=vector_h.begin();j!=vector_h.end();++j){
    toReturn += accumulate(j->begin(),j->end(),0.0);
  }
  return toReturn;
}

vSum() [4/4]

int vSum

(

const vector< vector< int > > &

vector_h

)

const

Definition at line 356 of file BaseClass.cpp.

                                                           {
  int toReturn = 0;
  for(vector < vector<int> >::const_iterator j=vector_h.begin();j!=vector_h.end();++j){
    toReturn += accumulate(j->begin(),j->end(),0);
  }
  return toReturn;
}

Member Data Documentation

MTHREAD

ThreadManager* MTHREAD

protected

Pointer to the Thread manager.

Through this pointer each derived subclass (the vast maiority of those used on FFSM) can "ask" for sending signals to the GUI, like append the log or modify the map.

Definition at line 467 of file BaseClass.h.

Referenced by Gis::addLayer(), ModelCoreSpatial::allocateHarvesting(), ModelCore::app(), ModelCoreSpatial::app(), Opt::app(), Gis::applyForestReclassification(), Gis::applySpatialStochasticValues(), Gis::applyStochasticRiskAdversion(), ModelCoreSpatial::assignSpMultiplierPropToVols(), BaseClass(), ModelCoreSpatial::cacheDynamicSettings(), ModelCoreSpatial::cachePixelExogenousData(), ModelCore::cacheSettings(), ModelCoreSpatial::cacheSettings(), Carbon::Carbon(), Pixel::changeValue(), Output::commonInit(), ModelCore::computeCumulativeData(), ModelCoreSpatial::computeCumulativeData(), ModelCoreSpatial::computeEconomicBalances(), ModelCore::computeInventary(), ModelCoreSpatial::computeInventary(), Opt::copyInventoryResourses(), Layers::countMyPixels(), ModelData::createRegions(), Opt::eval_constraints(), Opt::get_nlp_info(), ModelData::getAllocableProductIdsFromDeathTimber(), Gis::getAllPlots(), Gis::getAllPlotsByRegion(), ModelRegion::getArea(), ModelRegion::getArea(), ModelData::getAvailableAliveTimber(), ModelData::getBaseData(), ModelData::getBoolSetting(), ModelData::getBoolVectorSetting(), Layers::getCategory(), Layers::getColor(), ModelData::getDoubleSetting(), Pixel::getDoubleValue(), Pixel::getDoubleValue(), ModelData::getDoubleVectorSetting(), ModelData::getIntSetting(), ModelData::getIntVectorSetting(), Pixel::getMultiplier(), Output::getOutputFieldDelimiter(), Pixel::getPathMortality(), Pixel::getPixelsAtDistLevel(), ModelData::getRegionIds(), ModelData::getScenarioIndex(), ModelRegion::getSiblings(), Pixel::getSpModifier(), Pixel::getSTData(), Carbon::getStock(), ModelData::getStringSetting(), ModelData::getStringVectorSetting(), ModelData::getTable(), ModelData::getTableFromFile(), ModelData::getTimedData(), ModelCoreSpatial::getVHaByYear(), Opt::gfd(), ModelCore::gfd(), ModelCoreSpatial::gfd(), Gis::Gis(), ModelCore::gpd(), ModelCoreSpatial::gpd(), Opt::gpd(), Carbon::HWP_eol2energy(), Init::Init(), ModelCoreSpatial::initialiseCarbonModule(), Carbon::initialiseDeathBiomassStocks(), ModelCoreSpatial::initialiseDeathTimber(), Carbon::initialiseEmissionCounters(), Carbon::initialiseProductsStocks(), ModelCoreSpatial::initializePixelArea(), ModelCoreSpatial::initializePixelVolumes(), Gis::initLayers(), Gis::initLayersPixelData(), Output::initOutputForestData(), Layers::Layers(), LLData::LLData(), ModelCoreSpatial::loadExogenousForestLayers(), ModelData::loadInput(), Gis::loadLayersDataFromFile(), MainProgram::MainProgram(), ModelCore::ModelCore(), ModelCoreSpatial::ModelCoreSpatial(), ModelData::ModelData(), ModelRegion::ModelRegion(), msgOut2(), normSample(), Opt::Opt(), Output::Output(), Pixel::Pixel(), Layers::print(), Output::print(), Layers::printBinMap(), Gis::printBinMaps(), Output::printCarbonBalance(), Output::printDebugOutput(), Output::printDebugPixelValues(), Output::printDetailedHV(), Output::printFinalOutput(), Output::printForestData(), Gis::printLayers(), Output::printMaps(), Output::printOptLog(), Output::printProductData(), Layers::randomShuffle(), refreshGUI(), ModelData::regId2RegSName(), ModelCoreSpatial::registerCarbonEvents(), Carbon::registerDeathBiomass(), Carbon::registerHarvesting(), Carbon::registerProducts(), Carbon::registerTransports(), ModelData::regSName2RegId(), ModelCoreSpatial::resetPixelValues(), MainProgram::run(), Scheduler::run(), ModelCore::runBiologicalModule(), ModelCoreSpatial::runBiologicalModule(), ModelCore::runInitPeriod(), ModelCoreSpatial::runInitPeriod(), ModelCore::runManagementModule(), ModelCoreSpatial::runManagementModule(), ModelCore::runMarketModule(), ModelCoreSpatial::runMarketModule(), ModelCore::runSimulationYear(), ModelCoreSpatial::runSimulationYear(), Sandbox::Sandbox(), Scheduler::Scheduler(), ModelData::setDefaultSettings(), Init::setInitLevel1(), Init::setInitLevel3(), Init::setInitLevel5(), Init::setInitLevel6(), ModelRegion::setMyPixels(), ModelData::setOutputDirectory(), ModelData::setScenarioData(), ModelData::setScenarioSettings(), Gis::setSpace(), ModelData::setTimedData(), Opt::sfd(), ModelCore::sfd(), ModelCoreSpatial::sfd(), ModelCore::spd(), ModelCoreSpatial::spd(), Opt::spd(), ModelCoreSpatial::sumRegionalForData(), Gis::updateImage(), ModelCore::updateMapAreas(), ModelCoreSpatial::updateMapAreas(), and ModelCoreSpatial::updateOtherMapData().

---

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

• /exports/ffsm/src_latest/src/BaseClass.h
• /exports/ffsm/src_latest/src/BaseClass.cpp