RootHistCnv::RNTupleCnv Class Reference

NTuple converter class definition. More...

#include <src/RNTupleCnv.h>

Inheritance diagram for RootHistCnv::RNTupleCnv:

Collaboration diagram for RootHistCnv::RNTupleCnv:

Public Member Functions
virtual StatusCode	initialize ()
	Initialize the converter. More...
virtual StatusCode	finalize ()
	Finalize the converter. More...
virtual StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&refpObj)
	Create the transient representation of an object. More...
virtual StatusCode	updateObj (IOpaqueAddress *pAddr, DataObject *refpObj)
	Update the transient object from the other representation. More...
virtual StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&refpAddr)
	Convert the transient object to the requested representation. More...
virtual StatusCode	updateRep (IOpaqueAddress *pAddr, DataObject *pObj)
	Update the converted representation of a transient object. More...
Public Member Functions inherited from RootHistCnv::RConverter
long	repSvcType () const
	Retrieve the class type of the data store the converter uses. More...
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
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	fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Resolve the references of the created transient object. More...
virtual StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Update the references of an updated transient object. More...
virtual StatusCode	fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Resolve the references of the converted 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	fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Resolve the references of the created transient object. More...
virtual StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Update the references of an updated transient object. More...
virtual StatusCode	fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Resolve the references of the converted 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
	RNTupleCnv (ISvcLocator *svc, const CLID &clid)
	Standard constructor. More...
virtual	~RNTupleCnv ()
	Standard destructor. More...
virtual StatusCode	load (TTree *tree, INTuple *&refpObj)=0
	Create the transient representation of an object. More...
virtual StatusCode	book (const std::string &desc, INTuple *pObj, TTree *&tree)=0
	Book a new N tuple. More...
virtual StatusCode	writeData (TTree *rtree, INTuple *pObj)=0
	Write N tuple data. More...
virtual StatusCode	readData (TTree *rtree, INTuple *pObj, long ievt)=0
	Read N tuple data. More...
virtual std::string	rootVarType (int)
	Return ROOT type info: More...
Protected Member Functions inherited from RootHistCnv::RConverter
	RConverter (const CLID &clid, ISvcLocator *svc)
	Standard constructor. More...
virtual	~RConverter ()
	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
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
SmartIF< INTupleSvc >	m_ntupleSvc
	Reference to N tuple 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 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 RootHistCnv::RConverter
static long	storageType ()
	Inquire storage type. 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

NTuple converter class definition.

Package : RootHistCnv Author : Charles Leggett

Definition at line 24 of file RNTupleCnv.h.

Constructor & Destructor Documentation

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

protected

Standard constructor.

Definition at line 35 of file RNTupleCnv.cpp.

  : RConverter(clid, svc) {
}

RootHistCnv::RNTupleCnv::~RNTupleCnv ( )

protectedvirtual

Standard destructor.

Definition at line 43 of file RNTupleCnv.cpp.

                                               {
}

Member Function Documentation

virtual StatusCode RootHistCnv::RNTupleCnv::book ( const std::string &  desc, INTuple *  pObj, TTree *&  tree  )

protectedpure virtual

Book a new N tuple.

Implemented in RootHistCnv::RCWNTupleCnv, and RootHistCnv::RRWNTupleCnv.

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

virtual

Create the transient representation of an object.

Reimplemented from Converter.

Definition at line 100 of file RNTupleCnv.cpp.

{
  MsgStream log (msgSvc(), "RNTupleCnv");

  IRegistry* pReg = pAddress->registry();

  //    log << MSG::WARNING << "adr: " << pAddress->par()[0] << " <> "
  //        << pAddress->par()[1] << " <> " << pAddress->ipar()[0] << " <> "
  //        << pAddress->ipar()[1] << " <> " << hex << rAddr->tObj()
  //        << dec << " <> " << pReg->identifier() << endmsg;

  std::string ident = pReg->identifier();

  StatusCode status = readObject(pAddress, refpObject);  // Doesn't do anything
  if ( status.isSuccess() )   {
    RootObjAddress *rAddr = dynamic_cast<RootObjAddress*>( pAddress );
    if (rAddr == 0) {
      log << MSG::ERROR << "Could not cast to RootObjAddress" << endmsg;
      return StatusCode::FAILURE;
    }
    INTuple* nt = 0;
    TTree* tobj = (TTree*) rAddr->tObj();
    status = load(tobj, nt);
    if (status.isSuccess()) {
      refpObject = dynamic_cast<DataObject*>(nt);
    } else {
      log << MSG::ERROR << "Problems loading ntuple id: " << pReg->identifier()
          << endmsg;
    }
  }
  return status;
}

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

virtual

Convert the transient object to the requested representation.

Reimplemented from RootHistCnv::RConverter.

Definition at line 137 of file RNTupleCnv.cpp.

{
  GlobalDirectoryRestore restore;
  pAddr = 0;
  try   {
    IRegistry* pReg = pObject->registry();
    if ( 0 != pReg )    {
      pAddr = pReg->address();
      if ( 0 == pAddr )   {
        SmartIF<IDataManagerSvc> dataMgr(dataProvider());
        if ( dataMgr.isValid() )    {
          IRegistry* pParentReg = 0;
          StatusCode status = dataMgr->objectParent(pReg, pParentReg);
          if ( status.isSuccess() )  {
            IOpaqueAddress* pParAddr = pParentReg->address();
            if ( pParAddr )   {
              TDirectory* pParentDir = (TDirectory*)pParAddr->ipar()[0];
              if ( pParentDir )   {
                TTree* pTree = 0;
                std::string dsc = pReg->name().substr(1);
                gDirectory = pParentDir;
                status = book(dsc, dynamic_cast<INTuple*>(pObject), pTree);
                if ( !status.isSuccess() )   {
                  return status;
                }
                status = createAddress(pObject, gDirectory, pTree, pAddr);
                if ( !status.isSuccess() )   {
                  return status;
                }
                return writeData(pTree, dynamic_cast<INTuple*>(pObject));
              }
            }
          }
        }
      }
      else  {
        TDirectory* pDir  = (TDirectory*)pAddr->ipar()[0];
        RootObjAddress *rAddr = dynamic_cast<RootObjAddress*>( pAddr );
        if (rAddr == 0) {
          MsgStream log (msgSvc(), "RNTupleCnv");
          log << MSG::ERROR << "Could not cast to RootObjAddress" << endmsg;
          return StatusCode::FAILURE;
        }
        TTree*      pTree = (TTree*) rAddr->tObj();
        gDirectory = pDir;
        return writeData(pTree, dynamic_cast<INTuple*>(pObject));
      }
    }
  }
  catch (...)   {
  }
  MsgStream log (msgSvc(), "RNTupleCnv");
  log << MSG::ERROR << "Failed to create persistent N-tuple!" << endmsg;
  return StatusCode::FAILURE;
}

StatusCode RootHistCnv::RNTupleCnv::finalize ( )

virtual

Finalize the converter.

Fix-Me:

: the release at this point may brake (?)

Reimplemented from Converter.

Definition at line 62 of file RNTupleCnv.cpp.

                                               {
  //-----------------------------------------------------------------------------
  m_ntupleSvc = 0; // release
  return Converter::finalize();
}

StatusCode RootHistCnv::RNTupleCnv::initialize ( )

virtual

Initialize the converter.

Reimplemented from Converter.

Definition at line 49 of file RNTupleCnv.cpp.

                                               {
  //-----------------------------------------------------------------------------
  StatusCode status = Converter::initialize();
  if ( status.isSuccess() ) {
    m_ntupleSvc = serviceLocator()->service("NTupleSvc");
    if (!m_ntupleSvc.isValid()) status = StatusCode::FAILURE;
  }
  return status;
}

virtual StatusCode RootHistCnv::RNTupleCnv::load ( TTree *  tree, INTuple *&  refpObj  )

protectedpure virtual

Create the transient representation of an object.

Implemented in RootHistCnv::RCWNTupleCnv, and RootHistCnv::RRWNTupleCnv.

virtual StatusCode RootHistCnv::RNTupleCnv::readData ( TTree *  rtree, INTuple *  pObj, long  ievt  )

protectedpure virtual

Read N tuple data.

Implemented in RootHistCnv::RCWNTupleCnv, and RootHistCnv::RRWNTupleCnv.

std::string RootHistCnv::RNTupleCnv::rootVarType ( int  type )

protectedvirtual

Return ROOT type info:

Definition at line 229 of file RNTupleCnv.cpp.

                                                     {
  //-----------------------------------------------------------------------------
  switch( type ) {
  case DataTypeInfo::BOOL:      return "/O";           // bool
  case DataTypeInfo::SHORT:     return "/S";           // short
  case DataTypeInfo::INT:       return "/I";           // int
  case DataTypeInfo::LONG:      return "/I";           // long
  case DataTypeInfo::LONGLONG:  return "/L";           // longlong
  case DataTypeInfo::USHORT:    return "/s";           // ushort
  case DataTypeInfo::UINT:      return "/i";           // uint
  case DataTypeInfo::ULONG:     return "/i";           // ulong
  case DataTypeInfo::ULONGLONG: return "/l";           // ulonglong
  case DataTypeInfo::FLOAT:     return "/F";           // float
  case DataTypeInfo::DOUBLE:    return "/D";           // double
  case DataTypeInfo::CHAR:      return "/B";           // char
  case DataTypeInfo::UCHAR:     return "/b";           // char
  default:                      return "";
  }
  // cannot reach this point
}

StatusCode RootHistCnv::RNTupleCnv::updateObj ( IOpaqueAddress *  pAddr, DataObject *  refpObj  )

virtual

Update the transient object from the other representation.

Reimplemented from Converter.

Definition at line 71 of file RNTupleCnv.cpp.

{
  MsgStream log (msgSvc(), "RNTupleCnv");

  StatusCode status = StatusCode::FAILURE;

  RootObjAddress *rAddr = dynamic_cast<RootObjAddress*>(pAddress);

  if (rAddr == 0) {
    log << MSG::ERROR << "Could not dynamic cast to RootObjAddress" << endmsg;
    return StatusCode::FAILURE;
  }

  TTree* rtree = (TTree*) rAddr->tObj();

  try   {
    unsigned long* info = (unsigned long*)pAddress->ipar();
    setDirectory(pAddress->par()[0]);
    status = readData(rtree, dynamic_cast<INTuple*>(pObject), info[1]++);
  }
  catch (...)   {
  }
  return status;
}

StatusCode RootHistCnv::RNTupleCnv::updateRep ( IOpaqueAddress *  pAddr, DataObject *  pObj  )

virtual

Update the converted representation of a transient object.

Reimplemented from Converter.

Definition at line 197 of file RNTupleCnv.cpp.

{
  MsgStream log (msgSvc(), "RNTupleCnv");
  if ( 0 != pAddr )    {
    GlobalDirectoryRestore restore;
    TDirectory* pDir = (TDirectory*)pAddr->ipar()[0];
    RootObjAddress *rAddr = dynamic_cast<RootObjAddress*>( pAddr );
    if (rAddr == 0) {
      log << MSG::ERROR << "Could not cast to RootObjAddress" << endmsg;
      return StatusCode::FAILURE;
    }
    TTree* pTree     = (TTree*) rAddr->tObj();
    if ( 0 != pDir && 0 != pTree )  {
      gDirectory->cd(pDir->GetPath());
      pTree->Write("",TObject::kOverwrite);
      return StatusCode::SUCCESS;
    }
  }
  else {
    log << MSG::WARNING << "empty ntuple: " << pObj->registry()->identifier()
        << endmsg;
    return ( createRep(pObj,pAddr) );
  }
  return StatusCode::FAILURE;
}

virtual StatusCode RootHistCnv::RNTupleCnv::writeData ( TTree *  rtree, INTuple *  pObj  )

protectedpure virtual

Write N tuple data.

Implemented in RootHistCnv::RCWNTupleCnv, and RootHistCnv::RRWNTupleCnv.

Member Data Documentation

SmartIF<INTupleSvc> RootHistCnv::RNTupleCnv::m_ntupleSvc

protected

Reference to N tuple service.

Definition at line 58 of file RNTupleCnv.h.

---

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

• RootHistCnv/src/RNTupleCnv.h
• RootHistCnv/src/RNTupleCnv.cpp