Moving to the new VMC naming convention
[u/mrichter/AliRoot.git] / PHOS / AliPHOSCalibrManager.cxx
index ccf7d14..3f5ada8 100644 (file)
 /* $Id$ */
 
 //_________________________________________________________________________
-// Short description  
+// Class provides interface between classes 
+// consuming/producing calibration data, 
+// such as AliPHOSClusterizer and AliPHOSCalibrator
+// from one side and database (now just a root file, 
+// later  - AliEn etc.)
+// Use case: 
+//  First Manager should be configured so that is reads data 
+//  from a given source. e.g. from a root file:
+//   AliPHOSCalibrManager * m = AliPHOSCalibrManager::GetInstance("MyCalibrationRootFile.root") ;
+//  After that one can real/write data to this source:
+//  AliPHOSCalibrationData mydata("Gains","v1") ;
+//  ......
+//  m->Write(&mydata) ;
+//  AliPHOSCalibrationData myanotherdata("Gains","v2") ;
+//  m->ReadFromRoot(&myanotherdata) ;
 //
 //*-- Author :  D.Peressounko (RRC KI & SUBATECH) 
 //////////////////////////////////////////////////////////////////////////////
@@ -28,7 +42,7 @@
 #include "TFile.h"
 
 // --- Standard library ---
-#include <fstream>
+#include <fstream> 
 
 // --- AliRoot header files ---
 #include "AliPHOSConTableDB.h"
@@ -41,6 +55,7 @@ AliPHOSCalibrManager * AliPHOSCalibrManager::fgCaMa = 0 ;
 //____________________________________________________________________________ 
 AliPHOSCalibrManager::AliPHOSCalibrManager():TNamed() 
 {
+  // default ctor: not to be used
   fctdb = 0 ;
   fFileName="" ;
   Fatal("Default constructor","Should not use") ;
@@ -54,6 +69,7 @@ AliPHOSCalibrManager::AliPHOSCalibrManager(const char* filename ):
 //____________________________________________________________________________ 
   AliPHOSCalibrManager::~AliPHOSCalibrManager()
 {
+  //dtor
   TFile * f = gROOT->GetFile(fFileName) ;
   if(f && f->IsOpen())
     f->Close() ;
@@ -64,11 +80,15 @@ AliPHOSCalibrManager::AliPHOSCalibrManager(const char* filename ):
 //____________________________________________________________________________ 
 AliPHOSCalibrManager * AliPHOSCalibrManager::GetInstance(void)
 { 
+  // gets the instance of the unique object
  return fgCaMa ;
 }
 //____________________________________________________________________________ 
 AliPHOSCalibrManager * AliPHOSCalibrManager::GetInstance(const char* filename )
 {
+  // Opens source (now only root file) and
+  // returns the instance of the unique object
+
   if(!fgCaMa)
     fgCaMa = new AliPHOSCalibrManager(filename) ;
   else{
@@ -81,7 +101,8 @@ AliPHOSCalibrManager * AliPHOSCalibrManager::GetInstance(const char* filename )
   return fgCaMa ;       
 }
 //____________________________________________________________________________
-void AliPHOSCalibrManager::ReadFromASCII(AliPHOSCalibrationData &data,const char * filename){
+void AliPHOSCalibrManager::ReadFromASCII(AliPHOSCalibrationData &data,const char * filename)
+{
   //reads calibration parameters from ascii file
 
   if(!fctdb){
@@ -97,7 +118,8 @@ void AliPHOSCalibrManager::ReadFromASCII(AliPHOSCalibrationData &data,const char
   file.close();   
 }
 //____________________________________________________________________________
-void AliPHOSCalibrManager::ReadFromRoot(AliPHOSCalibrationData & data,Int_t run){
+void AliPHOSCalibrManager::ReadFromRoot(AliPHOSCalibrationData & data,Int_t run)
+{
   //reads calibration parameters from root file
 
   //construct name
@@ -134,7 +156,9 @@ void AliPHOSCalibrManager::ReadFromRoot(AliPHOSCalibrationData & data,Int_t run)
   Error("ReadFromRoot","Can not find key %s for run %d in file %s \n",searchname.Data(),run,fFileName.Data()) ;
 }
 //____________________________________________________________________________
-void AliPHOSCalibrManager::WriteData(AliPHOSCalibrationData * data){
+void AliPHOSCalibrManager::WriteData(AliPHOSCalibrationData * data)
+{
+  //Writes data
   TFile * file = gROOT->GetFile(fFileName) ;
   if(!file || !file->IsOpen()){
     file = TFile::Open(fFileName,"UPDATE") ;
@@ -159,7 +183,7 @@ void AliPHOSCalibrManager::WriteData(AliPHOSCalibrationData * data){
 //____________________________________________________________________________
 AliPHOSCalibrManager& AliPHOSCalibrManager::operator=(AliPHOSCalibrManager const & cdb)
 {
-  //
+  //overloads = operator
   fFileName = cdb.fFileName;
   return *this ;
 }