SFrame 3.6
SFile Class Reference

Class describing an input file to the analysis. More...

#include <core/include/SInputData.h>

List of all members.

Public Member Functions

 SFile ()
 Default constructor.
 SFile (const TString &f)
 Constructor with a file name.
 SFile (const TString &f, Double_t l)
 Constructor with a file name and a luminosity.
SFileoperator= (const SFile &parent)
 Assignment operator.
Bool_t operator== (const SFile &rh) const
 Equality operator.
Bool_t operator!= (const SFile &rh) const
 Non-equality operator.

Public Attributes

TString file
 The file name.
Double_t lumi
 Luminosity of the file.
Long64_t events
 Number of events in the file.

Detailed Description

Class describing an input file to the analysis.

It is used to describe one input or output file (as defined in the configuration XML file) to the framework.

Version:
Revision:
331

Definition at line 94 of file SInputData.h.


Constructor & Destructor Documentation

SFile::SFile ( ) [inline]

Default constructor.

Definition at line 98 of file SInputData.h.

SFile::SFile ( const TString &  f) [inline]

Constructor with a file name.

Definition at line 101 of file SInputData.h.

SFile::SFile ( const TString &  f,
Double_t  l 
) [inline]

Constructor with a file name and a luminosity.

Definition at line 104 of file SInputData.h.


Member Function Documentation

Bool_t SFile::operator!= ( const SFile rh) const

Non-equality operator.

The non-equality operator is put in to make code such as

if( inputData1 != inputData2 ) ...

possible.

Definition at line 129 of file SInputData.cxx.

SFile & SFile::operator= ( const SFile parent)

Assignment operator.

It is only necessary for some technical affairs.

Definition at line 92 of file SInputData.cxx.

References events, file, and lumi.

Bool_t SFile::operator== ( const SFile rh) const

Equality operator.

The equality operator is put in to make code such as

if( inputData1 == inputData2 ) ...

possible.

Definition at line 110 of file SInputData.cxx.

References events, file, and lumi.


Member Data Documentation

Long64_t SFile::events

Number of events in the file.

This property is calculated by the framework in SCycleBase::CheckInputFiles. It is used for calculating the correct weights when only a specified number of events should be processed from a dataset. (So the luminosity of the dataset has to be weighted.)

Definition at line 133 of file SInputData.h.

Referenced by operator=(), and operator==().

TString SFile::file

The file name.

Not much to say about this, this is the full name of the input file.

Definition at line 118 of file SInputData.h.

Referenced by operator=(), and operator==().

Double_t SFile::lumi

Luminosity of the file.

Every input file is assigned a luminosity. This is used to calculate the correct event weights for SCycleBase::ExecuteEvent to normalise the different Monte Carlos correctly to each other.

Definition at line 125 of file SInputData.h.

Referenced by SInputData::AddSFileIn(), operator=(), and operator==().


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