Nemo  2.4.2
Simulate forward-in-time genetic evolution in a spatially explicit, individual-based stochastic simulator
LCE_StatFH Class Reference

FileHandler of the LCE_StatServiceNotifier class, writes the recorded stats to txt files. More...

#include <servicenotifiers.h>

+ Inheritance diagram for LCE_StatFH:
+ Collaboration diagram for LCE_StatFH:

Public Member Functions

 LCE_StatFH ()
 
 ~LCE_StatFH ()
 
virtual vector< string > ifExist ()
 
void set_statService (StatServices *srv)
 
virtual void FHwrite ()
 
virtual void FHread (string &filename)
 
void PrintStat_byGen ()
 
- Public Member Functions inherited from FileHandler
 FileHandler (const char *ext)
 
virtual ~FileHandler ()
 
virtual void init ()
 Called by notifier during simulation setup, performs file checking. More...
 
virtual void set (bool rpl_per, bool gen_per, int rpl_occ, int gen_occ, int rank, string path)
 Sets the hanlder parameters. More...
 
virtual void set_multi (bool rpl_per, bool gen_per, int rpl_occ, TMatrix *Occ, string path)
 
virtual void update ()
 Updates the inner replicate and generation counters and calls FHwrite if needed by the the periodicity of the file. More...
 
Metapopget_pop_ptr ()
 Returns the pointer to the current metapop through the FileServices interface. More...
 
void set_pop_ptr (Metapop *pop_ptr)
 
FileServicesget_service ()
 Returns pointer to the FileServices. More...
 
void set_service (FileServices *srv)
 
std::string & get_path ()
 
void set_path ()
 
std::string & get_extension ()
 
void set_extension (const char *ext)
 
std::string & get_filename ()
 Builds and returns the current file name depending on the periodicity of the file. More...
 
bool get_isInputHandler ()
 
void set_isInputHandler (bool val)
 
bool get_isReplicatePeriodic ()
 
void set_isReplicatePeriodic (bool val)
 
unsigned int get_ReplicateOccurrence ()
 
void set_ReplicateOccurrence (unsigned int val)
 
bool get_isGenerationPeriodic ()
 
void set_isGenerationPeriodic (bool val)
 
unsigned int get_GenerationOccurrence ()
 
void set_GenerationOccurrence (unsigned int val)
 
unsigned int get_ExecRank ()
 unused yet... More...
 
void set_ExecRank (int val)
 
TMatrixget_OccMatrix ()
 
void set_OccMatrix (TMatrix *occ)
 
bool get_isMasterExec ()
 
void set_isMasterExec (bool is)
 
- Public Member Functions inherited from Handler
virtual ~Handler ()
 

Private Attributes

StatServices_statService
 

Additional Inherited Members

- Protected Attributes inherited from FileHandler
Metapop_pop
 Pointer to the current metapop, set during initialization within the init function. More...
 

Detailed Description

FileHandler of the LCE_StatServiceNotifier class, writes the recorded stats to txt files.

Constructor & Destructor Documentation

◆ LCE_StatFH()

LCE_StatFH::LCE_StatFH ( )
inline
158 : FileHandler(".txt"), _statService(0)
159 {
160  FileHandler::set(false,false,0,0,0,"");
161  set_isMasterExec(true);
162 }
void set_isMasterExec(bool is)
Definition: filehandler.h:184
virtual void set(bool rpl_per, bool gen_per, int rpl_occ, int gen_occ, int rank, string path)
Sets the hanlder parameters.
Definition: filehandler.h:195
FileHandler(const char *ext)
Definition: filehandler.h:105
StatServices * _statService
Definition: servicenotifiers.h:153

References FileHandler::set(), and FileHandler::set_isMasterExec().

◆ ~LCE_StatFH()

LCE_StatFH::~LCE_StatFH ( )
inline
164 { };

Member Function Documentation

◆ FHread()

virtual void LCE_StatFH::FHread ( string &  filename)
inlinevirtual

Implements FileHandler.

171 {}

◆ FHwrite()

void LCE_StatFH::FHwrite ( )
virtual

Implements FileHandler.

1086 {
1087  ofstream FH;
1088 
1089  string filename = get_path() + get_service()->getBaseFileName() + get_extension();
1090 
1091 #ifdef _DEBUG_
1092  message("LCE_StatFH::FHwrite (%s)\n",filename.c_str());
1093 #endif
1094 
1095  if(SIMenv::getCurrentReplicate() == 1) {
1096 
1097  FH.open(filename.c_str(),ios::trunc);
1098 
1099  if(!FH) fatal("LCE_StatFH::FHwrite:: could not open stat output file \"%s\"\n",filename.c_str());
1100 
1101  } else {
1102 
1103  FH.open(filename.c_str(),ios::app);
1104 
1105  if(!FH) fatal("LCE_StatFH::FHwrite:: could not open stat output file \"%s\"\n",filename.c_str());
1106 
1107  }
1108 
1110 
1111  FH.close();
1112 
1113  //write the stat averages to the 'bygen.txt' file if at last replicate.
1115  && SIMenv::getReplicates() > 1
1117  PrintStat_byGen();
1118 }
std::string & get_path()
Definition: filehandler.h:141
FileServices * get_service()
Returns pointer to the FileServices.
Definition: filehandler.h:137
std::string & get_extension()
Definition: filehandler.h:145
string & getBaseFileName()
Accessor to the base file name of the simulation.
Definition: fileservices.cc:473
void PrintStat_byGen()
Definition: servicenotifiers.cc:1122
static unsigned int getReplicates()
Definition: simenv.h:61
static unsigned int getCurrentReplicate()
Definition: simenv.h:60
bool getPrintAveragesOpt()
Definition: statservices.h:142
void printStatValue(ofstream &FH, unsigned int repl_idx)
Prints the stat values to the '.txt' output file.
Definition: statservices.cc:287
void fatal(const char *str,...)
Definition: output.cc:98
void message(const char *message,...)
Definition: output.cc:38

References _statService, fatal(), FileHandler::get_extension(), FileHandler::get_path(), FileHandler::get_service(), FileServices::getBaseFileName(), SIMenv::getCurrentReplicate(), StatServices::getPrintAveragesOpt(), SIMenv::getReplicates(), message(), PrintStat_byGen(), and StatServices::printStatValue().

◆ ifExist()

vector< string > LCE_StatFH::ifExist ( )
virtual

Reimplemented from FileHandler.

1051 {
1052 // bool status = true;
1053  ifstream ifExist1, ifExist2;
1054  ifExist1.setstate(ios::failbit);
1055  ifExist2.setstate(ios::failbit);
1056 
1057  //check if the basefilename is already used on disk:
1058  string filename = get_path() + get_service()->getBaseFileName() + ".txt";
1059 
1060  vector< string > list;
1061 
1062  ifExist1.open(filename.c_str(),ios::in);
1063  if(ifExist1.is_open()) {
1064 // warning("filename \"%s\" used by \"%s\"\n",get_service()->getBaseFileName().c_str(),filename.c_str());
1065  list.push_back(filename);
1066 // status = false;
1067  }
1068  ifExist1.close();
1069 
1070  filename = get_path() + get_service()->getBaseFileName() + "_bygen.txt";
1071 
1072  ifExist2.open(filename.c_str(),ios::in);
1073  if(ifExist2.is_open()) {
1074 // warning("filename \"%s\" used by \"%s\"\n",get_service()->getBaseFileName().c_str(),filename.c_str());
1075  list.push_back(filename);
1076 // status = false;
1077  }
1078  ifExist2.close();
1079 
1080  return list;
1081 }

References FileHandler::get_path(), FileHandler::get_service(), and FileServices::getBaseFileName().

◆ PrintStat_byGen()

void LCE_StatFH::PrintStat_byGen ( )
1123 {
1124  ofstream FH;
1125 
1126  string filename = get_path() + get_service()->getBaseFileName() + "_bygen.txt";
1127 
1128  FH.open(filename.c_str(),ios::trunc);
1129 
1130  if(!FH) fatal("PrintStat:: could not open stat output file\n");
1131 
1133 
1134  FH.close();
1135 }
void printStatAverage(ofstream &FH)
Definition: statservices.cc:335

References _statService, fatal(), FileHandler::get_path(), FileHandler::get_service(), FileServices::getBaseFileName(), and StatServices::printStatAverage().

Referenced by FHwrite().

+ Here is the caller graph for this function:

◆ set_statService()

void LCE_StatFH::set_statService ( StatServices srv)
inline
168 {_statService = srv;}

References _statService.

Referenced by LCE_StatServiceNotifier::loadStatServices().

+ Here is the caller graph for this function:

Member Data Documentation

◆ _statService

StatServices* LCE_StatFH::_statService
private

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

Generated for Nemo v2.4.2 by  doxygen 1.9.1

Catalogued on GSR