Gaudi::RootStatCnv Class Reference

Description: Base class converter for N-tuples and related classes. More...

#include <Root/RootStatCnv.h>

Inheritance diagram for Gaudi::RootStatCnv:

Collaboration diagram for Gaudi::RootStatCnv:

Public Member Functions
	RootStatCnv (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
virtual	~RootStatCnv ()
	Standard Destructor. More...
	RootStatCnv (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
virtual	~RootStatCnv ()
	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...
virtual StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&refpObj)
	Converter overrides: Create transient object from persistent data. More...
virtual StatusCode	fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Resolve the references of the created 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)
	Resolve the references of the created transient object. 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...
virtual StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&refpObj)
	Converter overrides: Create transient object from persistent data. More...
virtual StatusCode	fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Resolve the references of the created 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)
	Resolve the references of the created transient object. More...
Public Member Functions inherited from Converter
virtual StatusCode	setDataProvider (IDataProviderSvc *svc)
	Set Data provider service. More...
virtual SmartIF< IDataProviderSvc > &	dataProvider () const
	Get Data provider service. More...
virtual StatusCode	setConversionSvc (IConversionSvc *svc)
	Set conversion service the converter is connected to. More...
virtual SmartIF< IConversionSvc > &	conversionSvc () const
	Get conversion service the converter is connected to. More...
virtual StatusCode	setAddressCreator (IAddressCreator *creator)
	Set address creator facility. More...
virtual SmartIF< IAddressCreator > &	addressCreator () const
	Retrieve address creator facility. More...
virtual const CLID &	objType () const
	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...
virtual StatusCode	updateObj (IOpaqueAddress *pAddress, DataObject *refpObject)
	Update the transient object from the other representation. More...
virtual StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Update the references of an updated transient object. More...
virtual StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject)
	Update the converted representation of a transient object. More...
virtual StatusCode	updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	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...
virtual StatusCode	setDataProvider (IDataProviderSvc *svc)
	Set Data provider service. More...
virtual SmartIF< IDataProviderSvc > &	dataProvider () const
	Get Data provider service. More...
virtual StatusCode	setConversionSvc (IConversionSvc *svc)
	Set conversion service the converter is connected to. More...
virtual SmartIF< IConversionSvc > &	conversionSvc () const
	Get conversion service the converter is connected to. More...
virtual StatusCode	setAddressCreator (IAddressCreator *creator)
	Set address creator facility. More...
virtual SmartIF< IAddressCreator > &	addressCreator () const
	Retrieve address creator facility. More...
virtual const CLID &	objType () const
	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...
virtual StatusCode	updateObj (IOpaqueAddress *pAddress, DataObject *refpObject)
	Update the transient object from the other representation. More...
virtual StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Update the references of an updated transient object. More...
virtual StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject)
	Update the converted representation of a transient object. More...
virtual StatusCode	updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	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 extend_interfaces1< IConverter >
virtual	~extend_interfaces1 ()
	Virtual destructor. More...
virtual	~extend_interfaces1 ()
	Virtual destructor. More...
Public Member Functions inherited from IConverter
	DeclareInterfaceID (IConverter, 3, 0)
	InterfaceID. More...
virtual	~IConverter ()
	Virtual destructor. More...
	DeclareInterfaceID (IConverter, 3, 0)
	InterfaceID. More...
virtual	~IConverter ()
	Virtual destructor. More...
Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...
virtual unsigned long	release ()=0
	Release Interface instance. More...
virtual unsigned long	refCount () const =0
	Current reference count. More...
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance. More...
virtual	~IInterface ()
	Virtual destructor. More...
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...
virtual unsigned long	release ()=0
	Release Interface instance. More...
virtual unsigned long	refCount () const =0
	Current reference count. More...
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance. More...
virtual	~IInterface ()
	Virtual destructor. More...

Protected Member Functions
MsgStream &	log () const
	Helper to use mesage logger. More...
virtual StatusCode	initialize ()
	Initialize converter object. More...
virtual StatusCode	finalize ()
	Finalize converter object. More...
virtual const std::string	containerName (IRegistry *pDir) const
	Retrieve the name of the container a given object is placed into. 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...
virtual StatusCode	initialize ()
	Initialize converter object. More...
virtual StatusCode	finalize ()
	Finalize converter object. More...
virtual const std::string	containerName (IRegistry *pDir) const
	Retrieve the name of the container a given object is placed into. 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
virtual	~Converter ()
	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...
virtual	~Converter ()
	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
IDataManagerSvc *	m_dataMgr
	Reference to data manager service to manipulate the TES. More...
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...

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 implements1< IConverter >
typedef implements1	base_class
	Typedef to this class. More...
typedef implements1	base_class
	Typedef to this class. More...
typedef extend_interfaces1< IConverter >	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extend_interfaces1< IConverter >	extend_interfaces_base
	Typedef to the base of this class. More...
typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...
typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...
Public Types inherited from extend_interfaces1< IConverter >
typedef IConverter::iid::iids::type	ext_iids
	MPL set of interfaces extended by this one. More...
typedef IConverter::iid::iids::type	ext_iids
	MPL set of interfaces extended by this one. More...
Public Types inherited from IConverter
enum	Status {   INVALID_ADDRESS = IInterface::LAST_ERROR+1, INVALID_OBJECT, NO_MEMORY, BAD_STORAGE_TYPE,   NO_SOURCE_OBJECT, ICONVERSIONSVC_LAST_ERROR, INVALID_ADDRESS = IInterface::LAST_ERROR+1, INVALID_OBJECT,   NO_MEMORY, BAD_STORAGE_TYPE, NO_SOURCE_OBJECT, ICONVERSIONSVC_LAST_ERROR }
	Status code. More...
enum	Status {   INVALID_ADDRESS = IInterface::LAST_ERROR+1, INVALID_OBJECT, NO_MEMORY, BAD_STORAGE_TYPE,   NO_SOURCE_OBJECT, ICONVERSIONSVC_LAST_ERROR, INVALID_ADDRESS = IInterface::LAST_ERROR+1, INVALID_OBJECT,   NO_MEMORY, BAD_STORAGE_TYPE, NO_SOURCE_OBJECT, ICONVERSIONSVC_LAST_ERROR }
	Status code. More...
Public Types inherited from IInterface
enum	Status {   SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR,   SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
enum	Status {   SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR,   SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...
typedef Gaudi::InterfaceId< IInterface, 0, 0 >	iid
	Interface ID. More...
typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...
typedef Gaudi::InterfaceId< IInterface, 0, 0 >	iid
	Interface ID. More...
typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Detailed Description

Description: Base class converter for N-tuples and related classes.

Author

M.Frank

Version

1.0

Definition at line 31 of file RootStatCnv.h.

Constructor & Destructor Documentation

RootStatCnv::RootStatCnv	(	long	typ,
		const CLID &	clid,
		ISvcLocator *	svc,
		RootCnvSvc *	mgr
	)

Initializing Constructor.

Parameters

typ	[IN] Concrete storage type of the converter
clid	[IN] Class identifier of the object
svc	[IN] Pointer to service locator object

Returns

Reference to RootBaseCnv object

Definition at line 25 of file RootStatCnv.cpp.

: RootConverter(typ, clid, svc, mgr), m_dataMgr(0), m_log(0)
{
}

virtual Gaudi::RootStatCnv::~RootStatCnv ( )

inlinevirtual

Standard Destructor.

Definition at line 106 of file RootStatCnv.h.

{  }

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

Initializing Constructor.

Parameters

typ	[IN] Concrete storage type of the converter
clid	[IN] Class identifier of the object
svc	[IN] Pointer to service locator object

Returns

Reference to RootBaseCnv object

virtual Gaudi::RootStatCnv::~RootStatCnv ( )

inlinevirtual

Standard Destructor.

Definition at line 106 of file RootStatCnv.h.

{  }

Member Function Documentation

const string RootStatCnv::containerName ( IRegistry *  pDir ) const

protectedvirtual

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 in Gaudi::RootDatabaseCnv, and Gaudi::RootDatabaseCnv.

Definition at line 58 of file RootStatCnv.cpp.

                                                             {
  const string& path = pReg->identifier();
  long loc = path.find('/',1);
  string local = "<local>";
  //local = "";
  if ( loc > 0 )  {
    loc = path.find('/',++loc);
    if ( loc > 0 )  {
      local += path.substr(loc,path.length()-loc);
    }
  }
  //for(size_t i=0; i<local.length();++i)
  //  if ( !isalnum(local[i])) local[i] = '_';
  return local;
}

virtual const std::string Gaudi::RootStatCnv::containerName ( IRegistry *  pDir ) const

protectedvirtual

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 in Gaudi::RootDatabaseCnv, and Gaudi::RootDatabaseCnv.

const string RootStatCnv::fileName ( IRegistry *  pReg ) const

protectedvirtual

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

Parameters

pReg	[IN] Pointer to registry entry.

Returns

Name of the file the object should be put to.

Definition at line 75 of file RootStatCnv.cpp.

                                                        {
  string path = topLevel(pReg);
  DataObject* pObj = 0;
  dataProvider()->retrieveObject(path, pObj);
  if ( pObj )  {
    NTuple::File* fptr = dynamic_cast<NTuple::File*>(pObj);
    if ( fptr )  {
      return fptr->name();
    }
  }
  return "";
}

virtual const std::string Gaudi::RootStatCnv::fileName ( IRegistry *  pReg ) const

protectedvirtual

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

Parameters

pReg	[IN] Pointer to registry entry.

Returns

Name of the file the object should be put to.

StatusCode RootStatCnv::finalize ( )

protectedvirtual

Finalize converter object.

Reimplemented from Converter.

Definition at line 45 of file RootStatCnv.cpp.

                                 {
  if ( m_log ) {
    delete m_log;
    m_log = 0;
  }
  if ( m_dataMgr ) {
    m_dataMgr->release();
    m_dataMgr = 0;
  }
  return RootConverter::finalize();
}

virtual StatusCode Gaudi::RootStatCnv::finalize ( )

protectedvirtual

Finalize converter object.

Reimplemented from Converter.

virtual StatusCode Gaudi::RootStatCnv::initialize ( )

protectedvirtual

Initialize converter object.

Reimplemented from Converter.

StatusCode RootStatCnv::initialize ( )

protectedvirtual

Initialize converter object.

Reimplemented from Converter.

Definition at line 31 of file RootStatCnv.cpp.

                                   {
  StatusCode sc = RootConverter::initialize();
  if ( sc.isSuccess() ) {
    sc = dataProvider()->queryInterface(IDataManagerSvc::interfaceID(),(void**)&m_dataMgr);
    if ( !sc.isSuccess() ) {
      return makeError("Failed to access IDataManagerSvc interface.");
    }
  }
  if ( m_log ) delete m_log;
  m_log = new MsgStream(msgSvc(),System::typeinfoName(typeid(*this)));
  return sc;
}

MsgStream& Gaudi::RootStatCnv::log ( ) const

inlineprotected

Helper to use mesage logger.

Definition at line 39 of file RootStatCnv.h.

{ return *m_log; }

MsgStream& Gaudi::RootStatCnv::log ( ) const

inlineprotected

Helper to use mesage logger.

Definition at line 39 of file RootStatCnv.h.

{ return *m_log; }

StatusCode Gaudi::RootStatCnv::makeError ( const std::string &  msg, bool  throw_exception = false  ) const

protected

Helper method to issue error messages.

Parameters

msg	[IN] Text of the error message
throw_exc[IN]	If true throw an exception of type std::runtime_error

Returns

Status code indicating success or failure.

StatusCode RootStatCnv::makeError ( const std::string &  msg, bool  throw_exception = false  ) const

protected

Helper method to issue error messages.

Parameters

msg	[IN] Text of the error message
throw_exc[IN]	If true throw an exception of type std::runtime_error

Returns

Status code indicating success or failure.

Definition at line 105 of file RootStatCnv.cpp.

                                                                             {
  if ( m_log )  {
    log() << MSG::ERROR << msg << endmsg;
  }
  else {
    MsgStream l(msgSvc(),"RootConverter");
    l << MSG::ERROR << msg << endmsg;    
  }
  if ( throw_exc ) {
  }
  return StatusCode::FAILURE;
}

StatusCode RootStatCnv::saveDescription ( const std::string &  path, const std::string &  ident, const std::string &  desc, const std::string &  opt, const CLID &  clid  )

protected

Save statistics object description.

Parameters

path	[IN] Path of file to save the description on.
ident	[IN] Identifier of description to be saved.
desc	[IN] Description
opt	[IN] Optional description
guid	[IN] Object giud of described object
openMode	[IN] Mode of opening the file to save description

Returns

Status code indicating success or failure.

Definition at line 120 of file RootStatCnv.cpp.

{
  RootDataConnection* con = 0;
  StatusCode status = m_dbMgr->connectDatabase(path, IDataConnection::UPDATE, &con);
  if ( status.isSuccess() )  {
    TClass* cl = gROOT->GetClass("Gaudi::RootNTupleDescriptor",kTRUE);
    if ( cl ) {
      RootNTupleDescriptor* ptr;
      auto_ptr<RootNTupleDescriptor> dsc(ptr=new RootNTupleDescriptor());
      TBranch* b = con->getBranch("##Descriptors","GaudiStatisticsDescription",cl,ptr,512,0);
      if ( b ) {
        dsc->description = desc;
        dsc->optional    = opt;
        dsc->container   = ident;
        dsc->clid        = clid;
        b->SetAddress(&ptr);
        int nb = b->Fill();
        if ( nb > 1 ) {
          log() << MSG::DEBUG << "Save description for " << ident << endmsg;
          return StatusCode::SUCCESS;
        }
      }
      return makeError("Failed to access ROOT branch GaudiStatisticsDescription");
    }
    return makeError("Failed to access TClass RootNTupleDescriptor");
  }
  return makeError("Failed to access Tuple file:"+path);
}

StatusCode Gaudi::RootStatCnv::saveDescription ( const std::string &  path, const std::string &  ident, const std::string &  desc, const std::string &  opt, const CLID &  clid  )

protected

Save statistics object description.

Parameters

path	[IN] Path of file to save the description on.
ident	[IN] Identifier of description to be saved.
desc	[IN] Description
opt	[IN] Optional description
guid	[IN] Object giud of described object
openMode	[IN] Mode of opening the file to save description

Returns

Status code indicating success or failure.

virtual const std::string Gaudi::RootStatCnv::topLevel ( IRegistry *  pReg ) const

protectedvirtual

Retrieve the full path of the file a given object is placed into.

Parameters

pReg	[IN] Pointer to registry entry.

Returns

Name of the file the object should be put to.

const string RootStatCnv::topLevel ( IRegistry *  pReg ) const

protectedvirtual

Retrieve the full path of the file a given object is placed into.

Parameters

pReg	[IN] Pointer to registry entry.

Returns

Name of the file the object should be put to.

Definition at line 89 of file RootStatCnv.cpp.

                                                          {
  if ( pReg )    {
    string path = pReg->identifier();
    size_t idx = path.find('/', 1);
    if ( idx != string::npos )  {
      idx = path.find('/', idx+1);
      if ( idx != string::npos )  {
        path = path.substr(0, idx);
      }
      return path;
    }
  }
  return "";
}

Member Data Documentation

IDataManagerSvc * Gaudi::RootStatCnv::m_dataMgr

protected

Reference to data manager service to manipulate the TES.

Definition at line 34 of file RootStatCnv.h.

MsgStream * Gaudi::RootStatCnv::m_log

protected

Reference to logger object.

Definition at line 36 of file RootStatCnv.h.

---

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

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