AliOADBForward Class Reference

#include <AliOADBForward.h>

Inheritance diagram for AliOADBForward:

Classes
class	Entry
class	Table

Public Types
enum	ERunSelectMode {   kDefault = 0, kExact = 1, kNewest = 2, kNear = 3,   kOlder = 4, kNewer = 5 }
enum	{ kMaxNearDistance = 1000000, kInvalidField = 999 }

Public Member Functions
	AliOADBForward ()
	~AliOADBForward ()
void	Print (const Option_t *option="") const
void	Browse (TBrowser *b)
Table *	FindTable (const TString &name, Bool_t quite=false) const
const TMap &	GetTables () const
Input/output
Bool_t	Open (const TString &fileName, const TString &tables="*", Bool_t rw=false, Bool_t verb=false, Bool_t fallback=false)
Bool_t	Open (TFile *file, const TString &tables, Bool_t rw=false, Bool_t verb=false, Bool_t fallback=false)
Bool_t	Close ()
Bool_t	Update ()
Queries
Entry *	Get (const TString &table, ULong_t run=0, ERunSelectMode mode=kNear, UShort_t sys=0, UShort_t sNN=0, Short_t fld=0, Bool_t mc=false, Bool_t sat=false) const
TObject *	GetData (const TString &table, ULong_t run=0, ERunSelectMode mode=kNear, UShort_t sys=0, UShort_t sNN=0, Short_t fld=0, Bool_t mc=false, Bool_t sat=false) const
Bool_t	Insert (const TString &table, TObject *o, ULong_t runNo, UShort_t sys, UShort_t sNN, Short_t field, Bool_t mc=false, Bool_t sat=false, ULong_t aliRev=0, const TString &author="")
Bool_t	CopyEntry (const TString &table, ULong_t oldRunNo, UShort_t oldSys, UShort_t oldSNN, Short_t oldField, ULong_t newRunNo, UShort_t newSys, UShort_t newSNN, Short_t newField, Bool_t mc, Bool_t sat)

Static Public Member Functions
static const char *	Mode2String (ERunSelectMode mode)
static ERunSelectMode	String2Mode (const TString &str)
static ERunSelectMode	Int2Mode (Int_t mode)
Tests
static void	TestGet (AliOADBForward &t, const TString &table, ULong_t runNo=0, ERunSelectMode mode=kNear, UShort_t sys=2, UShort_t sNN=2760, Short_t fld=-5, Bool_t mc=false, Bool_t sat=false)
static void	TestInsert (AliOADBForward &t, const TString &table, ULong_t runNo=0, UShort_t sys=2, UShort_t sNN=2760, Short_t fld=-5, Bool_t mc=false, Bool_t sat=false)
static void	Test ()

Protected Member Functions
Int_t	GetFiles (TList &files) const
Table *	GetTableFromFile (TFile *file, Bool_t rw, const TString &name, const TString &mode) const
void	OpenTable (TFile *file, Bool_t rw, const TString &name, const TString &mode, Bool_t verb, Bool_t fallback)
	ClassDef (AliOADBForward, 0)

Static Protected Member Functions
static void	AppendToQuery (TString &q, const TString &s, Bool_t andNotOr=true)
static TString	Conditions (UShort_t sys=0, UShort_t sNN=0, Short_t fld=kInvalidField, Bool_t mc=false, Bool_t sat=false)

Protected Attributes
TMap	fTables

Detailed Description

Container/handler of Forward calibration objects.

Definition at line 15 of file AliOADBForward.h.

Member Enumeration Documentation

anonymous enum

Various flags

Enumerator
kMaxNearDistance	The maximum distance to the given run when selecting in kNear mode. Currently this is set to a large number to allow selection of any entry. This should change
kInvalidField

Definition at line 79 of file AliOADBForward.h.

enum AliOADBForward::ERunSelectMode

Options for selecting the entries according to the run number given in the query.

Enumerator
kDefault
kExact	Select only entries from exactly the run given.
kNewest	Select the entry with the largest run number
kNear	Select entries from the run nearest (possibly constrained to be older or newer) to the run given in the query
kOlder	Select entries from runs that are older than the run given in the query. The oldest entry with the largest run number smaller than the given run is selected.
kNewer	Select entries from runs that are newer than the run given. Select the entries with the smallest run number which is larger than the given run.

Definition at line 23 of file AliOADBForward.h.

Constructor & Destructor Documentation

AliOADBForward::AliOADBForward

(

)

Constructor

Definition at line 621 of file AliOADBForward.cxx.

Referenced by Test().

AliOADBForward::~AliOADBForward

(

)

Destructor

Definition at line 641 of file AliOADBForward.cxx.

Member Function Documentation

void AliOADBForward::AppendToQuery ( TString &  q, const TString &  s, Bool_t  andNotOr = true  )

staticprotected

Helper function to append to query string

Parameters

q	String to attach to
s	What to attach
andNotOr	If true, assume and, otherwise or

Definition at line 1025 of file AliOADBForward.cxx.

Referenced by Conditions(), and AliOADBForward::Table::Query().

void AliOADBForward::Browse

(

TBrowser *

b

)

Browse this database

Parameters

b

Browser

Definition at line 909 of file AliOADBForward.cxx.

AliOADBForward::ClassDef ( AliOADBForward  , 0    )

protected

Bool_t AliOADBForward::Close

(

)

Close this database

Returns

true on success

Definition at line 757 of file AliOADBForward.cxx.

Referenced by AliCorrectionManagerBase::Correction::StoreIt(), Test(), ~AliOADBForward(), and AliOADBForward::Table::~Table().

TString AliOADBForward::Conditions ( UShort_t  sys = 0, UShort_t  sNN = 0, Short_t  fld = kInvalidField, Bool_t  mc = false, Bool_t  sat = false  )

staticprotected

Helper function to build a query string

Parameters

sys	Collision system (1:pp, 2: PbPb, 3:pPb)
sNN	Collision energy in GeV
fld	L3-Field strength and polarity
mc	For Monte-carlo
sat	For satelitte collisions

Returns

Query string

Definition at line 1035 of file AliOADBForward.cxx.

Referenced by AliOADBForward::Table::Query().

Bool_t AliOADBForward::CopyEntry	(	const TString &	table,
		ULong_t	oldRunNo,
		UShort_t	oldSys,
		UShort_t	oldSNN,
		Short_t	oldField,
		ULong_t	newRunNo,
		UShort_t	newSys,
		UShort_t	newSNN,
		Short_t	newField,
		Bool_t	mc,
		Bool_t	sat
	)

Copy one entry to another entry

Parameters

table	Table name
oldRunNo	Old run number
oldSys	Old collision system
oldSNN	Old center of mass energy
oldField	Old L3 magnetic field strength
newRunNo	New run number
newSys	New collision system
newSNN	New center of mass energy
newField	New L3 magnetic field strength
mc	True for MC only queries
sat	True for including satellite queries

Returns

true on success

Definition at line 866 of file AliOADBForward.cxx.

Referenced by CopyCorr(), and ForwardOADBGUI::HandleCopy().

AliOADBForward::Table * AliOADBForward::FindTable	(	const TString &	name,
		Bool_t	quite = false
	)		const

Find a table by name

Parameters

name	Name of table
quite	Do not print warning if not found

Returns

Table or null

Definition at line 925 of file AliOADBForward.cxx.

Referenced by AliCorrectionManagerBase::Correction::CleanIt(), CopyEntry(), Get(), GetData(), GetTableFromFile(), ForwardOADBGUI::HandleItem(), ForwardOADBGUI::HandleList(), Insert(), AliCorrectionManagerBase::Correction::OpenIt(), and ForwardOADBGUI::UseDB().

AliOADBForward::Entry * AliOADBForward::Get	(	const TString &	table,
		ULong_t	run = 0,
		ERunSelectMode	mode = kNear,
		UShort_t	sys = 0,
		UShort_t	sNN = 0,
		Short_t	fld = 0,
		Bool_t	mc = false,
		Bool_t	sat = false
	)		const

Query the table for an object. The strategy is as follows.

• First query with all fields
  • If this returns a single entry, return that.
  • If not, then ignore the run number (if given)
    • If this returns a single entry, return that
    • Otherwise, give up and return null

This allow us to specify default objects for a period, and for collision system, energy, and field setting.

Parameters

table	Table name
run	Run number
mode	Run selection mode
sys	Collision system (1: pp, 2: PbPb, 3: pPb)
sNN	Center of mass energy (GeV)
fld	L3 magnetic field (kG)
mc	For MC only
sat	For satellite interactions

Returns

Found entry, or null

Definition at line 810 of file AliOADBForward.cxx.

Referenced by AliOADBForward::Table::GetData(), ForwardOADBGUI::HandleQuery(), AliCorrectionManagerBase::Correction::ReadIt(), and TestGet().

TObject * AliOADBForward::GetData	(	const TString &	table,
		ULong_t	run = 0,
		ERunSelectMode	mode = kNear,
		UShort_t	sys = 0,
		UShort_t	sNN = 0,
		Short_t	fld = 0,
		Bool_t	mc = false,
		Bool_t	sat = false
	)		const

Query the table for an object. The strategy is as follows.

• First query with all fields
  • If this returns a single entry, return that.
  • If not, then ignore the run number (if given)
    • If this returns a single entry, return that
    • Otherwise, give up and return null

This allow us to specify default objects for a period, and for collision system, energy, and field setting.

Parameters

table	Table name
run	Run number
mode	Run selection mode
sys	Collision system (1: pp, 2: PbPb, 3: pPb)
sNN	Center of mass energy (GeV)
fld	L3 magnetic field (kG)
mc	For MC only
sat	For satellite interactions

Returns

Found data, or null

Definition at line 829 of file AliOADBForward.cxx.

Int_t AliOADBForward::GetFiles ( TList &  files ) const

protected

Get a list of associated files

Parameters

files

On return, contains list of files

Returns

Number of associated files found

Definition at line 940 of file AliOADBForward.cxx.

Referenced by Close(), and Update().

AliOADBForward::Table * AliOADBForward::GetTableFromFile ( TFile *  file, Bool_t  rw, const TString &  name, const TString &  mode  ) const

protected

Get a table (TTree) from a file

Parameters

file	File to look in
rw	If true, open read/write, false read-only
name	Name of the table
mode	Default mode for new table, or override mode for existing tables if not default

Returns

Table or (if rw=true) possibly newly created table

Definition at line 964 of file AliOADBForward.cxx.

Referenced by OpenTable().

const TMap& AliOADBForward::GetTables ( ) const

inline

Get all tables

Returns

Map of all tables

Definition at line 648 of file AliOADBForward.h.

Referenced by ForwardOADBGUI::HandleEnable(), and ForwardOADBGUI::UseDB().

Bool_t AliOADBForward::Insert	(	const TString &	table,
		TObject *	o,
		ULong_t	runNo,
		UShort_t	sys,
		UShort_t	sNN,
		Short_t	field,
		Bool_t	mc = false,
		Bool_t	sat = false,
		ULong_t	aliRev = 0,
		const TString &	author = ""
	)

Insert a new entry into the table

Parameters

table	Table name
o	Object to write
runNo	Run number
sys	Collision system (1: pp, 2:PbPb, 3:pPb)
sNN	Center of mass energy (GeV)
field	L3 magnetic field (kG)
mc	If true, only for MC
sat	For satellite interactions
aliRev	AliROOT revision
author	Creater of this correction

Returns

true on success

Definition at line 845 of file AliOADBForward.cxx.

Referenced by NormExtractor::Store(), AliCorrectionManagerBase::Correction::StoreIt(), and TestInsert().

AliOADBForward::ERunSelectMode AliOADBForward::Int2Mode ( Int_t  mode )

static

Return mode as an integer

Parameters

mode

Mode

Returns

Mode identifier

Definition at line 48 of file AliOADBForward.cxx.

static const char* AliOADBForward::Mode2String ( ERunSelectMode  mode )

static

Return the mode as a string

Parameters

mode

Mode

Returns

Stringified mode

Referenced by AliCorrectionManagerBase::Correction::CleanIt(), CopyEntry(), AliOADBForward::Table::GetEntry(), AliOADBForward::Table::Print(), AliOADBForward::Table::Query(), and AliOADBForward::Table::Table().

Bool_t AliOADBForward::Open	(	const TString &	fileName,
		const TString &	tables = "*",
		Bool_t	rw = false,
		Bool_t	verb = false,
		Bool_t	fallback = false
	)

Open a file containing tables. Note, this member function can be called multiple times to open tables in different files.

If a table is already associated with this handler, it will not be re-associated.

Parameters

fileName	Path to file to get/write tables from/in
rw	if true, open read+write, otherwise read-only
tables	Tables to open
verb	Verbosity flag
fallback	If true allow for fall-backs

Returns

true on success

Definition at line 666 of file AliOADBForward.cxx.

Referenced by Browse(), CopyCorr(), ForwardOADBGUI::HandleOpen(), AliCorrectionManagerBase::Correction::OpenIt(), NormExtractor::Store(), AliCorrectionManagerBase::Correction::StoreIt(), and Test().

Bool_t AliOADBForward::Open	(	TFile *	file,
		const TString &	tables,
		Bool_t	rw = false,
		Bool_t	verb = false,
		Bool_t	fallback = false
	)

Open a file containing tables. Note, this member function can be called multiple times to open tables in different files.

If a table is already associated with this handler, it will not be re-associated.

Parameters

file	File to get/write tables from/in
rw	if true, open read+write, otherwise read-only
tables	Tables to open
verb	Verbosity flag
fallback	If true allow for fall-backs

Returns

true on success

Definition at line 694 of file AliOADBForward.cxx.

void AliOADBForward::OpenTable ( TFile *  file, Bool_t  rw, const TString &  name, const TString &  mode, Bool_t  verb, Bool_t  fallback  )

protected

Get a table (TTree) from a file and attach

Parameters

file	File to look in
rw	If true, open read/write, false read-only
name	Name of the table
mode	Default mode for new table, or override mode for existing tables if not default
fallback	Enable fall-backs
verb	If true, be verbose

Returns

Table or (if rw=true) possibly newly created table

Definition at line 1003 of file AliOADBForward.cxx.

Referenced by Open().

void AliOADBForward::Print

(

const Option_t *

option = ""

)

const

Print the content of all tables

Parameters

option

Passed on to tables

Definition at line 891 of file AliOADBForward.cxx.

Referenced by Test().

AliOADBForward::ERunSelectMode AliOADBForward::String2Mode ( const TString &  str )

static

Parse a string to get the mode

Parameters

str	Input string

Returns

Mode

Definition at line 37 of file AliOADBForward.cxx.

Referenced by GetTableFromFile(), and AliOADBForward::Table::Table().

void AliOADBForward::Test ( )

static

Definition at line 1096 of file AliOADBForward.cxx.

void AliOADBForward::TestGet ( AliOADBForward &  t, const TString &  table, ULong_t  runNo = 0, ERunSelectMode  mode = kNear, UShort_t  sys = 2, UShort_t  sNN = 2760, Short_t  fld = -5, Bool_t  mc = false, Bool_t  sat = false  )

static

Definition at line 1057 of file AliOADBForward.cxx.

Referenced by Test().

void AliOADBForward::TestInsert ( AliOADBForward &  t, const TString &  table, ULong_t  runNo = 0, UShort_t  sys = 2, UShort_t  sNN = 2760, Short_t  fld = -5, Bool_t  mc = false, Bool_t  sat = false  )

static

Definition at line 1077 of file AliOADBForward.cxx.

Referenced by Test().

Bool_t AliOADBForward::Update

(

)

Flush to disk

Returns

true on success

Definition at line 783 of file AliOADBForward.cxx.

Referenced by ForwardOADBGUI::HandleCopy().

Member Data Documentation

TMap AliOADBForward::fTables

protected

Definition at line 712 of file AliOADBForward.h.

Referenced by Browse(), Close(), FindTable(), GetFiles(), GetTables(), OpenTable(), and Print().

---

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

• PWGLF/FORWARD/analysis2/AliOADBForward.h
• PWGLF/FORWARD/analysis2/AliOADBForward.cxx