RootEmcCalibDataCnv Class Reference

#include <RootEmcCalibDataCnv.h>

Inheritance diagram for RootEmcCalibDataCnv:


Public Types
typedef Ty1	source
typedef Ty2	destination
Public Member Functions
const CLID &	objType () const
	RootEmcCalibDataCnv (ISvcLocator *svc)
virtual	~RootEmcCalibDataCnv ()
virtual StatusCode	createRoot (const std::string &fname, CalibData::CalibBase1 *pTDSObj)
virtual long	repSvcType () const
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
virtual StatusCode	createObj (IOpaqueAddress addr, DataObject &refpObject)
ICalibRootSvc *	getCalibRootSvc ()
virtual StatusCode	readRootObj (const std::string &treename, const std::string &branch, TObject *&pCalib, unsigned index=0)
virtual StatusCode	readRootObj (TTree tree, const std::string &branch, TObject &pCalib, unsigned index=0)
destination *	operator (const source &) const
Static Public Member Functions
static const CLID &	classID ()
static const unsigned char	storageType ()
Protected Member Functions
virtual StatusCode	i_createObj (const std::string &fname, DataObject *&refpObject)
virtual StatusCode	internalCreateObj (const std::string &fname, DataObject &refpObject, IOpaqueAddress address)
virtual StatusCode	i_processObj (DataObject pObject, IOpaqueAddress address)
	In case there is additional work to do on the created object.
virtual StatusCode	fillRoot (CalibData::CalibBase pTDSObj, TObject pRootObj)
virtual StatusCode	openWrite (const std::string &fname)
StatusCode	closeWrite ()
StatusCode	openRead (const std::string &fname)
StatusCode	closeRead ()
void	setBaseInfo (CalibData::CalibBase1 *pObj)
	Another utility for derived classes to use.
virtual destination *	convert (const source &) const =0
Protected Attributes
ICalibRootSvc *	m_rootSvc
ICalibMetaCnvSvc *	m_metaSvc
IInstrumentName *	m_instrSvc
int	m_serNo
ITime *	m_vstart
ITime *	m_vend
int	m_runfrm
int	m_runto
TFile *	m_outFile
TTree *	m_ttree
TFile *	m_inFile
TDirectory *	m_saveDir
Friends
class	CnvFactory< RootEmcCalibDataCnv >

Detailed Description

Base class for CAL calibration converters from ROOT files to TCDS. All such converters need to do certain things, which are handled here. Methods common to *all* calibrations are in the base class RootCalBaseCnv

Author:: J. Bogart

Definition at line 21 of file RootEmcCalibDataCnv.h.

Member Typedef Documentation

template<class Ty1, class Ty2>

typedef Ty2 Converter< Ty1, Ty2 >::destination [inherited]

Definition at line 19 of file Converter.h.

template<class Ty1, class Ty2>

typedef Ty1 Converter< Ty1, Ty2 >::source [inherited]

Definition at line 18 of file Converter.h.

Constructor & Destructor Documentation

RootEmcCalibDataCnv::RootEmcCalibDataCnv ( ISvcLocator * svc )

Definition at line 31 of file RootEmcCalibDataCnv.cxx.

00031                                                           :
00032   RootCalBaseCnv(svc, CLID_Calib_EmcCal) { 
00033 
00034 }

virtual RootEmcCalibDataCnv::~RootEmcCalibDataCnv ( ) [inline, virtual]

Definition at line 30 of file RootEmcCalibDataCnv.h.

00030 {};

Member Function Documentation

const CLID & RootEmcCalibDataCnv::classID ( ) [static]

Definition at line 41 of file RootEmcCalibDataCnv.cxx.

References CLID_Calib_EmcCal.

00041                                          {
00042   return CLID_Calib_EmcCal;
00043 }

StatusCode RootCalBaseCnv::closeRead ( ) [protected, inherited]

Clean up when we've finished reading in

Definition at line 135 of file RootCalBaseCnv.cxx.

References RootCalBaseCnv::m_inFile, and RootCalBaseCnv::m_saveDir.

Referenced by RootCalBaseCnv::internalCreateObj().

00135                                      {
00136   m_inFile->Close();
00137 
00138   delete m_inFile;
00139   m_inFile = 0;
00140 
00141   if (m_saveDir) {
00142     m_saveDir->cd();
00143     m_saveDir = 0;
00144   }
00145   return StatusCode::SUCCESS;
00146 }

StatusCode RootCalBaseCnv::closeWrite ( ) [protected, inherited]

Finish up writing file opened with openWrite: fill the tree write the file close the file Delete TFile (causes associated Tree to be deleted)

Definition at line 182 of file RootCalBaseCnv.cxx.

References RootCalBaseCnv::m_outFile, RootCalBaseCnv::m_saveDir, and msgSvc().

Referenced by RootTofCalibDataCnv::createRoot(), RootMdcCalibDataCnv::createRoot(), RootEstTofCalibDataCnv::createRoot(), createRoot(), and RootDedxCalibDataCnv::createRoot().

00182                                       {
00183 
00184   MsgStream log(msgSvc(), "RootCalBaseCnv");
00185 
00186   StatusCode ret = StatusCode::SUCCESS;
00187 
00188   m_outFile->cd();
00189   m_outFile->Close();
00190   delete m_outFile;
00191   m_outFile = 0;
00192   if (m_saveDir) m_saveDir->cd();
00193   m_saveDir = 0;
00194   return ret;
00195 }

template<class Ty1, class Ty2>

virtual destination* Converter< Ty1, Ty2 >::convert ( const source & ) const [protected, pure virtual, inherited]

StatusCode RootCalBaseCnv::createObj	(	IOpaqueAddress *	addr,
		DataObject *&	refpObject
	)			`[virtual, inherited]`

Create the transient representation of an object, given an opaque address. This and the following update method comprise the core functionality of calibration converters.

Definition at line 252 of file RootCalBaseCnv.cxx.

References Bes_Common::DEBUG, RootCalBaseCnv::internalCreateObj(), msgSvc(), and deljobs::string.

00253                                                            {
00254   //  StatusCode ret;
00255 
00256   // first do the things we always need:
00257   //   First string parameter of opaque address is file ident
00258   MsgStream log(msgSvc(), "RootCalBaseCnv");
00259    log << MSG::DEBUG<<"RootCalBaseCnv::createObj( starting ...."<<endreq;
00260    const std::string* par = addr->par();
00261 
00262   std::string par0 = par[0];
00263    
00264   return internalCreateObj(par0, refpObject, addr);
00265 
00266 }

StatusCode RootEmcCalibDataCnv::createRoot	(	const std::string &	fname,
		CalibData::CalibBase1 *	pTDSObj
	)			`[virtual]`

Create ROOT file corresponding to TDS object input. Default implementation is to return an error. Must be separately implemented for each calibration type.

Parameters:

	fname	Filename for output file
	pTDSObj	Pointer to tds object to be converted

Reimplemented from RootCalBaseCnv.

Definition at line 82 of file RootEmcCalibDataCnv.cxx.

References RootCalBaseCnv::closeWrite(), calibUtil::ERROR, genRecEmupikp::i, Bes_Common::INFO, msgSvc(), and RootCalBaseCnv::openWrite().

00083                                                                       {
00084  
00085   MsgStream log(msgSvc(), "RootEmcCalibDataCnv");
00086 
00087  // Open the file, create the branch
00088    StatusCode sc = openWrite(fname);
00089   if(!sc)
00090     { log<<MSG::ERROR<<"unable to open files"<<endreq;
00091     }
00092   // write the Data in the TCDS to RootFile
00093      CalibData::EmcCalibData* tmpObject = dynamic_cast<CalibData::EmcCalibData*>(pTDSObj);
00094      int tmpNo;
00095      double EmcCalibConst;
00096      int EmcIxtalNumber;
00097      int i;
00098 
00099      //DigiCalibConst------------------------------------------------------------------
00100      TTree *Digitree = new TTree("DigiCalibConst", "DigiCalibConst");
00101      Digitree -> Branch("DigiCalibConst", &EmcCalibConst, "EmcCalibConst/D");
00102      Digitree -> Branch("IxtalNumber", &EmcIxtalNumber, "IxtalNumber/I");
00103      tmpNo = tmpObject -> getDigiCalibConstNo();
00104      for(i=0; i<tmpNo; i++){
00105           EmcCalibConst = tmpObject -> getDigiCalibConst(i);
00106           EmcIxtalNumber = tmpObject -> getIxtalNumber(i);
00107           Digitree -> Fill();
00108      }
00109 
00110      
00111      Digitree -> Write();
00112 
00113    
00114      delete Digitree;
00115     
00116      closeWrite();
00117      log<<MSG::INFO<<"successfully create RootFile"<<endreq;
00118      return sc;
00119 
00120 }

StatusCode RootCalBaseCnv::fillRoot	(	CalibData::CalibBase *	pTDSObj,
		TObject *	pRootObj
	)			`[protected, virtual, inherited]`

Given a pointer to a TDS object which can be cast to "our" type, fill in corresponding information in the corresponding root class

Parameters:

	pTDSObj	Pointer to tds object to be converted
	pRootObj	Pointer to destination root object

...maybe don't need pRootObj argument; keep this as the (protected) data member m_rootObj. Or else this routine could set the protected member to this passed-in value

Definition at line 241 of file RootCalBaseCnv.cxx.

00242                                                           {
00243 
00244   // Get instrument name from InstrumentName service  Now handled by 
00245   // RootCalBaseCnv
00246   //  TString instr = TString((m_instrSvc->getInstrumentName()).c_str());
00247   //  pRootObj->setInstrument(instr);
00248   return StatusCode::SUCCESS;
00249 }

StatusCode RootCalBaseCnv::finalize ( ) [virtual, inherited]

Definition at line 82 of file RootCalBaseCnv.cxx.

00082                                     {
00083   return Converter::finalize();
00084 }

ICalibRootSvc* RootCalBaseCnv::getCalibRootSvc ( ) [inline, inherited]

Definition at line 58 of file RootCalBaseCnv.h.

References RootCalBaseCnv::m_rootSvc.

00058                                    {
00059     return m_rootSvc;
00060   }

StatusCode RootEmcCalibDataCnv::i_createObj	(	const std::string &	fname,
		DataObject *&	refpObject
	)			`[protected, virtual]`

This creates the transient representation of an object from the corresponding ROOT object. This actually does the "new" operation and deals with the attributes of the node. This base class implementation does nothing; it should not normally be called because it doesn't correspond to any TCDS class. Instead, i_createObj of some derived class will be called.

Parameters:

	fname	The ROOT file to be read in to be used to builds the object
	refpObject	the object to be built

Returns:: status depending on the completion of the call

Reimplemented from RootCalBaseCnv.

Definition at line 45 of file RootEmcCalibDataCnv.cxx.

References Bes_Common::DEBUG, calibUtil::ERROR, genRecEmupikp::i, RootCalBaseCnv::m_inFile, msgSvc(), and RootCalBaseCnv::openRead().

00046                                                                 {
00047 
00048   MsgStream log(msgSvc(), "RootEmcCalibDataCnv");
00049   log<<MSG::DEBUG<<"SetProperty"<<endreq;
00050  
00051   StatusCode sc = openRead(fname);
00052   if(!sc)
00053     { log<<MSG::ERROR<<"unable to open files"<<endreq;
00054     }
00055  
00056   CalibData::EmcCalibData *tmpObject = new CalibData::EmcCalibData ;
00057   // Read in our object
00058   int i;
00059   int nentries;
00060   
00061   // read DigiCalibConst ------------------------------------------------------------
00062      double EmcCalibConst[6240];
00063      int EmcIxtalNumber[6240];
00064      vector<double> DigiCalibConst;
00065      vector<int> IxtalNumber;
00066      TTree *Digitree = (TTree*)m_inFile -> Get("DigiCalibConst");
00067      Digitree -> SetBranchAddress("DigiCalibConst", EmcCalibConst);
00068      Digitree -> SetBranchAddress("IxtalNumber", EmcIxtalNumber);
00069      Digitree -> GetEntry(0);
00070      for(i=0; i<6240; i++){
00071            DigiCalibConst.push_back(EmcCalibConst[i]);
00072            IxtalNumber.push_back(EmcIxtalNumber[i]); 
00073      }
00074      tmpObject -> setDigiCalibConst(&DigiCalibConst);
00075      tmpObject -> setIxtalNumber(&IxtalNumber);
00076     
00077     refpObject=tmpObject;
00078 
00079   return StatusCode::SUCCESS;
00080 }

StatusCode RootCalBaseCnv::i_processObj	(	DataObject *	pObject,
		IOpaqueAddress *	address
	)			`[protected, virtual, inherited]`

In case there is additional work to do on the created object.

Definition at line 322 of file RootCalBaseCnv.cxx.

Referenced by RootCalBaseCnv::internalCreateObj().

00323                                                                       {
00324   return StatusCode::SUCCESS;
00325 }

StatusCode RootCalBaseCnv::initialize ( ) [virtual, inherited]

Definition at line 46 of file RootCalBaseCnv.cxx.

References IID_ICalibMetaCnvSvc(), IID_ICalibRootSvc(), IID_IInstrumentName(), RootCalBaseCnv::m_instrSvc, RootCalBaseCnv::m_metaSvc, and RootCalBaseCnv::m_rootSvc.

00046                                       {
00047   StatusCode status = Converter::initialize();
00048 
00049   IDataProviderSvc* dp;
00050 
00051   // I guess the service names are assigned in jobOptions?
00052 
00053   /*serviceLocator()->getService ("CalibDataSvc",
00054                                 IID_IDataProviderSvc,
00055                                 (IInterface*&)dp);*/
00056   serviceLocator()->getService ("CalibDataSvc",
00057                                 IDataProviderSvc::interfaceID(),
00058                                 (IInterface*&)dp);
00059   setDataProvider(dp);
00060   
00061   // Locate the Root Conversion Service
00062   serviceLocator()->getService ("CalibRootCnvSvc",
00063                                 IID_ICalibRootSvc,
00064                                 (IInterface*&) m_rootSvc);
00065 
00066   // Locate meta conversion service
00067   // Will anything need to be changed here to accommodate possibility
00068   // of two concrete implementations of ICalibMetaCnvSvc?  Would
00069   // have different storage types.  Could specify type desired
00070   // as job option.  Ditto for name of class?
00071   serviceLocator()->getService("CalibMySQLCnvSvc", 
00072                                IID_ICalibMetaCnvSvc,
00073                                 (IInterface*&)m_metaSvc);
00074 
00075   serviceLocator()->getService ("CalibDataSvc",
00076                                 IID_IInstrumentName,
00077                                 (IInterface*&)m_instrSvc);
00078 
00079   return status;
00080 }

StatusCode RootCalBaseCnv::internalCreateObj	(	const std::string &	fname,
		DataObject *&	refpObject,
		IOpaqueAddress *	address
	)			`[protected, virtual, inherited]`

This creates the transient representation of an object from the corresponding ROOT object it, then fills it and process it. This implementation actually only calls the i_* methods of the "right" converter to do the job; so the very first thing it does is get a pointer to the appropriate derived converter. Converters typically don't need to override this method but only to override/implement some of the i_* methods.

Parameters:

	pRootObj	pointer to the ROOT object
	refpObject	the object to be built
	address	the opaque address for this object

Returns:: status depending on the completion of the call

Definition at line 268 of file RootCalBaseCnv.cxx.

References RootCalBaseCnv::closeRead(), Bes_Common::DEBUG, calibUtil::ERROR, RootCalBaseCnv::i_createObj(), RootCalBaseCnv::i_processObj(), RootCalBaseCnv::m_runfrm, RootCalBaseCnv::m_runto, msgSvc(), RootCalBaseCnv::setBaseInfo(), and Bes_Common::WARNING.

Referenced by RootCalBaseCnv::createObj().

00270                                                                    {
00271   MsgStream log(msgSvc(), "RootCalBaseCnv");
00272    log << MSG::DEBUG<<"RootCalBaseCnv::internalCreateObj( starting ..... "<<endreq;
00273    RootCalBaseCnv* converter = this;
00274   CLID classId = address->clID();
00275 
00276   IConverter* conv = this->conversionSvc()->converter(classId);
00277   if (0 == conv) {
00278     log << MSG::WARNING
00279         << "No proper converter found for classID " << classId
00280             << ", the default converter"
00281             << " will be used. " << endreq;
00282   } else {
00283     converter = dynamic_cast <RootCalBaseCnv*> (conv);
00284     if (0 == converter) {
00285       log << MSG::ERROR
00286           << "The converter found for classID " << classId
00287               << " was not a descendent of RootCalBaseCnv as it should be "
00288               << "( was of type " << typeid (*converter).name() << "). "
00289               << "The default converter will be used" << endreq;
00290       converter = this;
00291     }
00292   }
00293 
00294     m_runfrm =*( address->ipar());
00295     m_runto =*( address->ipar()+1);
00296    // creates an object for the node found
00297    StatusCode sc = converter->i_createObj(fname, refpObject);
00298      if (sc.isFailure()) {
00299     return sc;
00300   } 
00301      CalibData::CalibBase1* tmpObject =  dynamic_cast <CalibData::CalibBase1*> (refpObject);
00302      setBaseInfo(tmpObject);
00303   // ends up the object construction
00304   sc = converter->i_processObj(refpObject, address);
00305   if (sc.isSuccess()) {
00306     log << MSG::DEBUG << "Successfully created calib. object " << endreq;
00307   }
00308   closeRead();
00309   return sc;
00310 }

const CLID & RootEmcCalibDataCnv::objType ( ) const

Definition at line 37 of file RootEmcCalibDataCnv.cxx.

References CLID_Calib_EmcCal.

00037                                                {
00038   return CLID_Calib_EmcCal;
00039 }

StatusCode RootCalBaseCnv::openRead ( const std::string & fname ) [protected, inherited]

Utility for "leaf" converters to call

Parameters:

	Root	file to open for read
	Name	of branch to be read in
	ref.	to pCalib pointer which will be set to address of read-in object

Definition at line 98 of file RootCalBaseCnv.cxx.

References RootCalBaseCnv::doClean(), calibUtil::ERROR, Bes_Common::INFO, RootCalBaseCnv::m_inFile, RootCalBaseCnv::m_saveDir, msgSvc(), deljobs::string, and Bes_Common::WARNING.

Referenced by RootTofSimDataCnv::i_createObj(), RootTofElecDataCnv::i_createObj(), RootTofCalibDataCnv::i_createObj(), RootMucCalibDataCnv::i_createObj(), RootMdcCalibDataCnv::i_createObj(), RootEstTofCalibDataCnv::i_createObj(), RootEsTimeCalibDataCnv::i_createObj(), i_createObj(), RootDedxSimDataCnv::i_createObj(), and RootDedxCalibDataCnv::i_createObj().

00098                                                           { 
00099 
00100   MsgStream log(msgSvc(), "RootCalBaseCnv");
00101 
00102   // Check fname isn't empty
00103   if (fname == std::string("")) return StatusCode::FAILURE;
00104 
00105   if (doClean() ) {
00106     log << MSG::WARNING << "Previous operation didn't clean up! " << endreq;
00107   }
00108   m_saveDir = gDirectory;
00109 
00110   std::string ourName(fname);
00111   facilities::Util::expandEnvVar(&ourName);
00112 
00113   m_inFile = new TFile(ourName.c_str());
00114   
00115   if (!m_inFile->IsOpen() ) {
00116     log << MSG::ERROR << "ROOT file " << ourName 
00117         << "could not be opened for reading " << endreq;
00118     delete m_inFile;
00119     m_inFile = 0;
00120     return StatusCode::FAILURE;
00121   }
00122   else {
00123     log << MSG::INFO
00124         << "Successfully opened ROOT file " << fname << " aka " << ourName
00125         << " for reading " << endreq;
00126   }
00127 
00128 
00129   m_inFile->cd();             //    Maybe will need this
00130 
00131 
00132   return StatusCode::SUCCESS;
00133 }

StatusCode RootCalBaseCnv::openWrite ( const std::string & fname ) [protected, virtual, inherited]

Utility used by derived converters to start writing a ROOT file (open TFile, make a TTree, give it a branch)

Parameters:

	fname	Name for new file
	className	Name of class for object specified in next parameter; used to name branch as well)
	pCalib	pointer to object used to create the branch

Definition at line 148 of file RootCalBaseCnv.cxx.

References RootCalBaseCnv::doClean(), calibUtil::ERROR, Bes_Common::INFO, RootCalBaseCnv::m_outFile, RootCalBaseCnv::m_saveDir, msgSvc(), deljobs::string, and Bes_Common::WARNING.

Referenced by RootTofSimDataCnv::createRoot(), RootTofCalibDataCnv::createRoot(), RootMdcCalibDataCnv::createRoot(), RootEstTofCalibDataCnv::createRoot(), RootEsTimeCalibDataCnv::createRoot(), createRoot(), RootDedxSimDataCnv::createRoot(), and RootDedxCalibDataCnv::createRoot().

00148                                                            {
00149 
00150   MsgStream log(msgSvc(), "RootCalBaseCnv");
00151 
00152   // Check fname isn't empty
00153   if (fname == std::string("")) return StatusCode::FAILURE;
00154 
00155   std::string ourName(fname);
00156   facilities::Util::expandEnvVar(&ourName);
00157 
00158   if (doClean() ) {
00159     log << MSG::WARNING << "Previous operation didn't clean up! " << endreq;
00160   }
00161 
00162   m_saveDir = gDirectory;
00163 
00164  
00165   m_outFile = new TFile(ourName.c_str(), "RECREATE");
00166   if (!m_outFile->IsOpen()) {
00167     log << MSG::ERROR << "ROOT file " << fname << " aka " << ourName 
00168         << " could not be opened for writing" << endreq;
00169     delete m_outFile;
00170     m_outFile = 0;
00171     return StatusCode::FAILURE;
00172   }
00173   else {
00174     log << MSG::INFO
00175         << "Successfully opened ROOT file " << fname << " aka " << ourName
00176         << " for writing " << endreq;
00177   }
00178    m_outFile->cd();
00179   return StatusCode::SUCCESS;
00180 }

template<class Ty1, class Ty2>

destination* Converter< Ty1, Ty2 >::operator ( const source & ) const [inline, inherited]

StatusCode RootCalBaseCnv::readRootObj	(	TTree *	tree,
		const std::string &	branch,
		TObject *&	pCalib,
		unsigned	index = `0`
	)			`[virtual, inherited]`

Definition at line 206 of file RootCalBaseCnv.cxx.

00208                                                                 {
00209   TBranch* pBranch=pTree->GetBranch(branch.c_str());
00210   pBranch->SetAddress(&pObj);
00211   int nBytes = pBranch->GetEntry(ix);
00212   return (nBytes > 0) ? StatusCode::SUCCESS : StatusCode::FAILURE;
00213  }

StatusCode RootCalBaseCnv::readRootObj	(	const std::string &	treename,
		const std::string &	branch,
		TObject *&	pCalib,
		unsigned	index = `0`
	)			`[virtual, inherited]`

Read in object (by default the first) from specified branch.

Definition at line 198 of file RootCalBaseCnv.cxx.

References RootCalBaseCnv::m_inFile.

00200                                                                 {
00201   TTree* pTree = (TTree*)m_inFile->Get(treename.c_str());
00202 
00203   return readRootObj(pTree, branch, pObj, ix);
00204  }

virtual long RootEmcCalibDataCnv::repSvcType ( ) const [inline, virtual]

Definition at line 34 of file RootEmcCalibDataCnv.h.

References CALIBROOT_StorageType.

00034                                  { 
00035           return CALIBROOT_StorageType; 
00036       }

void RootCalBaseCnv::setBaseInfo ( CalibData::CalibBase1 * pObj ) [protected, inherited]

Another utility for derived classes to use.

Another convenience for derived classes: sets information belonging to the calibration base class, namely validity interval and serial number.

Definition at line 328 of file RootCalBaseCnv.cxx.

References Bes_Common::DEBUG, RootCalBaseCnv::m_runfrm, RootCalBaseCnv::m_runto, msgSvc(), CalibData::CalibBase1::setrunfrm(), and CalibData::CalibBase1::setrunto().

Referenced by RootCalBaseCnv::internalCreateObj().

00328                                                           {
00329    MsgStream log(msgSvc(), "RootCalBaseCnv");
00330    log << MSG::DEBUG<<"set the runfrm and runto Numbers in the converter"<<endreq;
00331   pObj->setrunfrm(m_runfrm);
00332   pObj->setrunto(m_runto);
00333 }