BDSOutputROOTEventHeader Class Reference

Information about the software and the file. More...

#include <BDSOutputROOTEventHeader.hh>

Inheritance diagram for BDSOutputROOTEventHeader:

Collaboration diagram for BDSOutputROOTEventHeader:

Public Member Functions
	BDSOutputROOTEventHeader (const BDSOutputROOTEventHeader &)=default
virtual void	Flush ()
void	FlushLocal ()
	We have a non-virtual version as it's bad to call this from a constructor.
void	SetFileType (const std::string &fileTypeIn)
	Update the file type.
void	Fill (const std::vector< std::string > &analysedFilesIn=std::vector< std::string >(), const std::vector< std::string > &combinedFilesIn=std::vector< std::string >())
void	FillGeant4Side ()
	Fill with information from Geant4 side of things.
	ClassDef (BDSOutputROOTEventHeader, 5)

Data Fields
std::string	bdsimVersion
std::string	geant4Version
std::string	rootVersion
std::string	clhepVersion
std::string	timeStamp
std::string	fileType
int	dataVersion
	Our data format version.
bool	doublePrecisionOutput
	Whether using double precision output - assumed float if not.
std::vector< std::string >	analysedFiles
	List of which files were analysed in case of a rebdsim output file.
std::vector< std::string >	combinedFiles
	List of which files were combined in case of a rebdsimCombine output file.
int	nTrajectoryFilters
	Length of bitset used for trajectory filtering - compile time info.
std::vector< std::string >	trajectoryFilters
	Names of filters.
bool	skimmedFile
	Whether this is a skimmed output file.
unsigned long long int	nOriginalEvents
	Number of original events if skimmed.
unsigned long long int	nEventsRequested
	Number of events requested to be simulated from the file.
unsigned long long int	nEventsInFile
	Number of events in the input distribution file irrespective of filters.
unsigned long long int	nEventsInFileSkipped
	Number of events from distribution file that were skipped due to filters.
unsigned int	distrFileLoopNTimes
	Number of times a distribution file was replayed.

Detailed Description

Information about the software and the file.

Author

Laurie Nevay

Definition at line 34 of file BDSOutputROOTEventHeader.hh.

Constructor & Destructor Documentation

~BDSOutputROOTEventHeader()

BDSOutputROOTEventHeader::~BDSOutputROOTEventHeader ( )

virtual

Definition at line 41 of file BDSOutputROOTEventHeader.cc.

Member Function Documentation

Fill()

void BDSOutputROOTEventHeader::Fill	(	const std::vector< std::string > &	analysedFilesIn = std::vector<std::string>(),
		const std::vector< std::string > &	combinedFilesIn = std::vector<std::string>()
	)

#ifndef ROOTBUILD Nominally, we don't expose the fill methods to the analysis root dictionaries but as this doesn't use geant4 and is required when creating analysis output file, we break that convention.

Definition at line 71 of file BDSOutputROOTEventHeader.cc.

References analysedFiles, combinedFiles, and FillGeant4Side().

Referenced by RBDS::CreateEmptyRebdsimFile(), and BDSOutput::FillHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

FillGeant4Side()

void BDSOutputROOTEventHeader::FillGeant4Side

(

)

Fill with information from Geant4 side of things.

Definition at line 85 of file BDSOutputROOTEventHeader.cc.

References nTrajectoryFilters, and trajectoryFilters.

Referenced by Fill().

Here is the caller graph for this function:

Flush()

virtual void BDSOutputROOTEventHeader::Flush ( )

inlinevirtual

Definition at line 40 of file BDSOutputROOTEventHeader.hh.

FlushLocal()

void BDSOutputROOTEventHeader::FlushLocal

(

)

We have a non-virtual version as it's bad to call this from a constructor.

Definition at line 44 of file BDSOutputROOTEventHeader.cc.

References analysedFiles, combinedFiles, dataVersion, distrFileLoopNTimes, doublePrecisionOutput, nEventsInFile, nEventsInFileSkipped, nEventsRequested, nOriginalEvents, nTrajectoryFilters, skimmedFile, and trajectoryFilters.

SetFileType()

void BDSOutputROOTEventHeader::SetFileType ( const std::string &  fileTypeIn )

inline

Update the file type.

Definition at line 65 of file BDSOutputROOTEventHeader.hh.

Referenced by RBDS::CreateEmptyRebdsimFile().

Here is the caller graph for this function:

Field Documentation

analysedFiles

std::vector<std::string> BDSOutputROOTEventHeader::analysedFiles

List of which files were analysed in case of a rebdsim output file.

Definition at line 53 of file BDSOutputROOTEventHeader.hh.

Referenced by Fill(), and FlushLocal().

bdsimVersion

std::string BDSOutputROOTEventHeader::bdsimVersion

Definition at line 45 of file BDSOutputROOTEventHeader.hh.

clhepVersion

std::string BDSOutputROOTEventHeader::clhepVersion

Definition at line 48 of file BDSOutputROOTEventHeader.hh.

combinedFiles

std::vector<std::string> BDSOutputROOTEventHeader::combinedFiles

List of which files were combined in case of a rebdsimCombine output file.

Definition at line 54 of file BDSOutputROOTEventHeader.hh.

Referenced by Fill(), and FlushLocal().

dataVersion

int BDSOutputROOTEventHeader::dataVersion

Our data format version.

Definition at line 51 of file BDSOutputROOTEventHeader.hh.

Referenced by FlushLocal(), and RBDS::GetFileType().

distrFileLoopNTimes

unsigned int BDSOutputROOTEventHeader::distrFileLoopNTimes

Number of times a distribution file was replayed.

Definition at line 62 of file BDSOutputROOTEventHeader.hh.

Referenced by HeaderAnalysis::CountNOriginalEvents(), BDSOutput::FillRunInfoAndUpdateHeader(), and FlushLocal().

doublePrecisionOutput

bool BDSOutputROOTEventHeader::doublePrecisionOutput

Whether using double precision output - assumed float if not.

Definition at line 52 of file BDSOutputROOTEventHeader.hh.

Referenced by FlushLocal().

fileType

std::string BDSOutputROOTEventHeader::fileType

Definition at line 50 of file BDSOutputROOTEventHeader.hh.

geant4Version

std::string BDSOutputROOTEventHeader::geant4Version

Definition at line 46 of file BDSOutputROOTEventHeader.hh.

nEventsInFile

unsigned long long int BDSOutputROOTEventHeader::nEventsInFile

Number of events in the input distribution file irrespective of filters.

Definition at line 60 of file BDSOutputROOTEventHeader.hh.

Referenced by HeaderAnalysis::CountNOriginalEvents(), BDSOutput::FillRunInfoAndUpdateHeader(), and FlushLocal().

nEventsInFileSkipped

unsigned long long int BDSOutputROOTEventHeader::nEventsInFileSkipped

Number of events from distribution file that were skipped due to filters.

Definition at line 61 of file BDSOutputROOTEventHeader.hh.

Referenced by HeaderAnalysis::CountNOriginalEvents(), BDSOutput::FillRunInfoAndUpdateHeader(), and FlushLocal().

nEventsRequested

unsigned long long int BDSOutputROOTEventHeader::nEventsRequested

Number of events requested to be simulated from the file.

Definition at line 59 of file BDSOutputROOTEventHeader.hh.

Referenced by HeaderAnalysis::CountNOriginalEvents(), BDSOutput::FillRunInfoAndUpdateHeader(), and FlushLocal().

nOriginalEvents

unsigned long long int BDSOutputROOTEventHeader::nOriginalEvents

Number of original events if skimmed.

Definition at line 58 of file BDSOutputROOTEventHeader.hh.

Referenced by HeaderAnalysis::CountNOriginalEvents(), RBDS::CreateEmptyRebdsimFile(), BDSOutput::FillRunInfoAndUpdateHeader(), and FlushLocal().

nTrajectoryFilters

int BDSOutputROOTEventHeader::nTrajectoryFilters

Length of bitset used for trajectory filtering - compile time info.

Definition at line 55 of file BDSOutputROOTEventHeader.hh.

Referenced by FillGeant4Side(), and FlushLocal().

rootVersion

std::string BDSOutputROOTEventHeader::rootVersion

Definition at line 47 of file BDSOutputROOTEventHeader.hh.

skimmedFile

bool BDSOutputROOTEventHeader::skimmedFile

Whether this is a skimmed output file.

Definition at line 57 of file BDSOutputROOTEventHeader.hh.

Referenced by FlushLocal().

timeStamp

std::string BDSOutputROOTEventHeader::timeStamp

Definition at line 49 of file BDSOutputROOTEventHeader.hh.

trajectoryFilters

std::vector<std::string> BDSOutputROOTEventHeader::trajectoryFilters

Names of filters.

Definition at line 56 of file BDSOutputROOTEventHeader.hh.

Referenced by FillGeant4Side(), and FlushLocal().

---

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

• /Users/lnevay/physics/reps/bdsim/include/BDSOutputROOTEventHeader.hh
• /Users/lnevay/physics/reps/bdsim/src/BDSOutputROOTEventHeader.cc