Nemo  2.4.0b
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
139 : FileHandler(".txt"), _statService(0)
140 {
141  FileHandler::set(false,false,0,0,0,"");
142  set_isMasterExec(true);
143 }
void set_isMasterExec(bool is)
Definition: filehandler.h:182
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:193
FileHandler(const char *ext)
Definition: filehandler.h:107
StatServices * _statService
Definition: servicenotifiers.h:134

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

◆ ~LCE_StatFH()

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

Member Function Documentation

◆ FHread()

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

Implements FileHandler.

152 {}

◆ FHwrite()

void LCE_StatFH::FHwrite ( )
virtual

Implements FileHandler.

406 {
407  ofstream FH;
408 
409  string filename = get_path() + get_service()->getBaseFileName() + get_extension();
410 
411 #ifdef _DEBUG_
412  message("LCE_StatFH::FHwrite (%s)\n",filename.c_str());
413 #endif
414 
415  if(SIMenv::getCurrentReplicate() == 1) {
416 
417  FH.open(filename.c_str(),ios::trunc);
418 
419  if(!FH) fatal("LCE_StatFH::FHwrite:: could not open stat output file \"%s\"\n",filename.c_str());
420 
421  } else {
422 
423  FH.open(filename.c_str(),ios::app);
424 
425  if(!FH) fatal("LCE_StatFH::FHwrite:: could not open stat output file \"%s\"\n",filename.c_str());
426 
427  }
428 
430 
431  FH.close();
432 
433  //write the stat averages to the 'bygen.txt' file if at last replicate.
435  && SIMenv::getReplicates() > 1
437  PrintStat_byGen();
438 }
std::string & get_path()
Definition: filehandler.h:139
FileServices * get_service()
Returns pointer to the FileServices.
Definition: filehandler.h:135
std::string & get_extension()
Definition: filehandler.h:143
string & getBaseFileName()
Accessor to the base file name of the simulation.
Definition: fileservices.cc:446
void PrintStat_byGen()
Definition: servicenotifiers.cc:442
static unsigned int getReplicates()
Definition: simenv.h:63
static unsigned int getCurrentReplicate()
Definition: simenv.h:62
bool getPrintAveragesOpt()
Definition: statservices.h:144
void printStatValue(ofstream &FH, unsigned int repl_idx)
Prints the stat values to the '.txt' output file.
Definition: statservices.cc:289
void fatal(const char *str,...)
Definition: output.cc:96
void message(const char *message,...)
Definition: output.cc:40

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.

371 {
372 // bool status = true;
373  ifstream ifExist1, ifExist2;
374  ifExist1.setstate(ios::failbit);
375  ifExist2.setstate(ios::failbit);
376 
377  //check if the basefilename is already used on disk:
378  string filename = get_path() + get_service()->getBaseFileName() + ".txt";
379 
380  vector< string > list;
381 
382  ifExist1.open(filename.c_str(),ios::in);
383  if(ifExist1.is_open()) {
384 // warning("filename \"%s\" used by \"%s\"\n",get_service()->getBaseFileName().c_str(),filename.c_str());
385  list.push_back(filename);
386 // status = false;
387  }
388  ifExist1.close();
389 
390  filename = get_path() + get_service()->getBaseFileName() + "_bygen.txt";
391 
392  ifExist2.open(filename.c_str(),ios::in);
393  if(ifExist2.is_open()) {
394 // warning("filename \"%s\" used by \"%s\"\n",get_service()->getBaseFileName().c_str(),filename.c_str());
395  list.push_back(filename);
396 // status = false;
397  }
398  ifExist2.close();
399 
400  return list;
401 }

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

◆ PrintStat_byGen()

void LCE_StatFH::PrintStat_byGen ( )
443 {
444  ofstream FH;
445 
446  string filename = get_path() + get_service()->getBaseFileName() + "_bygen.txt";
447 
448  FH.open(filename.c_str(),ios::trunc);
449 
450  if(!FH) fatal("PrintStat:: could not open stat output file\n");
451 
453 
454  FH.close();
455 }
void printStatAverage(ofstream &FH)
Definition: statservices.cc:337

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

Referenced by FHwrite().

◆ set_statService()

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

References _statService.

Referenced by LCE_StatServiceNotifier::loadStatServices().

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.0b by  doxygen 1.9.1 -- Nemo is hosted on  Download Nemo

Locations of visitors to this page
Catalogued on GSR