Gaudi::RootDatabaseCnv Class Reference

Statistics file converter class definition. More...

#include <Root/RootDatabaseCnv.h>

Inheritance diagram for Gaudi::RootDatabaseCnv:

Collaboration diagram for Gaudi::RootDatabaseCnv:

Public Member Functions
	RootDatabaseCnv (long typ, const CLID &, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
	~RootDatabaseCnv () override=default
	Standard destructor. More...
const std::string	containerName (IRegistry *) const override
	Retrieve the name of the container a given object is placed into. More...
StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&refpObj) override
	Converter overrides: Create transient object from persistent data. More...
	RootDatabaseCnv (long typ, const CLID &, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
	~RootDatabaseCnv () override=default
	Standard destructor. More...
const std::string	containerName (IRegistry *) const override
	Retrieve the name of the container a given object is placed into. More...
StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&refpObj) override
	Converter overrides: Create transient object from persistent data. More...
Public Member Functions inherited from Gaudi::RootDirectoryCnv
	RootDirectoryCnv (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
virtual	~RootDirectoryCnv ()
	Standard Destructor. More...
virtual StatusCode	fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Resolve the references of the transient object. More...
virtual StatusCode	updateObj (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Update transient object from persistent data. More...
virtual StatusCode	updateObjRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Update the references of an updated transient object. More...
virtual StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&refpAddr)
	Converter overrides: Convert the transient object to the requested representation. More...
virtual StatusCode	fillRepRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Fill references of persistent object representation. More...
virtual StatusCode	updateRep (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Update persistent object representation. More...
virtual StatusCode	updateRepRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Update references of persistent object representation. More...
	RootDirectoryCnv (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
virtual	~RootDirectoryCnv ()
	Standard Destructor. More...
virtual StatusCode	fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Resolve the references of the transient object. More...
virtual StatusCode	updateObj (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Update transient object from persistent data. More...
virtual StatusCode	updateObjRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Update the references of an updated transient object. More...
virtual StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&refpAddr)
	Converter overrides: Convert the transient object to the requested representation. More...
virtual StatusCode	fillRepRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Fill references of persistent object representation. More...
virtual StatusCode	updateRep (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Update persistent object representation. More...
virtual StatusCode	updateRepRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Converter overrides: Update references of persistent object representation. More...
Public Member Functions inherited from Gaudi::RootStatCnv
	RootStatCnv (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
	~RootStatCnv () override=default
	Standard Destructor. More...
	RootStatCnv (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
	~RootStatCnv () override=default
	Standard Destructor. More...
Public Member Functions inherited from Gaudi::RootConverter
	RootConverter (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
virtual	~RootConverter ()
	Standard Destructor. More...
virtual long	repSvcType () const
	Retrieve the class type of the data store the converter uses. More...
	RootConverter (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
virtual	~RootConverter ()
	Standard Destructor. More...
virtual long	repSvcType () const
	Retrieve the class type of the data store the converter uses. More...
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...

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 Member Functions inherited from Gaudi::RootStatCnv
MsgStream &	log () const
	Helper to use mesage logger. More...
StatusCode	initialize () override
	Initialize converter object. More...
StatusCode	finalize () override
	Finalize converter object. More...
virtual const std::string	fileName (IRegistry *pReg) const
	Retrieve the name of the file a given object is placed into. More...
virtual const std::string	topLevel (IRegistry *pReg) const
	Retrieve the full path of the file a given object is placed into. More...
StatusCode	makeError (const std::string &msg, bool throw_exception=false) const
	Helper method to issue error messages. More...
StatusCode	saveDescription (const std::string &path, const std::string &ident, const std::string &desc, const std::string &opt, const CLID &clid)
	Save statistics object description. More...
MsgStream &	log () const
	Helper to use mesage logger. More...
StatusCode	initialize () override
	Initialize converter object. More...
StatusCode	finalize () override
	Finalize converter object. More...
virtual const std::string	fileName (IRegistry *pReg) const
	Retrieve the name of the file a given object is placed into. More...
virtual const std::string	topLevel (IRegistry *pReg) const
	Retrieve the full path of the file a given object is placed into. More...
StatusCode	makeError (const std::string &msg, bool throw_exception=false) const
	Helper method to issue error messages. More...
StatusCode	saveDescription (const std::string &path, const std::string &ident, const std::string &desc, const std::string &opt, const CLID &clid)
	Save statistics object description. 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...
Protected Attributes inherited from Gaudi::RootStatCnv
SmartIF< IDataManagerSvc >	m_dataMgr
	Reference to data manager service to manipulate the TES. More...
std::unique_ptr< MsgStream >	m_log
	Reference to logger object. More...
Protected Attributes inherited from Gaudi::RootConverter
RootCnvSvc *	m_dbMgr
	Conversion service needed for proper operation to forward requests. More...
Protected Attributes inherited from implements< Interfaces >
unsigned long	m_refCount = 0
	Reference counter. More...

Detailed Description

Statistics file converter class definition.

Description: Definition of the converter to open root database files.

Author

M.Frank

Version

1.0

Definition at line 28 of file RootDatabaseCnv.h.

Constructor & Destructor Documentation

RootDatabaseCnv::RootDatabaseCnv	(	long	typ,
		const CLID &	cl,
		ISvcLocator *	svc,
		RootCnvSvc *	mgr
	)

Initializing Constructor.

Parameters

typ	[IN] Concrete storage type of the converter
svc	[IN] Pointer to service locator object
mgr	[IN] Pointer to hosting conversion service

Returns

Reference to RootDatabaseCnv object

Definition at line 25 of file RootDatabaseCnv.cpp.

: RootDirectoryCnv(typ, cl, svc, mgr)
{
}

Gaudi::RootDatabaseCnv::~RootDatabaseCnv ( )

overridedefault

Standard destructor.

Gaudi::RootDatabaseCnv::RootDatabaseCnv	(	long	typ,
		const CLID &	,
		ISvcLocator *	svc,
		RootCnvSvc *	mgr
	)

Initializing Constructor.

Parameters

typ	[IN] Concrete storage type of the converter
svc	[IN] Pointer to service locator object
mgr	[IN] Pointer to hosting conversion service

Returns

Reference to RootDatabaseCnv object

Gaudi::RootDatabaseCnv::~RootDatabaseCnv ( )

overridedefault

Standard destructor.

Member Function Documentation

const std::string Gaudi::RootDatabaseCnv::containerName ( IRegistry *  ) const

inlineoverridevirtual

Retrieve the name of the container a given object is placed into.

Parameters

pReg	[IN] Pointer to registry entry.

Returns

Name of the container the object should be put to.

Reimplemented from Gaudi::RootStatCnv.

Definition at line 48 of file RootDatabaseCnv.h.

                                                                 {
      return "<local>";
    }

const std::string Gaudi::RootDatabaseCnv::containerName ( IRegistry *  ) const

inlineoverridevirtual

Retrieve the name of the container a given object is placed into.

Parameters

pReg	[IN] Pointer to registry entry.

Returns

Name of the container the object should be put to.

Reimplemented from Gaudi::RootStatCnv.

Definition at line 48 of file RootDatabaseCnv.h.

                                                                 {
      return "<local>";
    }

StatusCode Gaudi::RootDatabaseCnv::createObj ( IOpaqueAddress *  pAddr, DataObject *&  refpObj  )

overridevirtual

Converter overrides: Create transient object from persistent data.

Parameters

refpAddress	[IN] Pointer to object address.
refpObject	[OUT] Location to pointer to store data object

Returns

Status code indicating success or failure.

Reimplemented from Gaudi::RootDirectoryCnv.

StatusCode RootDatabaseCnv::createObj ( IOpaqueAddress *  pAddr, DataObject *&  refpObj  )

overridevirtual

Converter overrides: Create transient object from persistent data.

Parameters

refpAddress	[IN] Pointer to object address.
refpObject	[OUT] Location to pointer to store data object

Returns

Status code indicating success or failure.

Reimplemented from Gaudi::RootDirectoryCnv.

Definition at line 32 of file RootDatabaseCnv.cpp.

                                                                       {
  StatusCode status = StatusCode::FAILURE;
  if ( pAddr ) {
    RootDataConnection* con = nullptr;
    IRegistry* pReg = pAddr->registry();
    const unsigned long* ipars = pAddr->ipar();
    const string*   spars = pAddr->par();
    char mode = char(ipars[1]);
    string fname   = spars[0];
    string oname   = pReg->name();
    bool recrea = mode == 'R';
    bool create = mode == 'N';
    bool update = mode == 'U';
    bool read   = mode == 'O';
    const CLID& clid = objType();
    status = StatusCode::SUCCESS;
    string cntName = containerName(pReg);
    if ( create ) {
      m_dbMgr->connectDatabase(fname,IDataConnection::CREATE,&con).ignore();
      status = saveDescription(fname, cntName, "File containing statistics results.","", clid);
      if ( status.isSuccess() )  {
        log() << MSG::INFO << "Opened NEW Database file:"
          << fname << " as " << oname << endmsg;
      }
    }
    else if ( update )  {
      m_dbMgr->connectDatabase(fname,IDataConnection::UPDATE,&con).ignore();
      status = saveDescription(fname, cntName, "File containing statistics results.","", clid);
      if ( status.isSuccess() )  {
        log() << MSG::INFO << "Connect to existing Database file:"
          << fname << " as " << oname << " for UPDATE" << endmsg;
      }
    }
    else if ( read ) {
      status = m_dbMgr->connectDatabase(fname,IDataConnection::READ,&con);
      if ( status.isSuccess() )  {
        log() << MSG::INFO << "Connect to existing Database file:"
          << fname << " as " << oname << " for READ" << endmsg;
      }
    }
    else if ( recrea )  {
      m_dbMgr->connectDatabase(fname,IDataConnection::RECREATE,&con).ignore();
      status = saveDescription(fname, cntName, "File containing statistics results.","", clid);
      if ( status.isSuccess() )  {
        log() << MSG::INFO << "Recreate Database file:" << fname << " as " << oname << endmsg;
      }
    }
    else  {
      log() << MSG::ERROR << "Don't know what to do:" << fname << endmsg;
      status = StatusCode::FAILURE;
    }
    // Now create object
    if ( status.isSuccess() )  {
      NTuple::File* pFile = new NTuple::File(objType(), fname, oname);
      pFile->setOpen(false);
      refpObj = pFile;
    }
  }
  return status;
}

---

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

• InstallArea/x86_64-slc6-gcc48-opt/include/RootCnv/RootDatabaseCnv.h
• RootCnv/src/RootDatabaseCnv.cpp