EventFileHandler< LCE > Class Template Reference

Template class for the LCEs StatHandler classes. More...

#include <filehandler.h>

Inheritance diagram for EventFileHandler< LCE >:

Collaboration diagram for EventFileHandler< LCE >:

Public Member Functions
	EventFileHandler (LCE *event, const char *ext)
virtual	~EventFileHandler ()
virtual void	FHwrite ()=0
virtual void	FHread (string &filename)=0
virtual void	set (bool rpl_per, bool gen_per, int rpl_occ, int gen_occ, int rank, string path, LCE *event)
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 ()

Protected Attributes
LCE *	_FHLinkedEvent
Protected Attributes inherited from FileHandler
Metapop *	_pop
	Pointer to the current metapop, set during initialization within the init function. More...

Detailed Description

template<class LCE>
class EventFileHandler< LCE >

Template class for the LCEs StatHandler classes.

Constructor links to a give LCE. The LCE can be accessed through the _SHLinkedEvent member to get the stats.

Constructor & Destructor Documentation

EventFileHandler()

template<class LCE >

EventFileHandler< LCE >::EventFileHandler	(	LCE *	event,
		const char *	ext
	)

                                                                                        :
FileHandler(ext), _FHLinkedEvent(event)
{ }

~EventFileHandler()

template<class LCE >

virtual EventFileHandler< LCE >::~EventFileHandler ( )

inlinevirtual

{}

Member Function Documentation

FHread()

template<class LCE >

virtual void EventFileHandler< LCE >::FHread ( string &  filename )

pure virtual

Implements FileHandler.

FHwrite()

template<class LCE >

virtual void EventFileHandler< LCE >::FHwrite ( )

pure virtual

Implements FileHandler.

Implemented in FHPedigreeReader, LCE_SelectionFH, FileMergerFH, and TTWolbachiaFH.

set()

template<class LCE >

void EventFileHandler< LCE >::set ( bool  rpl_per, bool  gen_per, int  rpl_occ, int  gen_occ, int  rank, string  path, LCE *  event  )

virtual

{
  FileHandler::set(rpl_per,gen_per,rpl_occ,gen_occ,rank,path);
  _FHLinkedEvent = event;
}

References FileHandler::set().

Referenced by LCE_Cross::loadFileServices(), LCE_Selection_base::loadFileServices(), LCE_FileServicesNotifier::loadFileServices(), and LCE_Breed_Wolbachia::loadFileServices().

Here is the caller graph for this function:

Member Data Documentation

_FHLinkedEvent

template<class LCE >

LCE* EventFileHandler< LCE >::_FHLinkedEvent

protected

---

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

• filehandler.h