KVDBRun Class Reference

Detailed Description

Description of an experimental run in database ,,.

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 40 of file KVDBRun.h.

#include <KVDBRun.h>

Inheritance diagram for KVDBRun:

Public Member Functions
	KVDBRun ()
	default ctor More...
	KVDBRun (Int_t number, const Char_t *title)
	ctor for a given run number More...
void	AddRunFile (KVDBRunFile *rf)
void	BlockSignals (Bool_t yes=kTRUE)
Double_t	Get (const Char_t *param) const
	Get numerical (non-scaler) characteristic of run. More...
const Char_t *	GetComments () const
const Char_t *	GetEndDate () const
ULong64_t	GetEvents () const
KVDBRunFile &	GetFirstFile ()
const KVDBRunFile &	GetFirstFile () const
KVDBRunFile &	GetLastFile ()
const KVDBRunFile &	GetLastFile () const
Int_t	GetNGoodRunFiles () const
Int_t	GetNRunFiles () const
KVDBRunFile &	GetRunFile (const run_index_t &run_index)
const KVDBRunFile &	GetRunFile (const run_index_t &run_index) const
virtual Int_t	GetScaler (const Char_t *name) const
	Get value of scaler with the given name for this run. More...
virtual 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...
KVDBSystem *	GetSystem () const
const Char_t *	GetSystemName () const
KVTarget *	GetTarget () const
	Return target used for this run (actually target of KVDBSystem associated to run) More...
Double_t	GetTime () const
Int_t	GetTrigger () const
const Char_t *	GetTriggerString () const
Bool_t	Has (const Char_t *param, Bool_t check_whitespace=kTRUE) const
Bool_t	IsMultiFile () const
void	Modified ()
void	Print (Option_t *option="") const override
virtual void	ReadRunListLine (const KVString &)
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	SetBadAllRunFiles ()
void	SetComments (const KVString &comments)
void	SetNumber (Int_t n) override
virtual void	SetScaler (const Char_t *name, Int_t val)
	Set value for the scaler with the given name for this run. More...
virtual void	SetScaler64 (const Char_t *name, ULong64_t val)
	Set value for 64-bit scaler with the given name for this run. More...
virtual void	SetSystem (KVDBSystem *system)
	Set system for run. Any previous system is unassociated (run will be removed from system's list) More...
void	SetTrigger (Int_t trig)
virtual void	UnsetSystem ()
virtual void	WriteRunListHeader (std::ostream &, Char_t delim='|') const
	Write the version flag. More...
virtual void	WriteRunListLine (std::ostream &, Char_t delim='|') const
Public Member Functions inherited from KVDBRecord
	KVDBRecord ()
	KVDBRecord (const Char_t *name, const Char_t *title="")
virtual	~ KVDBRecord ()
virtual KVDBKey *	AddKey (const Char_t *name, const Char_t *title, Bool_t check=kTRUE)
virtual Bool_t	AddKey (KVDBKey *key, Bool_t check=kTRUE)
virtual Bool_t	AddLink (const Char_t *key_name, KVDBRecord *rec, Bool_t linkback=kTRUE)
Int_t	Compare (const TObject *obj) const override
virtual KVDBKey *	GetKey (const Char_t *key) const
virtual TList *	GetKeys () const
virtual KVDBRecord *	GetLink (const Char_t *key, const Char_t *link) const
	Returns the record named "link" in the table named "key". More...
virtual KVRList *	GetLinks (const Char_t *key) const
	Returns the list of records linked to this record in table "key". More...
virtual Int_t	GetNumber () const
virtual KVDBTable *	GetTable () const
void	ls (Option_t *option="*") const override
virtual void	RemoveAllLinks (const Char_t *key)
	Remove all links between this record and the records in the DB table"key_name". More...
virtual void	RemoveLink (const Char_t *key_name, KVDBRecord *rec, Bool_t linkback=kTRUE)
	Remove the link between this record and the record "rec" in the DB table"key_name". More...
virtual void	SetTable (const KVDBTable *table)
Public Member Functions inherited from TFolder
	TFolder ()
	TFolder (const char *name, const char *title)
virtual	~TFolder ()
virtual void	Add (TObject *obj)
TFolder *	AddFolder (const char *name, const char *title, TCollection *collection=nullptr)
void	Browse (TBrowser *b) override
void	Clear (Option_t *option="") override
void	Copy (TObject &) const override
virtual const char *	FindFullPathName (const char *name) const
virtual const char *	FindFullPathName (const TObject *obj) const
TObject *	FindObject (const char *name) const override
TObject *	FindObject (const TObject *obj) const override
virtual TObject *	FindObjectAny (const char *name) const
TCollection *	GetListOfFolders () const
TClass *	IsA () const override
Bool_t	IsFolder () const override
Bool_t	IsOwner () const
virtual Int_t	Occurence (const TObject *obj) const
void	RecursiveRemove (TObject *obj) override
virtual void	Remove (TObject *obj)
void	SaveAs (const char *filename="", Option_t *option="") const override
virtual void	SetOwner (Bool_t owner=kTRUE)
void	Streamer (TBuffer &) override
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
Public Member Functions inherited from TNamed
	TNamed ()
	TNamed (const char *name, const char *title)
	TNamed (const TNamed &named)
	TNamed (const TString &name, const TString &title)
virtual	~TNamed ()
void	Clear (Option_t *option="") override
TObject *	Clone (const char *newname="") const override
void	Copy (TObject &named) const override
virtual void	FillBuffer (char *&buffer)
const char *	GetName () const override
const char *	GetTitle () const override
ULong_t	Hash () const override
TClass *	IsA () const override
Bool_t	IsSortable () const override
TNamed &	operator= (const TNamed &rhs)
virtual void	SetName (const char *name)
virtual void	SetNameTitle (const char *name, const char *title)
virtual void	SetTitle (const char *title="")
virtual Int_t	Sizeof () const
void	Streamer (TBuffer &) override
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
Public Member Functions inherited from TObject
	TObject ()
	TObject (const TObject &object)
virtual	~TObject ()
void	AbstractMethod (const char *method) const
virtual void	AppendPad (Option_t *option="")
ULong_t	CheckedHash ()
virtual const char *	ClassName () const
virtual void	Delete (Option_t *option="")
virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
virtual void	Draw (Option_t *option="")
virtual void	DrawClass () const
virtual TObject *	DrawClone (Option_t *option="") const
virtual void	Dump () const
virtual void	Error (const char *method, const char *msgfmt,...) const
virtual void	Execute (const char *method, const char *params, Int_t *error=nullptr)
virtual void	Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
virtual void	Fatal (const char *method, const char *msgfmt,...) const
virtual Option_t *	GetDrawOption () const
virtual const char *	GetIconName () const
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
virtual Option_t *	GetOption () const
virtual UInt_t	GetUniqueID () const
virtual Bool_t	HandleTimer (TTimer *timer)
Bool_t	HasInconsistentHash () const
virtual void	Info (const char *method, const char *msgfmt,...) const
virtual Bool_t	InheritsFrom (const char *classname) const
virtual Bool_t	InheritsFrom (const TClass *cl) const
virtual void	Inspect () const
void	InvertBit (UInt_t f)
Bool_t	IsDestructed () const
virtual Bool_t	IsEqual (const TObject *obj) const
R__ALWAYS_INLINE Bool_t	IsOnHeap () const
R__ALWAYS_INLINE Bool_t	IsZombie () const
void	MayNotUse (const char *method) const
virtual Bool_t	Notify ()
void	Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
void	operator delete (void *ptr)
void	operator delete (void *ptr, void *vp)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, void *vp)
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *vp)
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, void *vp)
TObject &	operator= (const TObject &rhs)
virtual void	Paint (Option_t *option="")
virtual void	Pop ()
virtual Int_t	Read (const char *name)
void	ResetBit (UInt_t f)
virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
void	SetBit (UInt_t f)
void	SetBit (UInt_t f, Bool_t set)
virtual void	SetDrawOption (Option_t *option="")
virtual void	SetUniqueID (UInt_t uid)
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void	SysError (const char *method, const char *msgfmt,...) const
R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const
Int_t	TestBits (UInt_t f) const
virtual void	UseCurrentStyle ()
virtual void	Warning (const char *method, const char *msgfmt,...) const
virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const

Private Member Functions
KVDBRunFile *	GetRunFile (int index)
const KVDBRunFile *	GetRunFile (int index) const

Private Attributes
Bool_t	fBlockSignals
KVNameValueList	fParameters
	list of named parameters for run More...
TObjArray	fRunFiles

Additional Inherited Members
Public Types inherited from TObject
enum	EDeprecatedStatusBits
enum	EStatusBits
Static Public Member Functions inherited from TFolder
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
Static Public Member Functions inherited from TNamed
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
Static Public Member Functions inherited from TObject
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
static Longptr_t	GetDtorOnly ()
static Bool_t	GetObjectStat ()
static void	SetDtorOnly (void *obj)
static void	SetObjectStat (Bool_t stat)
Public Attributes inherited from TObject
	kBitMask
	kCanDelete
	kCannotPick
	kHasUUID
	kInconsistent
	kInvalidObject
	kIsOnHeap
	kIsReferenced
	kMustCleanup
	kNoContextMenu
	kNotDeleted
	kObjInCanvas
	kOverwrite
	kSingleKey
	kWriteDelete
	kZombie
Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char *location, const char *fmt, va_list va) const
void	MakeZombie ()
Protected Attributes inherited from TFolder
TCollection *	fFolders
Bool_t	fIsOwner
Protected Attributes inherited from TNamed
TString	fName
TString	fTitle
Protected Attributes inherited from TObject
	kOnlyPrepStep

Constructor & Destructor Documentation

KVDBRun() [1/2]

KVDBRun::KVDBRun

(

)

default ctor

Definition at line 33 of file KVDBRun.cpp.

KVDBRun() [2/2]

KVDBRun::KVDBRun	(	Int_t	number,
		const Char_t *	title
	)

ctor for a given run number

Definition at line 45 of file KVDBRun.cpp.

Member Function Documentation

AddRunFile()

void KVDBRun::AddRunFile ( KVDBRunFile *  rf )

inline

Definition at line 80 of file KVDBRun.h.

BlockSignals()

void KVDBRun::BlockSignals ( Bool_t  yes = kTRUE )

inline

if yes=kTRUE, block 'Modified()' signal if yes=kFALSE, allow 'Modified()' signal

Definition at line 133 of file KVDBRun.h.

Get()

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

inline

Get numerical (non-scaler) characteristic of run.

Definition at line 273 of file KVDBRun.h.

GetComments()

const Char_t* KVDBRun::GetComments ( ) const

inline

Definition at line 221 of file KVDBRun.h.

GetEndDate()

const Char_t* KVDBRun::GetEndDate ( ) const

inline

return date of beginning of the last file of the run

Definition at line 172 of file KVDBRun.h.

GetEvents()

ULong64_t KVDBRun::GetEvents ( ) const

inline

Return total number of events in all files associated with run

Note that 'bad' runfiles are excluded

Definition at line 155 of file KVDBRun.h.

GetFirstFile() [1/2]

KVDBRunFile& KVDBRun::GetFirstFile ( )

inline

Definition at line 92 of file KVDBRun.h.

GetFirstFile() [2/2]

const KVDBRunFile& KVDBRun::GetFirstFile ( ) const

inline

Definition at line 96 of file KVDBRun.h.

GetLastFile() [1/2]

KVDBRunFile& KVDBRun::GetLastFile ( )

inline

Definition at line 100 of file KVDBRun.h.

GetLastFile() [2/2]

const KVDBRunFile& KVDBRun::GetLastFile ( ) const

inline

Definition at line 104 of file KVDBRun.h.

GetNGoodRunFiles()

Int_t KVDBRun::GetNGoodRunFiles ( ) const

inline

Returns

number of runfiles which are not considered 'bad'

Definition at line 117 of file KVDBRun.h.

GetNRunFiles()

Int_t KVDBRun::GetNRunFiles ( ) const

inline

Definition at line 84 of file KVDBRun.h.

GetRunFile() [1/4]

KVDBRunFile& KVDBRun::GetRunFile ( const run_index_t &  run_index )

inline

Definition at line 64 of file KVDBRun.h.

GetRunFile() [2/4]

const KVDBRunFile& KVDBRun::GetRunFile ( const run_index_t &  run_index ) const

inline

Definition at line 73 of file KVDBRun.h.

GetRunFile() [3/4]

KVDBRunFile* KVDBRun::GetRunFile ( int  index )

inlineprivate

Definition at line 48 of file KVDBRun.h.

GetRunFile() [4/4]

const KVDBRunFile* KVDBRun::GetRunFile ( int  index ) const

inlineprivate

Definition at line 52 of file KVDBRun.h.

GetScaler()

virtual Int_t KVDBRun::GetScaler ( const Char_t *  name ) const

inlinevirtual

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

Definition at line 251 of file KVDBRun.h.

GetScaler64()

virtual ULong64_t KVDBRun::GetScaler64 ( const Char_t *  name ) const

inlinevirtual

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

Definition at line 262 of file KVDBRun.h.

GetSize()

Double_t KVDBRun::GetSize ( ) const

inline

return total size of all files associated with run

note that 'bad' runfiles are excluded

Definition at line 177 of file KVDBRun.h.

GetStartDate()

const Char_t* KVDBRun::GetStartDate ( ) const

inline

return date of beginning of the first file of the run

Definition at line 167 of file KVDBRun.h.

GetString()

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

inline

Get characteristic of run.

Definition at line 284 of file KVDBRun.h.

GetSystem()

KVDBSystem * KVDBRun::GetSystem

(

)

const

Definition at line 237 of file KVDBRun.cpp.

GetSystemName()

const Char_t* KVDBRun::GetSystemName ( ) const

inline

Definition at line 217 of file KVDBRun.h.

GetTarget()

KVTarget* KVDBRun::GetTarget ( ) const

inline

Return target used for this run (actually target of KVDBSystem associated to run)

Definition at line 226 of file KVDBRun.h.

GetTime()

Double_t KVDBRun::GetTime ( ) const

inline

return total length in time of all files associated with run

note that 'bad' runfiles are excluded

Definition at line 189 of file KVDBRun.h.

GetTrigger()

Int_t KVDBRun::GetTrigger ( ) const

inline

Definition at line 207 of file KVDBRun.h.

GetTriggerString()

const Char_t* KVDBRun::GetTriggerString ( ) const

inline

Definition at line 211 of file KVDBRun.h.

Has()

Bool_t KVDBRun::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 142 of file KVDBRun.h.

IsMultiFile()

Bool_t KVDBRun::IsMultiFile ( ) const

inline

Definition at line 88 of file KVDBRun.h.

Modified()

void KVDBRun::Modified ( )

inline

Signal sent out when run properties change (used by GUI)

Definition at line 128 of file KVDBRun.h.

Print()

void KVDBRun::Print ( Option_t *  option = "" ) const

overridevirtual

Reimplemented from KVDBRecord.

Definition at line 61 of file KVDBRun.cpp.

ReadRunListLine()

void KVDBRun::ReadRunListLine ( const KVString &  line )

virtual

Set run characteristics by reading informations in 'line' (assumed to have been written by WriteRunListLine). Break line into fields using delimiter '|'

Definition at line 138 of file KVDBRun.cpp.

Set() [1/2]

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

inline

Set characteristic of run.

Definition at line 278 of file KVDBRun.h.

Set() [2/2]

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

inline

Set numerical (non-scaler) characteristic of run.

Definition at line 267 of file KVDBRun.h.

SetBadAllRunFiles()

void KVDBRun::SetBadAllRunFiles ( )

inline

declare all files associated with this run to be 'bad', i.e. not to be considered for analysis

Definition at line 108 of file KVDBRun.h.

SetComments()

void KVDBRun::SetComments ( const KVString &  comments )

inline

Definition at line 230 of file KVDBRun.h.

SetNumber()

void KVDBRun::SetNumber ( Int_t  n )

inlineoverridevirtual

Reimplemented from KVDBRecord.

Definition at line 150 of file KVDBRun.h.

SetScaler()

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

inlinevirtual

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

Definition at line 245 of file KVDBRun.h.

SetScaler64()

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

inlinevirtual

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

Definition at line 256 of file KVDBRun.h.

SetSystem()

void KVDBRun::SetSystem ( KVDBSystem *  system )

virtual

Set system for run. Any previous system is unassociated (run will be removed from system's list)

Definition at line 251 of file KVDBRun.cpp.

SetTrigger()

void KVDBRun::SetTrigger ( Int_t  trig )

inline

Definition at line 202 of file KVDBRun.h.

UnsetSystem()

void KVDBRun::UnsetSystem ( )

virtual

If this run has previously been associated with a system in the database, this will remove the association. The run will also be removed from the system's list of associated runs.

Reimplemented in KVINDRADBRun.

Definition at line 220 of file KVDBRun.cpp.

WriteRunListHeader()

void KVDBRun::WriteRunListHeader ( std::ostream &  , Char_t  delim = '|'  ) const

virtual

Write the version flag.

Definition at line 206 of file KVDBRun.cpp.

WriteRunListLine()

void KVDBRun::WriteRunListLine ( std::ostream &  , Char_t  delim = '|'  ) const

virtual

Write informations on run in format used for runlists, i.e. a line of fields separated by the separator character '|' (the 'delim' argument is obsolete and is not used)

Definition at line 91 of file KVDBRun.cpp.

Member Data Documentation

fBlockSignals

Bool_t KVDBRun::fBlockSignals

private

Definition at line 43 of file KVDBRun.h.

fParameters

KVNameValueList KVDBRun::fParameters

private

list of named parameters for run

Definition at line 46 of file KVDBRun.h.

fRunFiles

TObjArray KVDBRun::fRunFiles

private

Definition at line 45 of file KVDBRun.h.