RootHistCnv::RConverter Class Reference

Root Converter. More...

#include <src/RConverter.h>

Inheritance diagram for RootHistCnv::RConverter:

Collaboration diagram for RootHistCnv::RConverter:

Public Member Functions
StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&refpAddr) override
	Convert the transient object to the requested representation. More...
long	repSvcType () const override
StatusCode	error (const std::string &msg)
StatusCode	regTFile (const std::string, const TFile *)
StatusCode	findTFile (const std::string, TFile *&)
std::string	diskDirectory (const std::string &loc)
std::string	directory (const std::string &loc)
void	setDirectory (const std::string &loc)
void	setDiskDirectory (const std::string &loc)
StatusCode	createDirectory (const std::string &loc)
StatusCode	createDiskDirectory (const std::string &loc)
std::string	getDirectory ()
std::string	convertId (const std::string &) const
Public Member Functions inherited from Converter
StatusCode	initialize () override
	Initialize the converter. More...
StatusCode	finalize () override
	Initialize the converter. More...
StatusCode	setDataProvider (IDataProviderSvc *svc) override
	Set Data provider service. More...
SmartIF< IDataProviderSvc > &	dataProvider () const override
	Get Data provider service. More...
StatusCode	setConversionSvc (IConversionSvc *svc) override
	Set conversion service the converter is connected to. More...
SmartIF< IConversionSvc > &	conversionSvc () const override
	Get conversion service the converter is connected to. More...
StatusCode	setAddressCreator (IAddressCreator *creator) override
	Set address creator facility. More...
SmartIF< IAddressCreator > &	addressCreator () const override
	Retrieve address creator facility. More...
const CLID &	objType () const override
	Retrieve the class type of objects the converter produces. More...
virtual long	i_repSvcType () const
	Retrieve the class type of the data store the converter uses. More...
StatusCode	createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
	Create the transient representation of an object. More...
StatusCode	fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the created transient object. More...
StatusCode	updateObj (IOpaqueAddress *pAddress, DataObject *refpObject) override
	Update the transient object from the other representation. More...
StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an updated transient object. More...
StatusCode	createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
	Convert the transient object to the requested representation. More...
StatusCode	fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the converted object. More...
StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the converted representation of a transient object. More...
StatusCode	updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an already converted object. More...
	Converter (long storage_type, const CLID &class_type, ISvcLocator *svc=0)
	Standard Constructor. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&psvc) const
	Access a service by name, type creating it if it doesn't already exist. More...
SmartIF< IService >	service (const std::string &name, const bool createIf=true) const
	Return a pointer to the service identified by name (or "type/name") More...
StatusCode	initialize () override
	Initialize the converter. More...
StatusCode	finalize () override
	Initialize the converter. More...
StatusCode	setDataProvider (IDataProviderSvc *svc) override
	Set Data provider service. More...
SmartIF< IDataProviderSvc > &	dataProvider () const override
	Get Data provider service. More...
StatusCode	setConversionSvc (IConversionSvc *svc) override
	Set conversion service the converter is connected to. More...
SmartIF< IConversionSvc > &	conversionSvc () const override
	Get conversion service the converter is connected to. More...
StatusCode	setAddressCreator (IAddressCreator *creator) override
	Set address creator facility. More...
SmartIF< IAddressCreator > &	addressCreator () const override
	Retrieve address creator facility. More...
const CLID &	objType () const override
	Retrieve the class type of objects the converter produces. More...
virtual long	i_repSvcType () const
	Retrieve the class type of the data store the converter uses. More...
StatusCode	createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
	Create the transient representation of an object. More...
StatusCode	fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the created transient object. More...
StatusCode	updateObj (IOpaqueAddress *pAddress, DataObject *refpObject) override
	Update the transient object from the other representation. More...
StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an updated transient object. More...
StatusCode	createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
	Convert the transient object to the requested representation. More...
StatusCode	fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the converted object. More...
StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the converted representation of a transient object. More...
StatusCode	updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an already converted object. More...
	Converter (long storage_type, const CLID &class_type, ISvcLocator *svc=0)
	Standard Constructor. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&psvc) const
	Access a service by name, type creating it if it doesn't already exist. More...
SmartIF< IService >	service (const std::string &name, const bool createIf=true) const
	Return a pointer to the service identified by name (or "type/name") More...
Public Member Functions inherited from implements< Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
	~implements () override=default
	Virtual destructor. More...
unsigned long	addRef () override
	Reference Interface instance. More...
unsigned long	release () override
	Release Interface instance. More...
unsigned long	refCount () const override
	Current reference count. More...
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
	~implements () override=default
	Virtual destructor. More...
unsigned long	addRef () override
	Reference Interface instance. More...
unsigned long	release () override
	Release Interface instance. More...
unsigned long	refCount () const override
	Current reference count. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Static Public Member Functions
static long	storageType ()
	Inquire storage type. More...

Protected Member Functions
	RConverter (const CLID &clid, ISvcLocator *svc)
	Standard constructor. More...
	~RConverter () override=default
	Standard destructor. More...
virtual StatusCode	readObject (IOpaqueAddress *pAddr, DataObject *&refpObj)
	Create the transient representation of an object. More...
virtual TObject *	createPersistent (DataObject *pObj)
	Create the persistent representation of an object. More...
StatusCode	createAddress (DataObject *pObject, TDirectory *pDir, TObject *pTObject, IOpaqueAddress *&refpAddr)
	Create address of the transient object according to the requested representation. More...
StatusCode	createAddress (const std::string &rzdir, const CLID &clid, long id, TObject *pTobj, IOpaqueAddress *&refpAddress)
StatusCode	createAddress (const std::string &rzdir, const CLID &clid, const std::string &title, TObject *pTobj, IOpaqueAddress *&refpAddress)
TDirectory *	changeDirectory (DataObject *pObject)
	Switch to object directory (=Parent directory) More...
Protected Member Functions inherited from Converter
	~Converter () override=default
	Standard Destructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const
	Retrieve pointer to service locator. More...
SmartIF< IMessageSvc > &	msgSvc () const
	Retrieve pointer to message service. More...
SmartIF< IMessageSvc > &	messageService () const
SmartIF< IDataManagerSvc > &	dataManager () const
	Get Data Manager service. More...
	~Converter () override=default
	Standard Destructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const
	Retrieve pointer to service locator. More...
SmartIF< IMessageSvc > &	msgSvc () const
	Retrieve pointer to message service. More...
SmartIF< IMessageSvc > &	messageService () const
SmartIF< IDataManagerSvc > &	dataManager () const
	Get Data Manager service. More...

Additional Inherited Members
Public Types inherited from Converter
typedef Gaudi::PluginService::Factory< IConverter *, ISvcLocator * >	Factory
typedef Gaudi::PluginService::Factory< IConverter *, ISvcLocator * >	Factory
Public Types inherited from implements< Interfaces >
using	base_class = implements< Interfaces...>
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
using	base_class = implements< Interfaces...>
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
Protected Attributes inherited from implements< Interfaces >
std::atomic_ulong	m_refCount = {0}
	Reference counter. More...

Detailed Description

Root Converter.

Author

Charles Leggett

Definition at line 34 of file RConverter.h.

Constructor & Destructor Documentation

RootHistCnv::RConverter::RConverter ( const CLID &  clid, ISvcLocator *  svc  )

inlineprotected

Standard constructor.

Definition at line 59 of file RConverter.h.

    : Converter(storageType(), clid, svc)  {    }

RootHistCnv::RConverter::~RConverter ( )

overrideprotecteddefault

Standard destructor.

Member Function Documentation

TDirectory * RootHistCnv::RConverter::changeDirectory ( DataObject *  pObject )

protected

Switch to object directory (=Parent directory)

Definition at line 226 of file RConverter.cpp.

{
  if ( pObject )    {
    IRegistry* pReg = pObject->registry();
    if ( pReg )    {
      auto dataMgr = dataProvider().as<IDataManagerSvc>();
      if ( dataMgr )    {
        IRegistry* pParentReg = nullptr;
        StatusCode status = dataMgr->objectParent(pReg, pParentReg);
        if ( status.isSuccess() )  {
          IOpaqueAddress* pParAddr = pParentReg->address();
          if ( pParAddr )   {
            TDirectory* pParentDir = (TDirectory*)pParAddr->ipar()[0];
            if ( pParentDir )   {
              gDirectory->cd(pParentDir->GetPath());
              return pParentDir;
            }
          }
        }
      }
    }
  }
  return nullptr;
}

std::string RootHistCnv::RConverter::convertId

(

const std::string &

id

)

const

Definition at line 351 of file RConverter.cpp.

{
  bool forced = false;
  if ( id.size() > 0 && isdigit(id[0]) ) {
    try {
      BooleanProperty tmp;
      tmp.assign(conversionSvc().as<IProperty>()->getProperty( "ForceAlphaIds"));
      forced = tmp.value();
    }
    catch ( ... ) { }
  }
  if (forced )  return "h" + id;
  else          return id;
}

StatusCode RootHistCnv::RConverter::createAddress ( DataObject *  pObject, TDirectory *  pDir, TObject *  pTObject, IOpaqueAddress *&  refpAddr  )

protected

Create address of the transient object according to the requested representation.

Definition at line 161 of file RConverter.cpp.

{
  // Get address again....it does not change
  IRegistry* pReg = pObj->registry();
  if ( pReg )    {
    refpAddr = pReg->address();
    if ( !refpAddr )    {
      refpAddr = new RootObjAddress(repSvcType(),
                    objType(),
                    pReg->name(),
                    "",
                    (unsigned long)(pDir),
                    (unsigned long)(pTObj),
                    pTObj);

      return StatusCode::SUCCESS;
    }
  }
  return StatusCode::FAILURE;
}

StatusCode RootHistCnv::RConverter::createAddress ( const std::string &  rzdir, const CLID &  clid, long  id, TObject *  pTobj, IOpaqueAddress *&  refpAddress  )

protected

Definition at line 208 of file RConverter.cpp.

{
  auto obj = std::to_string(id);
  StatusCode status = createAddress(rzdir, clid, obj, pTobj, refpAddress);
  if ( status.isSuccess() )   {
    unsigned long* ipar = (unsigned long*)refpAddress->ipar();
    ipar[0] = id;
  }
  return status;
}

StatusCode RootHistCnv::RConverter::createAddress ( const std::string &  rzdir, const CLID &  clid, const std::string &  title, TObject *  pTobj, IOpaqueAddress *&  refpAddress  )

protected

Definition at line 187 of file RConverter.cpp.

{
  auto  pA = new RootObjAddress(repSvcType(),
                      clid,
                      rzdir,
                      title,
                      0,
                      0,
                      pTObj );

  refpAddress = pA;
  return StatusCode::SUCCESS;
}

StatusCode RootHistCnv::RConverter::createDirectory

(

const std::string &

loc

)

Definition at line 24 of file RConverter.cpp.

{
  MsgStream log(msgSvc(), "RConverter::createDir");

  // Get rid of leading /NTUPLES
  std::string full = diskDirectory( loc );

  std::string fil,cur,s;
  TDirectory *gDir = gDirectory;

  TFile *tf = nullptr;
  if ( findTFile(loc,tf).isSuccess() ) {
    tf->cd();
  }

  std::vector<std::string> lpath;
  int i = 1;

  auto p=full.find(":",0);
  if ( p != std::string::npos ) {
    fil = full.substr(0,p);
    i = p+1;
    fil += ":/";
    gDirectory->cd(fil.c_str());
  }

  while ( (p = full.find("/",i)) != std::string::npos ) {
    s = full.substr(i,p-i);
    lpath.push_back(s);
    i = p+1;
  }
  lpath.push_back( full.substr(i) );

  if ( full.compare(0,1,"/") == 0 ) gDirectory->cd("/");

  for(const auto& litr : lpath ) {
    cur = litr;
    if (! gDirectory->GetKey(litr.c_str()) ) {
      gDirectory->mkdir(litr.c_str());
    }
    gDirectory->cd(litr.c_str());
  }

  gDirectory = gDir;

  return StatusCode::SUCCESS;
}

StatusCode RootHistCnv::RConverter::createDiskDirectory

(

const std::string &

loc

)

TObject * RootHistCnv::RConverter::createPersistent ( DataObject *  pObj )

protectedvirtual

Create the persistent representation of an object.

Reimplemented in RootHistCnv::RHistogramCnv< T, S, Q >.

Definition at line 292 of file RConverter.cpp.

{
  return nullptr;
}

StatusCode RootHistCnv::RConverter::createRep ( DataObject *  pObj, IOpaqueAddress *&  refpAddr  )

override

Convert the transient object to the requested representation.

Definition at line 254 of file RConverter.cpp.

{
  GlobalDirectoryRestore restore;
  pAddr = nullptr;
  try   {
    TDirectory* pParentDir = changeDirectory(pObject);
    if ( pParentDir )   {
      TObject* pTObj = createPersistent(pObject);
      if ( pTObj )   {
        pTObj->Write();
        delete pTObj;
        return createAddress(pObject, pParentDir, nullptr, pAddr);
      }
    }
  }
  catch (...)   {
  }
  MsgStream log (msgSvc(), "RConverter");
  log << MSG::ERROR << "Failed to create persistent Object!" << endmsg;
  return StatusCode::FAILURE;
}

std::string RootHistCnv::RConverter::directory

(

const std::string &

loc

)

Definition at line 105 of file RConverter.cpp.

{
  return diskDirectory(loc);
}

std::string RootHistCnv::RConverter::diskDirectory

(

const std::string &

loc

)

Definition at line 73 of file RConverter.cpp.

{
  // Get rid of leading /NTUPLES/{INPUT_STREAM} or /stat/{INPUT_STREAM}
  std::string dir;
  long lf1 = loc.find("/NTUPLES/");
  long lf2 = loc.find("/stat/");
  long ll;
  if (lf1 != -1) {
    ll = loc.find("/",lf1+9);

  } else if (lf2 != -1) {
    ll = loc.find("/",lf2+6);

  } else {
    MsgStream log(msgSvc(), "RConverter");
    log << MSG::ERROR << "diskDirectory(" << loc << ")"
    << " --> no leading /NTUPLES/ or /stat/" << endmsg;
    return loc;
  }
  //  dir = loc.substr(ll+8);

  if (ll == -1) {
    dir = "/";
  } else {
    dir = loc.substr(ll);
  }

  return dir;
}

StatusCode RootHistCnv::RConverter::error

(

const std::string &

msg

)

Definition at line 367 of file RConverter.cpp.

{
  MsgStream log(msgSvc(), "RootHistCnv");
  log << MSG::ERROR << msg << endmsg;
  return StatusCode::FAILURE;
}

StatusCode RootHistCnv::RConverter::findTFile	(	const std::string	id,
		TFile *&	tfile
	)

Definition at line 316 of file RConverter.cpp.

{
  MsgStream log(msgSvc(), "RConverter");
  tfile = nullptr;

  std::string idm;

  // make sure we only get first two parts of id
  int i1,i2,i3;
  i1 = id.find("/",0);
  if (i1 != 0) {
    log << MSG::ERROR << "Directory name does not start with \"/\": "
    << id << endmsg;
    return StatusCode::FAILURE;
  }
  i2 = id.find("/",i1+1);
  if (i2 == -1) {
    log << MSG::ERROR << "Directory name has only one part: " << id << endmsg;
    return StatusCode::FAILURE;
  }
  i3 = id.find("/",i2+1);
  if (i3 == -1) {
    idm = id;
  } else {
    idm = id.substr(0,i3);
  }

  auto imap = s_fileMap.find(idm);
  if ( imap == s_fileMap.end() ) return StatusCode::FAILURE;
  tfile = imap->second;
  return StatusCode::SUCCESS;
}

std::string RootHistCnv::RConverter::getDirectory

(

)

Definition at line 153 of file RConverter.cpp.

{
  return gDirectory->GetPath();
}

StatusCode RootHistCnv::RConverter::readObject ( IOpaqueAddress *  pAddr, DataObject *&  refpObj  )

protectedvirtual

Create the transient representation of an object.

Definition at line 279 of file RConverter.cpp.

{
//    MsgStream log(msgSvc(), "RConverter::readObject");
//    log << MSG::WARNING << pAddr->par()[0] << " <> " << pAddr->par()[1]
//        << " <> "
//        << pAddr->ipar()[0] << " <> " << pAddr->ipar()[1] << " <> "
//        << pAddr->registry()->identifier() << endmsg;

  return StatusCode::SUCCESS;
}

StatusCode RootHistCnv::RConverter::regTFile	(	const std::string	id,
		const TFile *	tfile
	)

Definition at line 299 of file RConverter.cpp.

{
  auto imap = s_fileMap.find(id);
  if ( imap != s_fileMap.end() ) {
    MsgStream log(msgSvc(), "RConverter");
    log << MSG::ERROR << "cannot register TTree " << id
        << ": already exists" << endmsg;
    return StatusCode::FAILURE;
  }
  s_fileMap[id] = const_cast<TFile*>(tfile);

  return StatusCode::SUCCESS;
}

long RootHistCnv::RConverter::repSvcType ( ) const

inlineoverride

Definition at line 41 of file RConverter.h.

{         return i_repSvcType();      }

void RootHistCnv::RConverter::setDirectory

(

const std::string &

loc

)

Definition at line 112 of file RConverter.cpp.

{
  MsgStream log(msgSvc(), "RConverter");
  TFile *tf = nullptr;

  std::string full = diskDirectory( loc );

  // get associated TFile
  if ( findTFile(loc,tf).isSuccess() ) {
    tf->cd();
  } else {
    log << MSG::ERROR << "error getting TFile name " << loc << endmsg;
  }

  int p,i=1;
  std::string cur,sdir;

  gDirectory->cd("/");
  while ( (p = full.find("/",i)) != -1) {
    sdir = full.substr(i,p-i);
    if (! gDirectory->GetKey(sdir.c_str()) ) {
      log << MSG::ERROR << "cannot cd to " << full << " from "
      << gDirectory->GetPath() << endmsg;
      return;
    }
    gDirectory->cd(sdir.c_str());

    i = p+1;
  }
  gDirectory->cd( full.substr(i).c_str() );
}

void RootHistCnv::RConverter::setDiskDirectory

(

const std::string &

loc

)

Definition at line 146 of file RConverter.cpp.

{
  setDirectory(loc);
}

static long RootHistCnv::RConverter::storageType ( )

inlinestatic

Inquire storage type.

Definition at line 40 of file RConverter.h.

{         return ROOT_StorageType;    }

---

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

• RootHistCnv/src/RConverter.h
• RootHistCnv/src/RConverter.cpp