FHLogWriter Class Reference

File Handler used to save the simulation parameters to a log file. More...

#include <filehandler.h>

Inheritance diagram for FHLogWriter:

Collaboration diagram for FHLogWriter:

Public Member Functions
	FHLogWriter ()
virtual	~FHLogWriter ()
virtual void	FHwrite ()
virtual void	FHread (string &filename)
void	createInitFile (list< ParamSet * > &params)
void	save_simparams (list< ParamSet * > &params)
void	log_message (string &logstr)
void	open_logfile4writing (ofstream &FH, ios_base::openmode flag=ios_base::out)
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 ()

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

File Handler used to save the simulation parameters to a log file.

Constructor & Destructor Documentation

FHLogWriter()

FHLogWriter::FHLogWriter ( )

inline

: FileHandler(".log"){};

~FHLogWriter()

virtual FHLogWriter::~FHLogWriter ( )

inlinevirtual

{}

Member Function Documentation

createInitFile()

void FHLogWriter::createInitFile

(

list< ParamSet * > &

params

)

{
  string file = get_service()->getBaseFileName() + ".ini"; // get_filename();
  ofstream FH;
  
  FH.open(file.c_str(), ios_base::out);
  
  list< ParamSet* >::iterator Pit = params.begin();
  char t_buff[20];
  time_t t = time(NULL);
  strftime(t_buff, 20, "%d-%m-%Y %H:%M:%S", localtime(&t));
  
  if(FH) {
    FH<<"# Nemo    v"<<MAIN_VERSION<<"."<<MINOR_VERSION<<"."<<REVISION<<RELEASE
    <<"  "<<VERSION_DATE<<endl<<"#"<<endl;
    FH<<"# init file created on "<<t_buff<<endl<<endl;
    
    while(Pit != params.end()) {
      FH<<endl;
      // !!! we have to change the run mode in the init file !!!
      if ((*Pit)->getName() == "simulation") {
        (*Pit)->get_param("run_mode")->setArg("run");
      }
      
      (*Pit)->print(FH);
      
      Pit++;
    }
    
    FH<<endl;
    FH.close();
  }
}

References FileHandler::get_service(), FileServices::getBaseFileName(), MAIN_VERSION, MINOR_VERSION, RELEASE, REVISION, and VERSION_DATE.

Referenced by FileServices::log_simparams().

Here is the caller graph for this function:

FHread()

virtual void FHLogWriter::FHread ( string &  filename )

inlinevirtual

Implements FileHandler.

{}

FHwrite()

virtual void FHLogWriter::FHwrite ( )

inlinevirtual

Implements FileHandler.

{}

log_message()

void FHLogWriter::log_message

(

string &

logstr

)

{
  ofstream FH;
  
  open_logfile4writing(FH, ios_base::app);
 
  if(FH) {
    FH<<logstr<<endl;
    FH.close();
  }
}

References open_logfile4writing().

Referenced by FileServices::log().

Here is the caller graph for this function:

open_logfile4writing()

void FHLogWriter::open_logfile4writing	(	ofstream &	FH,
		ios_base::openmode	flag = ios_base::out
	)

{
  string file = get_filename();
  
  FH.open(file.c_str(), flag);
  
  if(!FH) {
    error("FileServices::could not open simulation log file \"%s\"\n",file.c_str());
    FH.close();
  }
}

References error(), and FileHandler::get_filename().

Referenced by log_message(), and save_simparams().

Here is the caller graph for this function:

save_simparams()

void FHLogWriter::save_simparams

(

list< ParamSet * > &

params

)

{
  ofstream FH;
  
  open_logfile4writing(FH);
  
  list< ParamSet* >::iterator Pit = params.begin();
  char t_buff[20];
  time_t t = time(NULL);
  strftime(t_buff, 20, "%d-%m-%Y %H:%M:%S", localtime(&t));
  
  if(FH) {
    FH<<"# Nemo    v"<<MAIN_VERSION<<"."<<MINOR_VERSION<<"."<<REVISION<<RELEASE
    <<"  "<<VERSION_DATE<<endl<<"#"<<endl;
    FH<<"# simulation started on "<<t_buff<<endl<<endl;
    
    while(Pit != params.end()) {
      FH<<endl;
      (*Pit)->print(FH);
      Pit++;
    }
    FH<<endl;
    
    FH.close();
  }
}

References MAIN_VERSION, MINOR_VERSION, open_logfile4writing(), RELEASE, REVISION, and VERSION_DATE.

Referenced by FileServices::log_simparams().

Here is the caller graph for this function:

---

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

• filehandler.h
• filehandler.cc