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 vector< string >	ifExist ()
	Checks if any file associated with the current file name already exists on disk. 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	FHwrite ()=0
	Default behavior of the class, called by Handler::update(). More...

virtual void	FHread (string &filename)=0
	Default input function. More...

virtual void	update ()
	Updates the inner replicate and generation counters and calls FHwrite if needed by the the periodicity of the file. More...

Metapop *	get_pop_ptr ()
	Returns the pointer to the current metapop through the FileServices interface. More...

void	set_pop_ptr (Metapop *pop_ptr)

FileServices *	get_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)

TMatrix *	get_OccMatrix ()

void	set_OccMatrix (TMatrix *occ)

bool	get_isMasterExec ()

void	set_isMasterExec (bool is)

Public Member Functions inherited from Handler
virtual void	init ()=0
	Inits state. More...

virtual void	update ()=0
	Updates the handler state. More...

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

: FileHandler(".txt"), _statService(0)
{
    FileHandler::set(false,false,0,0,0,"");
    set_isMasterExec(true);
}

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

◆ ~LCE_StatFH()

LCE_StatFH::~LCE_StatFH ( )

inline

143{ };

Member Function Documentation

◆ FHread()

virtual void LCE_StatFH::FHread ( string & filename )

inlinevirtual

Implements FileHandler.

150{}

◆ FHwrite()

void LCE_StatFH::FHwrite ( )

virtual

Implements FileHandler.

{
  ofstream FH;
  
  string filename = get_path() + get_service()->getBaseFileName() + get_extension();
  
#ifdef _DEBUG_
  message("LCE_StatFH::FHwrite (%s)\n",filename.c_str());
#endif
  
  if(SIMenv::getCurrentReplicate() == 1) {
    
    FH.open(filename.c_str(),ios::trunc);    
    
    if(!FH) fatal("LCE_StatFH::FHwrite:: could not open stat output file \"%s\"\n",filename.c_str());
 
  } else {
    
    FH.open(filename.c_str(),ios::app);
    
    if(!FH) fatal("LCE_StatFH::FHwrite:: could not open stat output file \"%s\"\n",filename.c_str());
 
  }
  
  _statService->printStatValue(FH, SIMenv::getCurrentReplicate() - 1);
  
  FH.close();
  
  //write the stat averages to the 'bygen.txt' file if at last replicate.
  if(SIMenv::getCurrentReplicate() == SIMenv::getReplicates() 
     && SIMenv::getReplicates() > 1
     && _statService->getPrintAveragesOpt())
    PrintStat_byGen();
}

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.

{  
//  bool status = true;
  ifstream ifExist1, ifExist2;
  ifExist1.setstate(ios::failbit);
  ifExist2.setstate(ios::failbit);
  
  //check if the basefilename is already used on disk:
  string filename = get_path() + get_service()->getBaseFileName() + ".txt";
  
  vector< string > list;
 
  ifExist1.open(filename.c_str(),ios::in);
  if(ifExist1.is_open()) {
//    warning("filename \"%s\" used by \"%s\"\n",get_service()->getBaseFileName().c_str(),filename.c_str());
    list.push_back(filename);
//   status = false;
  }
  ifExist1.close();
  
  filename = get_path() + get_service()->getBaseFileName() + "_bygen.txt";
  
  ifExist2.open(filename.c_str(),ios::in);
  if(ifExist2.is_open()) {
//    warning("filename \"%s\" used by \"%s\"\n",get_service()->getBaseFileName().c_str(),filename.c_str());
    list.push_back(filename);
//    status = false;
  }
  ifExist2.close();
  
  return list;
}

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

◆ PrintStat_byGen()

void LCE_StatFH::PrintStat_byGen ( )

{
  ofstream FH;
  
  string filename = get_path() + get_service()->getBaseFileName() + "_bygen.txt";
  
  FH.open(filename.c_str(),ios::trunc);
  
  if(!FH) fatal("PrintStat:: could not open stat output file\n");
  
  _statService->printStatAverage(FH);
  
  FH.close();
}