QFileWriter Class Reference

Inheritance diagram for QFileWriter:

List of all members.

---

Detailed Description

Abstract class for diana file writers.

Author:

Marco Vignati

Inheriting classes must implement Open(), Dump() and Close() methods, the filename, filelists etc... is completely handled by methods of this class. Inheriting classes can check for SaveAuxData() if they want to imlement this feature. The following options can be specified in QFileWriter's config files:

 SyncWithReader = true
 PartialSize = 0
 OutputDir = .
 OutputFilePrefix = QRFWriter_DEFAULT
 WriteFilesList = true
 OutputFilesList = QRFWriter_DEFAULT.list
 SaveAuxData = true
 SaveTempFiles = false
 SetListForReader = true
 

• Parameters:
  • SyncWithReader [bool = true]: if true the number of output files matches the number of input files. if false the file will be split into partials (see next option)
  • PartialSize [int = 0] Number of events per file. if 0 only one file, no partial.
  • OutputDir [string = . ]: output directory
  • OutputFilePrefix [string = QRFWriter_DEFAULT]: output file prefix, suffix is built from QRunData
  • WriteFilesList [bool = false]: write list of output files or not
  • OutputFilesList [string = QRFWriter_DEFAULT.list]: output files list name;
    N.B. if OutputFilesList = SyncWithRun the file list name will match the filename of each run and a filelist for each run will be dumped
  • SaveAuxData [bool = true] write event AuxData, not just the static event.
  • SaveTempFiles [bool = false]: save temporary files dumped in case of QSequence reiteration
  • SetListForReader [bool = true]: when reiterating over a sequence, the input of the reader is the output of the writer
  • NewPartialOnRerun [ bool = false]: don't reset partial on new iterations over a sequence, valid only if SaveTempFiles = false

Public Member Functions
	QFileWriter (const std::string &name, const std::string &extension, QSequence *s)
	Mandatory constructor.
virtual	~QFileWriter ()
	destructor
void	Init ()
	Begin method called by the framework.
QEvent *	Do (QEvent *ev)
	Process method called by the framework.
void	Done ()
	End method called by the framework.
virtual void	Open (const std::string &filename)=0
	Open File.
virtual void	Dump (const QEvent &ev)=0
	Dump ev to file.
virtual void	Close ()=0
	Close file.
Static Public Member Functions
static const std::list< std::string > &	GetFileList ()
	list of output files
Protected Member Functions
bool	SaveAuxData () const
	method for inheriting classes to check for AuxData dump
Protected Attributes
int	fEventNumber
	current event number
std::string	fFileExtension
	file extension
Private Member Functions
bool	IsToOpen (const QRunData &runData)
Private Attributes
std::list< std::string >	fFilesList
std::list< std::string >	fOldFilesList
std::string	fFileNamePrefix
	filename components
std::string	fFileId
std::string	fFileName
	fFileName = fFileNamePrefix + fFileId
std::string	fOutputDir
std::string	fFileFullPath
	fFileFullPath = fOutputDir + "/" + fFileName + fFileExtension
std::string	fFilesListName
bool	fSaveAuxData
bool	fSetListForReader
std::string	fOldFilesListName
std::string	fCurrFilesListName
bool	fWriteFilesList
bool	fSaveTempFiles
int	fPartialSize
bool	fSyncWithReader
int	fPartial
int	fCurrentRun
bool	fNewPartialOnRerun
Static Private Attributes
static std::list< std::string >	fFullPathFilesList

---

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

• /usr/local/cuore/pkg/dianaframework/QFileWriter.hh
• /usr/local/cuore/pkg/dianaframework/QFileWriter.cc

---