RootCalBaseCnv Class Reference

#include <RootCalBaseCnv.h>

Inheritance diagram for RootCalBaseCnv:

Public Member Functions
virtual	~RootCalBaseCnv ()
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
virtual StatusCode	createObj (IOpaqueAddress *addr, DataObject *&refpObject)
ICalibRootSvc *	getCalibRootSvc ()
	RootCalBaseCnv (ISvcLocator *svc, const CLID &clid)
virtual StatusCode	createRoot (const std::string &fname, CalibData::CalibBase1 *pTDSObj)
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)
Public Member Functions inherited from Converter< Ty1, Ty2 >
destination *	operator (const source &) const

Static Public Member Functions
static const unsigned char	storageType ()

Protected Member Functions
virtual StatusCode	internalCreateObj (const std::string &fname, DataObject *&refpObject, IOpaqueAddress *address)
virtual StatusCode	i_createObj (const std::string &fname, DataObject *&refpObject)
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.
Protected Member Functions inherited from Converter< Ty1, Ty2 >
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

Additional Inherited Members
Public Types inherited from Converter< Ty1, Ty2 >
typedef Ty1	source
typedef Ty2	destination

Detailed Description

Base class for calibration converters from XML files to TCDS. All such converters need to do certain things, which are handled here.

Author

J. Bogart

Definition at line 39 of file RootCalBaseCnv.h.

Constructor & Destructor Documentation

~RootCalBaseCnv()

RootCalBaseCnv::~RootCalBaseCnv ( )

virtual

     @file  RootCalBaseCnv.cxx

Implementation file for Root calibration converter base class

Definition at line 31 of file RootCalBaseCnv.cxx.

                                {
  // release TFile, TTree if they need releasing.  With normal 
  // termination they should already have been released.
 
  // doClean();
 
}

RootCalBaseCnv()

RootCalBaseCnv::RootCalBaseCnv	(	ISvcLocator *	svc,
		const CLID &	clid )

Constructor for this converter

Parameters

svc	a ISvcLocator interface to find services
clid	the type of object the converter is able to convert

Definition at line 41 of file RootCalBaseCnv.cxx.

                                                                  :
  Converter (CALIBROOT_StorageType, clid, svc),
  m_rootSvc (0), m_metaSvc(0), m_instrSvc(0), m_vstart(0), m_vend(0),
  m_outFile(0), m_ttree(0), m_inFile(0), m_saveDir(0) {}

Member Function Documentation

closeRead()

StatusCode RootCalBaseCnv::closeRead ( )

protected

Clean up when we've finished reading in

Definition at line 133 of file RootCalBaseCnv.cxx.

                                     {
  m_inFile->Close();
 
  delete m_inFile;
  m_inFile = 0;
 
  if (m_saveDir) {
    m_saveDir->cd();
    m_saveDir = 0;
  }
  return StatusCode::SUCCESS;
}

Referenced by internalCreateObj().

closeWrite()

StatusCode RootCalBaseCnv::closeWrite ( )

protected

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 180 of file RootCalBaseCnv.cxx.

                                      {
 
  MsgStream log(msgSvc(), "RootCalBaseCnv");
 
  StatusCode ret = StatusCode::SUCCESS;
 
  m_outFile->cd();
  m_outFile->Close();
  delete m_outFile;
  m_outFile = 0;
  if (m_saveDir) m_saveDir->cd();
  m_saveDir = 0;
  return ret;
}

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

createObj()

StatusCode RootCalBaseCnv::createObj ( IOpaqueAddress * addr, DataObject *& refpObject )

virtual

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 250 of file RootCalBaseCnv.cxx.

                                                           {
  //  StatusCode ret;
 
  // first do the things we always need:
  //   First string parameter of opaque address is file ident
  MsgStream log(msgSvc(), "RootCalBaseCnv");
   log << MSG::DEBUG<<"RootCalBaseCnv::createObj( starting ...."<<endreq;
   const std::string* par = addr->par();
 
  std::string par0 = par[0];
   
  return internalCreateObj(par0, refpObject, addr);
 
}

createRoot()

StatusCode RootCalBaseCnv::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 in RootCorrectedETSCnv, RootDedxCalibDataCnv, RootDedxSimDataCnv, RootEmcCalibDataCnv, RootEsTimeCalibDataCnv, RootEstTofCalibDataCnv, RootInjSigIntervalCnv, RootInjSigTimeCnv, RootMdcCalibDataCnv, RootMucCalibDataCnv, RootOffEvtFilterCnv, RootTofCalibDataCnv, and RootTofSimDataCnv.

Definition at line 87 of file RootCalBaseCnv.cxx.

                                                           {
  MsgStream log(msgSvc(), "RootCalBaseCnv");
  log << MSG::ERROR 
      << "createRoot method not implemented for this calibration type" 
      << endreq;
  return StatusCode::FAILURE;
}

Referenced by CalibRootCnvSvc::writeToRoot().

fillRoot()

StatusCode RootCalBaseCnv::fillRoot ( CalibData::CalibBase * pTDSObj, TObject * pRootObj )

protectedvirtual

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 239 of file RootCalBaseCnv.cxx.

                                             {
 
  // Get instrument name from InstrumentName service  Now handled by 
  // RootCalBaseCnv
  //  TString instr = TString((m_instrSvc->getInstrumentName()).c_str());
  //  pRootObj->setInstrument(instr);
  return StatusCode::SUCCESS;
}

finalize()

StatusCode RootCalBaseCnv::finalize ( )

virtual

Definition at line 80 of file RootCalBaseCnv.cxx.

                                    {
  return Converter::finalize();
}

getCalibRootSvc()

ICalibRootSvc * RootCalBaseCnv::getCalibRootSvc ( )

inline

Definition at line 58 of file RootCalBaseCnv.h.

                                   {
    return m_rootSvc;
  }

i_createObj()

StatusCode RootCalBaseCnv::i_createObj ( const std::string & fname, DataObject *& refpObject )

protectedvirtual

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 in RootCorrectedETSCnv, RootDedxCalibDataCnv, RootDedxSimDataCnv, RootEmcCalibDataCnv, RootEsTimeCalibDataCnv, RootEstTofCalibDataCnv, RootInjSigIntervalCnv, RootInjSigTimeCnv, RootMdcCalibDataCnv, RootMucCalibDataCnv, RootOffEvtFilterCnv, RootTofCalibDataCnv, RootTofElecDataCnv, and RootTofSimDataCnv.

Definition at line 314 of file RootCalBaseCnv.cxx.

                                                     {
  return StatusCode::FAILURE;  // shouldn't ever get here
}

Referenced by internalCreateObj().

i_processObj()

StatusCode RootCalBaseCnv::i_processObj ( DataObject * pObject, IOpaqueAddress * address )

protectedvirtual

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

Definition at line 320 of file RootCalBaseCnv.cxx.

                                                          {
  return StatusCode::SUCCESS;
}

Referenced by internalCreateObj().

initialize()

StatusCode RootCalBaseCnv::initialize ( )

virtual

Definition at line 46 of file RootCalBaseCnv.cxx.

                                      {
  StatusCode status = Converter::initialize();
 
  IDataProviderSvc* dp;
 
  // I guess the service names are assigned in jobOptions?
 
  /*serviceLocator()->getService ("CalibDataSvc",
                                IID_IDataProviderSvc,
                                (IInterface*&)dp);*/
  serviceLocator()->getService ("CalibDataSvc",
                                IDataProviderSvc::interfaceID(),
                                (IInterface*&)dp);
  setDataProvider(dp);
  // Locate the Root Conversion Service
  serviceLocator()->getService ("CalibRootCnvSvc",
                               ICalibRootSvc::interfaceID(),
                                (IInterface*&) m_rootSvc);
 
  // Locate meta conversion service
  // Will anything need to be changed here to accommodate possibility
  // of two concrete implementations of ICalibMetaCnvSvc?  Would
  // have different storage types.  Could specify type desired
  // as job option.  Ditto for name of class?
  serviceLocator()->getService("CalibMySQLCnvSvc",
                               ICalibMetaCnvSvc::interfaceID(),
                                (IInterface*&)m_metaSvc);
  serviceLocator()->getService ("CalibDataSvc",
                               IInstrumentName::interfaceID(),
                                (IInterface*&)m_instrSvc);
 
  return status;
}

internalCreateObj()

StatusCode RootCalBaseCnv::internalCreateObj ( const std::string & fname, DataObject *& refpObject, IOpaqueAddress * address )

protectedvirtual

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 266 of file RootCalBaseCnv.cxx.

                                                                   {
  MsgStream log(msgSvc(), "RootCalBaseCnv");
   log << MSG::DEBUG<<"RootCalBaseCnv::internalCreateObj( starting ..... "<<endreq;
   RootCalBaseCnv* converter = this;
  CLID classId = address->clID();
 
  IConverter* conv = this->conversionSvc()->converter(classId);
  if (0 == conv) {
    log << MSG::WARNING
        << "No proper converter found for classID " << classId
            << ", the default converter"
            << " will be used. " << endreq;
  } else {
    converter = dynamic_cast <RootCalBaseCnv*> (conv);
    if (0 == converter) {
      log << MSG::ERROR
          << "The converter found for classID " << classId
              << " was not a descendent of RootCalBaseCnv as it should be "
              << "( was of type " << typeid (*converter).name() << "). "
              << "The default converter will be used" << endreq;
      converter = this;
    }
  }
 
    m_runfrm =*( address->ipar());
    m_runto =*( address->ipar()+1);
   // creates an object for the node found
   StatusCode sc = converter->i_createObj(fname, refpObject);
     if (sc.isFailure()) {
    return sc;
  } 
     CalibData::CalibBase1* tmpObject =  dynamic_cast <CalibData::CalibBase1*> (refpObject);
     setBaseInfo(tmpObject);
  // ends up the object construction
  sc = converter->i_processObj(refpObject, address);
  if (sc.isSuccess()) {
    log << MSG::DEBUG << "Successfully created calib. object " << endreq;
  }
  closeRead();
  return sc;
}

Referenced by createObj().

openRead()

StatusCode RootCalBaseCnv::openRead ( const std::string & fname )

protected

 Utility for "leaf" converters to call
 @param    Root file to open for read

Parameters

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

Definition at line 96 of file RootCalBaseCnv.cxx.

                                                          { 
 
  MsgStream log(msgSvc(), "RootCalBaseCnv");
 
  // Check fname isn't empty
  if (fname == std::string("")) return StatusCode::FAILURE;
 
  if (doClean() ) {
    log << MSG::WARNING << "Previous operation didn't clean up! " << endreq;
  }
  m_saveDir = gDirectory;
 
  std::string ourName(fname);
  facilities::Util::expandEnvVar(&ourName);
 
  m_inFile = new TFile(ourName.c_str());
  
  if (!m_inFile->IsOpen() ) {
    log << MSG::ERROR << "ROOT file " << ourName 
        << "could not be opened for reading " << endreq;
    delete m_inFile;
    m_inFile = 0;
    return StatusCode::FAILURE;
  }
  else {
    log << MSG::INFO
        << "Successfully opened ROOT file " << fname << " aka " << ourName
        << " for reading " << endreq;
  }
 
 
  m_inFile->cd();             //    Maybe will need this
 
 
  return StatusCode::SUCCESS;
}

Referenced by RootCorrectedETSCnv::i_createObj(), RootDedxCalibDataCnv::i_createObj(), RootDedxSimDataCnv::i_createObj(), RootEmcCalibDataCnv::i_createObj(), RootEsTimeCalibDataCnv::i_createObj(), RootEstTofCalibDataCnv::i_createObj(), RootInjSigIntervalCnv::i_createObj(), RootInjSigTimeCnv::i_createObj(), RootMdcCalibDataCnv::i_createObj(), RootMucCalibDataCnv::i_createObj(), RootOffEvtFilterCnv::i_createObj(), RootTofCalibDataCnv::i_createObj(), RootTofElecDataCnv::i_createObj(), and RootTofSimDataCnv::i_createObj().

openWrite()

StatusCode RootCalBaseCnv::openWrite ( const std::string & fname )

protectedvirtual

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 146 of file RootCalBaseCnv.cxx.

                                                           {
 
  MsgStream log(msgSvc(), "RootCalBaseCnv");
 
  // Check fname isn't empty
  if (fname == std::string("")) return StatusCode::FAILURE;
 
  std::string ourName(fname);
  facilities::Util::expandEnvVar(&ourName);
 
  if (doClean() ) {
    log << MSG::WARNING << "Previous operation didn't clean up! " << endreq;
  }
 
  m_saveDir = gDirectory;
 
 
  m_outFile = new TFile(ourName.c_str(), "RECREATE");
  if (!m_outFile->IsOpen()) {
    log << MSG::ERROR << "ROOT file " << fname << " aka " << ourName 
        << " could not be opened for writing" << endreq;
    delete m_outFile;
    m_outFile = 0;
    return StatusCode::FAILURE;
  }
  else {
    log << MSG::INFO
        << "Successfully opened ROOT file " << fname << " aka " << ourName
        << " for writing " << endreq;
  }
   m_outFile->cd();
  return StatusCode::SUCCESS;
}

Referenced by RootCorrectedETSCnv::createRoot(), RootDedxCalibDataCnv::createRoot(), RootDedxSimDataCnv::createRoot(), RootEmcCalibDataCnv::createRoot(), RootEsTimeCalibDataCnv::createRoot(), RootEstTofCalibDataCnv::createRoot(), RootInjSigIntervalCnv::createRoot(), RootInjSigTimeCnv::createRoot(), RootMdcCalibDataCnv::createRoot(), RootOffEvtFilterCnv::createRoot(), RootTofCalibDataCnv::createRoot(), and RootTofSimDataCnv::createRoot().

readRootObj() [1/2]

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

virtual

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

Definition at line 196 of file RootCalBaseCnv.cxx.

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

Referenced by readRootObj().

readRootObj() [2/2]

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

virtual

Definition at line 204 of file RootCalBaseCnv.cxx.

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

setBaseInfo()

void RootCalBaseCnv::setBaseInfo ( CalibData::CalibBase1 * pObj )

protected

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 326 of file RootCalBaseCnv.cxx.

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

Referenced by internalCreateObj().

storageType()

static const unsigned char RootCalBaseCnv::storageType ( )

inlinestatic

Definition at line 62 of file RootCalBaseCnv.h.

{return CALIBROOT_StorageType;}

Member Data Documentation

m_inFile

TFile* RootCalBaseCnv::m_inFile

protected

Definition at line 207 of file RootCalBaseCnv.h.

Referenced by closeRead(), RootCorrectedETSCnv::i_createObj(), RootDedxCalibDataCnv::i_createObj(), RootDedxSimDataCnv::i_createObj(), RootEmcCalibDataCnv::i_createObj(), RootEsTimeCalibDataCnv::i_createObj(), RootEstTofCalibDataCnv::i_createObj(), RootInjSigIntervalCnv::i_createObj(), RootInjSigTimeCnv::i_createObj(), RootMdcCalibDataCnv::i_createObj(), RootMucCalibDataCnv::i_createObj(), RootOffEvtFilterCnv::i_createObj(), RootTofCalibDataCnv::i_createObj(), RootTofElecDataCnv::i_createObj(), RootTofSimDataCnv::i_createObj(), openRead(), and readRootObj().

m_instrSvc

IInstrumentName* RootCalBaseCnv::m_instrSvc

protected

Definition at line 195 of file RootCalBaseCnv.h.

Referenced by initialize().

m_metaSvc

ICalibMetaCnvSvc* RootCalBaseCnv::m_metaSvc

protected

Definition at line 194 of file RootCalBaseCnv.h.

Referenced by initialize().

m_outFile

TFile* RootCalBaseCnv::m_outFile

protected

Definition at line 204 of file RootCalBaseCnv.h.

Referenced by closeWrite(), and openWrite().

m_rootSvc

ICalibRootSvc* RootCalBaseCnv::m_rootSvc

protected

Definition at line 193 of file RootCalBaseCnv.h.

Referenced by getCalibRootSvc(), and initialize().

m_runfrm

int RootCalBaseCnv::m_runfrm

protected

Definition at line 200 of file RootCalBaseCnv.h.

Referenced by internalCreateObj(), and setBaseInfo().

m_runto

int RootCalBaseCnv::m_runto

protected

Definition at line 201 of file RootCalBaseCnv.h.

Referenced by internalCreateObj(), and setBaseInfo().

m_saveDir

TDirectory* RootCalBaseCnv::m_saveDir

protected

Definition at line 209 of file RootCalBaseCnv.h.

Referenced by closeRead(), closeWrite(), openRead(), and openWrite().

m_serNo

int RootCalBaseCnv::m_serNo

protected

Definition at line 197 of file RootCalBaseCnv.h.

m_ttree

TTree* RootCalBaseCnv::m_ttree

protected

Definition at line 205 of file RootCalBaseCnv.h.

m_vend

ITime* RootCalBaseCnv::m_vend

protected

Definition at line 199 of file RootCalBaseCnv.h.

m_vstart

ITime* RootCalBaseCnv::m_vstart

protected

Definition at line 198 of file RootCalBaseCnv.h.

---

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

• RootCalBaseCnv.h
• RootCalBaseCnv.cxx