Detailed Description

A single raw data file associated with an experimental run ,,.

Each experimental 'run' may produce 1 or more files. The conditions and settings of the experiment are assumed to be the same during the entire length of the run.

Each 'run' is described by a KVDBRun object in the experiment database. Each 'run' is assigned a number.

Each KVDBRun has a list of 1 or more associated KVDBRunFile objects describing the properties of each file. Each file is assigned an index.

To fully specify a runfile requires both run number and index: run_index_t. A list of runfiles specified in this way may be handled by run_index_list.

Definition at line 38 of file KVDBRunFile.h.

#include <KVDBRunFile.h>

Inheritance diagram for KVDBRunFile:

[legend]

Public Member Functions
	KVDBRunFile ()=default

	KVDBRunFile (const KVString &filename, const run_index_t &run_index)

Double_t	Get (const Char_t *param) const
	Get numerical (non-scaler) characteristic of run. More...

const Char_t *	GetDate () const

const TDatime &	GetDatime () const

const Char_t *	GetDatimeString () const

const Char_t *	GetEndDate () const

ULong64_t	GetEvents () const

KVString	GetFileName () const

Int_t	GetGlobalRunFileNumber () const

Int_t	GetIndex () const

const Char_t *	GetKVVersion () const

const KVNameValueList &	GetParameters () const

Int_t	GetRun () const

run_index_t	GetRunIndex () const

Int_t	GetScaler (const Char_t *name) const
	Get value of scaler with the given name for this run. More...

ULong64_t	GetScaler64 (const Char_t *name) const
	Get value of 64-bit scaler with the given name for this run. More...

Double_t	GetSize () const

const Char_t *	GetStartDate () const

const Char_t *	GetString (const Char_t *param) const
	Get characteristic of run. More...

Double_t	GetTime () const

const Char_t *	GetUserName () const

Bool_t	Has (const Char_t *param, Bool_t check_whitespace=kTRUE) const

Bool_t	IsBad () const

void	ls (Option_t *="") const override

void	Print (Option_t *="") const override

void	Set (const Char_t *param, const KVString &val)
	Set characteristic of run. More...

void	Set (const Char_t *param, Double_t val)
	Set numerical (non-scaler) characteristic of run. More...

void	SetBad (Bool_t is_bad=kTRUE)

void	SetDate (const KVString &d)

void	SetDatime (const TDatime &dat)

void	SetEndDate (const KVString &d)

void	SetEvents (ULong64_t evt_number)

void	SetKVVersion (const Char_t *V)

void	SetScaler (const Char_t *name, Int_t val)
	Set value for the scaler with the given name for this run. More...

void	SetScaler64 (const Char_t *name, ULong64_t val)
	Set value for 64-bit scaler with the given name for this run. More...

void	SetSize (Double_t s)

void	SetStartDate (const KVString &date)

void	SetTime (Double_t time)

void	SetUserName (const Char_t *U)

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor. More...

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type. More...

	KVBase (const KVBase &)
	copy ctor More...

void	Clear (Option_t *opt="") override
	Clear object properties : name, type/title, number, label. More...

void	Copy (TObject &) const override
	Make a copy of this object. More...

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

Bool_t	IsCalled (const Char_t *name, bool case_insensitive=false) const

Bool_t	IsLabelled (const Char_t *l, bool case_insensitive=false) const

Bool_t	IsType (const Char_t *typ, bool case_insensitive=false) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator More...

void	Print (Option_t *option="") const override

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Friends
class	KVExpSetUpDB

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

enum class	GetX_status { ok , above_maximum , below_minimum , at_maximum , at_minimum }

Static Public Member Functions inherited from KVBase
static std::optional< TString >	AbsoluteUnixPath (const TString &)

static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values. More...

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const KVString &class_name, KVString &imp_file, KVString &dec_file, const KVString &dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

template<typename ValType >
static ValType	GetDataSetEnv (const KVString &dataset, const KVString &type, const ValType &defval={})

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date. More...

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build. More...

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time. More...

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build. More...

static int	GetKVMajorVersion ()

static int	GetKVMinorVersion ()

static int	GetKVPatchVersion ()

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build. More...

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string. More...

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources. More...

static const Char_t *	gitCommit ()
	Returns last git commit of sources. More...

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsEnvInit ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc. More...

static Double_t	ProtectedGetX (const TF1 &func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})

static Double_t	ProtectedGetX (const TF1 *func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Constructor & Destructor Documentation

◆ KVDBRunFile() [1/2]

KVDBRunFile::KVDBRunFile ( )

default

◆ KVDBRunFile() [2/2]

KVDBRunFile::KVDBRunFile	(	const KVString &	filename,
		const run_index_t &	run_index
	)

inline

Definition at line 58 of file KVDBRunFile.h.

Member Function Documentation

◆ Get()

Double_t KVDBRunFile::Get ( const Char_t * param ) const

inline

Get numerical (non-scaler) characteristic of run.

Definition at line 115 of file KVDBRunFile.h.

◆ GetDate()

const Char_t* KVDBRunFile::GetDate ( ) const

inline

Definition at line 174 of file KVDBRunFile.h.

◆ GetDatime()

const TDatime& KVDBRunFile::GetDatime ( ) const

inline

Definition at line 145 of file KVDBRunFile.h.

◆ GetDatimeString()

const Char_t* KVDBRunFile::GetDatimeString ( ) const

inline

Definition at line 149 of file KVDBRunFile.h.

◆ GetEndDate()

const Char_t* KVDBRunFile::GetEndDate ( ) const

inline

Definition at line 178 of file KVDBRunFile.h.

◆ GetEvents()

ULong64_t KVDBRunFile::GetEvents ( ) const

inline

Definition at line 157 of file KVDBRunFile.h.

◆ GetFileName()

KVString KVDBRunFile::GetFileName ( ) const

inline

Definition at line 209 of file KVDBRunFile.h.

◆ GetGlobalRunFileNumber()

Int_t KVDBRunFile::GetGlobalRunFileNumber ( ) const

inline

Returns: for this runfile a number which can be used to order all the files of all the runs of the current dataset in sequence

Note: bad runfiles (i.e. for which IsBad() returns kTRUE) are excluded and do not have a global runfile number

Definition at line 245 of file KVDBRunFile.h.

◆ GetIndex()

Int_t KVDBRunFile::GetIndex ( ) const

inline

Returns: index number of runfile

Definition at line 68 of file KVDBRunFile.h.

◆ GetKVVersion()

const Char_t* KVDBRunFile::GetKVVersion ( ) const

inline

Definition at line 133 of file KVDBRunFile.h.

◆ GetParameters()

const KVNameValueList& KVDBRunFile::GetParameters ( ) const

inline

Returns: list of parameters (scalers etc.) associated with runfile

Definition at line 240 of file KVDBRunFile.h.

◆ GetRun()

Int_t KVDBRunFile::GetRun ( ) const

inline

Returns: run number of runfile

Definition at line 63 of file KVDBRunFile.h.

◆ GetRunIndex()

run_index_t KVDBRunFile::GetRunIndex ( ) const

inline

Returns: run_index_t of runfile

Definition at line 73 of file KVDBRunFile.h.

◆ GetScaler()

Int_t KVDBRunFile::GetScaler ( const Char_t * name ) const

inline

Get value of scaler with the given name for this run.

Definition at line 94 of file KVDBRunFile.h.

◆ GetScaler64()

ULong64_t KVDBRunFile::GetScaler64 ( const Char_t * name ) const

inline

Get value of 64-bit scaler with the given name for this run.

Definition at line 105 of file KVDBRunFile.h.

◆ GetSize()

Double_t KVDBRunFile::GetSize ( ) const

inline

Definition at line 165 of file KVDBRunFile.h.

◆ GetStartDate()

const Char_t* KVDBRunFile::GetStartDate ( ) const

inline

Definition at line 170 of file KVDBRunFile.h.

◆ GetString()

const Char_t* KVDBRunFile::GetString ( const Char_t * param ) const

inline

Get characteristic of run.

Definition at line 125 of file KVDBRunFile.h.

◆ GetTime()

Double_t KVDBRunFile::GetTime ( ) const

inline

Definition at line 161 of file KVDBRunFile.h.

◆ GetUserName()

const Char_t* KVDBRunFile::GetUserName ( ) const

inline

Definition at line 141 of file KVDBRunFile.h.

◆ Has()

Bool_t KVDBRunFile::Has	(	const Char_t *	param,
		Bool_t	check_whitespace = `kTRUE`
	)		const

inline

Returns kTRUE if a parameter with the given name (either integer, floating point or string) has been set. For string parameters, if the parameter exists we also check if the string is empty (unless check_whitespace=kFALSE)

Definition at line 80 of file KVDBRunFile.h.

◆ IsBad()

Bool_t KVDBRunFile::IsBad ( ) const

inline

Returns: true if this runfile is 'bad', i.e. not to be used for analysis

Definition at line 235 of file KVDBRunFile.h.

◆ ls()

void KVDBRunFile::ls ( Option_t * = "" ) const

inlineoverride

print 64-bit scalers

Definition at line 214 of file KVDBRunFile.h.

◆ Print()

void KVDBRunFile::Print ( Option_t * = "" ) const

inlineoverride

Definition at line 226 of file KVDBRunFile.h.

◆ Set() [1/2]

void KVDBRunFile::Set	(	const Char_t *	param,
		const KVString &	val
	)

inline

Set characteristic of run.

Definition at line 120 of file KVDBRunFile.h.

◆ Set() [2/2]

void KVDBRunFile::Set	(	const Char_t *	param,
		Double_t	val
	)

inline

Set numerical (non-scaler) characteristic of run.

Definition at line 110 of file KVDBRunFile.h.

◆ SetBad()

void KVDBRunFile::SetBad ( Bool_t is_bad = kTRUE )

inline

Declare this runfile to be 'bad', i.e. not to be used for analysis

Definition at line 230 of file KVDBRunFile.h.

◆ SetDate()

void KVDBRunFile::SetDate ( const KVString & d )

inline

Definition at line 200 of file KVDBRunFile.h.

◆ SetDatime()

void KVDBRunFile::SetDatime ( const TDatime & dat )

inline

Definition at line 153 of file KVDBRunFile.h.

◆ SetEndDate()

void KVDBRunFile::SetEndDate ( const KVString & d )

inline

Definition at line 204 of file KVDBRunFile.h.

◆ SetEvents()

void KVDBRunFile::SetEvents ( ULong64_t evt_number )

inline

Definition at line 183 of file KVDBRunFile.h.

◆ SetKVVersion()

void KVDBRunFile::SetKVVersion ( const Char_t * V )

inline

Definition at line 129 of file KVDBRunFile.h.

◆ SetScaler()

void KVDBRunFile::SetScaler	(	const Char_t *	name,
		Int_t	val
	)

inline

Set value for the scaler with the given name for this run.

Definition at line 89 of file KVDBRunFile.h.

◆ SetScaler64()

void KVDBRunFile::SetScaler64	(	const Char_t *	name,
		ULong64_t	val
	)

inline

Set value for 64-bit scaler with the given name for this run.

Definition at line 99 of file KVDBRunFile.h.

◆ SetSize()

void KVDBRunFile::SetSize ( Double_t s )

inline

Definition at line 191 of file KVDBRunFile.h.

◆ SetStartDate()

void KVDBRunFile::SetStartDate ( const KVString & date )

inline

Definition at line 196 of file KVDBRunFile.h.

◆ SetTime()

void KVDBRunFile::SetTime ( Double_t time )

inline

Definition at line 187 of file KVDBRunFile.h.

◆ SetUserName()

void KVDBRunFile::SetUserName ( const Char_t * U )

inline

Definition at line 137 of file KVDBRunFile.h.

Friends And Related Function Documentation

◆ KVExpSetUpDB

friend class KVExpSetUpDB

friend

Definition at line 49 of file KVDBRunFile.h.

Detailed Description

Public Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDBRunFile() [1/2]

◆ KVDBRunFile() [2/2]

Member Function Documentation

◆ Get()

◆ GetDate()

◆ GetDatime()

◆ GetDatimeString()

◆ GetEndDate()

◆ GetEvents()

◆ GetFileName()

◆ GetGlobalRunFileNumber()

◆ GetIndex()

◆ GetKVVersion()

◆ GetParameters()

◆ GetRun()

◆ GetRunIndex()

◆ GetScaler()

◆ GetScaler64()

◆ GetSize()

◆ GetStartDate()

◆ GetString()

◆ GetTime()

◆ GetUserName()

◆ Has()

◆ IsBad()

◆ ls()

◆ Print()

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetBad()

◆ SetDate()

◆ SetDatime()

◆ SetEndDate()

◆ SetEvents()

◆ SetKVVersion()

◆ SetScaler()

◆ SetScaler64()

◆ SetSize()

◆ SetStartDate()

◆ SetTime()

◆ SetUserName()

Friends And Related Function Documentation

◆ KVExpSetUpDB