#include <TreeCalBaseCnv.h>

Inheritance diagram for TreeCalBaseCnv:

Public Member Functions
virtual	~TreeCalBaseCnv ()
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
virtual StatusCode	createObj (IOpaqueAddress addr, DataObject &refpObject)
ICalibTreeSvc *	getCalibTreeSvc ()
	TreeCalBaseCnv (ISvcLocator *svc, const CLID &clid)
virtual StatusCode	createRoot (const std::string &fname, CalibData::CalibBase1 *pTDSObj)
Public Member Functions inherited from Converter< Ty1, Ty2 >
destination *	operator (const source &) const
destination *	operator (const source &) const
destination *	operator (const source &) const

Static Public Member Functions
static const unsigned char	storageType ()

Protected Member Functions
virtual StatusCode	internalCreateObj (DataObject &refpObject, IOpaqueAddress address)
virtual StatusCode	i_createObj (IOpaqueAddress address, 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)
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
virtual destination *	convert (const source &) const =0
virtual destination *	convert (const source &) const =0

Protected Attributes
ICalibTreeSvc *	m_treeSvc
ICalibMetaCnvSvc *	m_metaSvc
IInstrumentName *	m_instrSvc
int	m_serNo
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
typedef Ty1	source
typedef Ty2	destination
typedef Ty1	source
typedef Ty2	destination

Detailed Description

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

Author: HUANG Bin

Definition at line 38 of file TreeCalBaseCnv.h.

Constructor & Destructor Documentation

◆ ~TreeCalBaseCnv()

TreeCalBaseCnv::~TreeCalBaseCnv ( )

virtual

     @file  TreeCalBaseCnv.cxx

Implementation file for Root calibration converter base class

Definition at line 32 of file TreeCalBaseCnv.cxx.

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

◆ TreeCalBaseCnv()

TreeCalBaseCnv::TreeCalBaseCnv	(	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 TreeCalBaseCnv.cxx.

    : Converter( CALIBTREE_StorageType, clid, svc )
    , m_treeSvc( 0 )
    , m_metaSvc( 0 )
    , m_instrSvc( 0 )
    , m_outFile( 0 )
    , m_ttree( 0 )
    , m_inFile( 0 )
    , m_saveDir( 0 ) {}

Referenced by internalCreateObj(), TreeCorrectedETSCnv::TreeCorrectedETSCnv(), TreeDedxCalibDataCnv::TreeDedxCalibDataCnv(), TreeDedxSimDataCnv::TreeDedxSimDataCnv(), TreeEmcCalibDataCnv::TreeEmcCalibDataCnv(), TreeEsTimeCalibDataCnv::TreeEsTimeCalibDataCnv(), TreeEstTofCalibDataCnv::TreeEstTofCalibDataCnv(), TreeInjSigIntervalCnv::TreeInjSigIntervalCnv(), TreeInjSigTimeCnv::TreeInjSigTimeCnv(), TreeMdcAlignDataCnv::TreeMdcAlignDataCnv(), TreeMdcCalibDataCnv::TreeMdcCalibDataCnv(), TreeMdcDataConstCnv::TreeMdcDataConstCnv(), TreeMucCalibDataCnv::TreeMucCalibDataCnv(), TreeOffEvtFilterCnv::TreeOffEvtFilterCnv(), TreeTofCalibDataCnv::TreeTofCalibDataCnv(), TreeTofElecDataCnv::TreeTofElecDataCnv(), and TreeTofSimDataCnv::TreeTofSimDataCnv().

Member Function Documentation

◆ createObj()

StatusCode TreeCalBaseCnv::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 111 of file TreeCalBaseCnv.cxx.

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

◆ createRoot()

StatusCode TreeCalBaseCnv::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

Definition at line 92 of file TreeCalBaseCnv.cxx.

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

◆ fillRoot()

StatusCode TreeCalBaseCnv::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 100 of file TreeCalBaseCnv.cxx.

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

◆ finalize()

StatusCode TreeCalBaseCnv::finalize ( )

virtual

Definition at line 88 of file TreeCalBaseCnv.cxx.

88{ return Converter::finalize(); }

◆ getCalibTreeSvc()

ICalibTreeSvc * TreeCalBaseCnv::getCalibTreeSvc ( )

inline

Definition at line 54 of file TreeCalBaseCnv.h.

54{ return m_treeSvc; }

◆ i_createObj()

StatusCode TreeCalBaseCnv::i_createObj	(	IOpaqueAddress *	address,
		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 TreeCorrectedETSCnv, TreeDedxCalibDataCnv, TreeDedxSimDataCnv, TreeEmcCalibDataCnv, TreeEsTimeCalibDataCnv, TreeEstTofCalibDataCnv, TreeInjSigIntervalCnv, TreeInjSigTimeCnv, TreeMdcAlignDataCnv, TreeMdcCalibDataCnv, TreeMdcDataConstCnv, TreeMucCalibDataCnv, TreeOffEvtFilterCnv, TreeTofCalibDataCnv, TreeTofElecDataCnv, and TreeTofSimDataCnv.

Definition at line 181 of file TreeCalBaseCnv.cxx.

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

Referenced by internalCreateObj().

◆ i_processObj()

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

protectedvirtual

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

Definition at line 187 of file TreeCalBaseCnv.cxx.

                                                             {
  return StatusCode::SUCCESS;
}

Referenced by internalCreateObj().

◆ initialize()

StatusCode TreeCalBaseCnv::initialize ( )

virtual

Definition at line 51 of file TreeCalBaseCnv.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 ("CalibTreeCnvSvc",
  //                              IID_ICalibTreeSvc,
  //                              (IInterface*&) m_treeSvc);
  IInterface* m_treeSvc = serviceLocator()->service( "CalibTreeCnvSvc" );
  // 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",
                               IID_ICalibMetaCnvSvc,
                                (IInterface*&)m_metaSvc);
  */
  IInterface* m_metaSvc = serviceLocator()->service( "CalibMySQLCnvSvc" );
  /*serviceLocator()->getService ("CalibDataSvc",
                                IID_IInstrumentName,
                                (IInterface*&)m_instrSvc);*/
  IInterface* m_instrSvc = serviceLocator()->service( "CalibDataSvc" );
 
  return status;
}

◆ internalCreateObj()

StatusCode TreeCalBaseCnv::internalCreateObj	(	DataObject *&	refpObject,
		IOpaqueAddress *	address )

protectedvirtual

Read in object (by default the first) from specified branch. 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 129 of file TreeCalBaseCnv.cxx.

                                                                        {
 
  MsgStream log( msgSvc(), "TreeCalBaseCnv" );
  log << MSG::DEBUG << "TreeCalBaseCnv::internalCreateObj( starting ..... " << endmsg;
  TreeCalBaseCnv* 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. " << endmsg;
  }
  else
  {
    converter = dynamic_cast<TreeCalBaseCnv*>( conv );
    if ( 0 == converter )
    {
      log << MSG::ERROR << "The converter found for classID " << classId
          << " was not a descendent of TreeCalBaseCnv as it should be "
          << "( was of type " << typeid( *converter ).name() << "). "
          << "The default converter will be used" << endmsg;
      converter = this;
    }
  }
 
  TreeAddress* treeAddress = dynamic_cast<TreeAddress*>( address );
  m_runfrm                 = treeAddress->getRunFrom();
  m_runto                  = treeAddress->getRunTo();
  // m_runfrm =*( address->ipar());
  // m_runto =*( address->ipar()+1);
  //   m_runfrm = 100;
  //   m_runto =1000;
  // creates an object for the node found
  StatusCode sc = converter->i_createObj( address, 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 " << endmsg; }
  // closeRead();
  return sc;
}

Referenced by createObj().

◆ setBaseInfo()

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

protected

Another utility for derived classes to use.

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 Finish up writing file opened with openWrite: fill the tree write the file close the file Delete TFile (causes associated Tree to be deleted) Utility for "leaf" converters to call @param 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 Clean up when we've finished reading in Another convenience for derived classes: sets information belonging to the calibration base class, namely validity interval and serial number.

Definition at line 193 of file TreeCalBaseCnv.cxx.

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

Referenced by internalCreateObj().

◆ storageType()

const unsigned char TreeCalBaseCnv::storageType ( )

inlinestatic

Definition at line 56 of file TreeCalBaseCnv.h.

56{ return CALIBTREE_StorageType; }

Member Data Documentation

◆ m_inFile

TFile* TreeCalBaseCnv::m_inFile

protected

Definition at line 198 of file TreeCalBaseCnv.h.

Referenced by TreeCalBaseCnv().

◆ m_instrSvc

IInstrumentName* TreeCalBaseCnv::m_instrSvc

protected

Definition at line 188 of file TreeCalBaseCnv.h.

Referenced by initialize(), and TreeCalBaseCnv().

◆ m_metaSvc

ICalibMetaCnvSvc* TreeCalBaseCnv::m_metaSvc

protected

Definition at line 187 of file TreeCalBaseCnv.h.

Referenced by initialize(), and TreeCalBaseCnv().

◆ m_outFile

TFile* TreeCalBaseCnv::m_outFile

protected

Definition at line 195 of file TreeCalBaseCnv.h.

Referenced by TreeCalBaseCnv().

◆ m_runfrm

int TreeCalBaseCnv::m_runfrm

protected

Definition at line 191 of file TreeCalBaseCnv.h.

Referenced by internalCreateObj(), and setBaseInfo().

◆ m_runto

int TreeCalBaseCnv::m_runto

protected

Definition at line 192 of file TreeCalBaseCnv.h.

Referenced by internalCreateObj(), and setBaseInfo().

◆ m_saveDir

TDirectory* TreeCalBaseCnv::m_saveDir

protected

Definition at line 200 of file TreeCalBaseCnv.h.

Referenced by TreeCalBaseCnv().

◆ m_serNo

int TreeCalBaseCnv::m_serNo

protected

Definition at line 190 of file TreeCalBaseCnv.h.

◆ m_treeSvc

ICalibTreeSvc* TreeCalBaseCnv::m_treeSvc

protected

Definition at line 186 of file TreeCalBaseCnv.h.

Referenced by getCalibTreeSvc(), initialize(), and TreeCalBaseCnv().

◆ m_ttree

TTree* TreeCalBaseCnv::m_ttree

protected

Definition at line 196 of file TreeCalBaseCnv.h.

Referenced by TreeCalBaseCnv().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~TreeCalBaseCnv()

◆ TreeCalBaseCnv()

Member Function Documentation

◆ createObj()

◆ createRoot()

◆ fillRoot()

◆ finalize()

◆ getCalibTreeSvc()

◆ i_createObj()

◆ i_processObj()

◆ initialize()

◆ internalCreateObj()

◆ setBaseInfo()

◆ storageType()

Member Data Documentation

◆ m_inFile

◆ m_instrSvc

◆ m_metaSvc

◆ m_outFile

◆ m_runfrm

◆ m_runto

◆ m_saveDir

◆ m_serNo

◆ m_treeSvc

◆ m_ttree