Gaudi Framework, version v20r2
	Generated: 18 Jul 2008

NTupleSvc Class Reference

#include <NTupleSvc.h>

Inheritance diagram for NTupleSvc:

[legend]Collaboration diagram for NTupleSvc:

[legend]List of all members.

---

Detailed Description

NTuple service.

See the Interface definition files for more detailed documentation of the implementing class. Base class: Gaudi/DataSvc/DataSvc.h Generic N tuple service interface: Gaudi/Interfaces/INTupleSvc.h Generic IAddressCreator interface: Gaudi/Interfaces/IAddressCreator.h Generic IConversionSvc interface: Gaudi/Interfaces/IConversionSvc.h

Author:

M.Frank

Definition at line 27 of file NTupleSvc.h.

Public Member Functions
virtual StatusCode	initialize ()
	DataSvc overrides: Initialize the service.
virtual StatusCode	reinitialize ()
	DataSvc overrides: reinitialize service.
virtual StatusCode	finalize ()
	DataSvc overrides: stop the service.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)
	DataSvc overrides: Query interface.
virtual IConversionSvc *	getDataLoader (IRegistry *pReg)
	DataSvc overrides: Retrieve data loader.
virtual NTuple::Directory *	createDirectory (DataObject *pParent, const std::string &title)
	Create Ntuple directory and register it with the data store.
virtual NTuple::Directory *	createDirectory (DataObject *pParent, long id)
	Create Ntuple directory and register it with the data store.
virtual NTuple::Directory *	createDirectory (const std::string &dirPath, long id)
	Create Ntuple directory and register it with the data store.
virtual NTuple::Directory *	createDirectory (const std::string &dirPath, const std::string &title)
	Create Ntuple directory and register it with the data store.
virtual NTuple::Directory *	createDirectory (const std::string &fullPath)
	Create Ntuple directory and register it with the data store.
virtual StatusCode	create (const CLID &typ, const std::string &title, NTuple::Tuple *&refpTuple)
	Create requested N tuple (Hide constructor).
virtual NTuple::Tuple *	book (const std::string &fullPath, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store.
virtual NTuple::Tuple *	book (const std::string &dirPath, const std::string &relPath, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store.
virtual NTuple::Tuple *	book (const std::string &dirPath, long id, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store.
virtual NTuple::Tuple *	book (DataObject *pParent, const std::string &relPath, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store.
virtual NTuple::Tuple *	book (DataObject *pParent, long id, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store.
virtual NTuple::Tuple *	access (const std::string &fullPath, const std::string &filename)
	Access N tuple on disk.
virtual StatusCode	save (const std::string &fullPath)
	Save N tuple to disk. Must be called in order to close the ntuple file properly.
virtual StatusCode	save (NTuple::Tuple *tuple)
	Save N tuple to disk. Must be called in order to close the ntuple file properly.
virtual StatusCode	save (DataObject *pParent, const std::string &relPath)
	Save N tuple to disk. Must be called in order to close the ntuple file properly.
virtual StatusCode	writeRecord (NTuple::Tuple *tuple)
	Write single record to N tuple.
virtual StatusCode	writeRecord (const std::string &fullPath)
	Write single record to N tuple.
virtual StatusCode	writeRecord (DataObject *pParent, const std::string &relPath)
	Write single record to N tuple.
virtual StatusCode	readRecord (NTuple::Tuple *tuple)
	Read single record from N tuple.
virtual StatusCode	readRecord (const std::string &fullPath)
	Read single record from N tuple.
virtual StatusCode	readRecord (DataObject *pParent, const std::string &relPath)
	Read single record from N tuple.
virtual bool	isConnected (const std::string &identifier) const
	Check if a datasource is connected.
virtual StatusCode	connect (const std::string &ident)
	Add file to list I/O list.
virtual StatusCode	connect (const std::string &ident, std::string &logname)
	Add file to list I/O list.
virtual StatusCode	disconnect (const std::string &nam)
	Close open connection.
virtual StatusCode	disconnectAll ()
	Close all open connections.
	NTupleSvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor.
virtual	~NTupleSvc ()
	Standard Destructor.
Protected Types
typedef std::vector< std::string >	DBaseEntries
typedef std::map< std::string, Connection >	Connections
typedef std::pair< std::string, std::string >	Prop
Protected Member Functions
StatusCode	createService (const std::string &nam, const std::string &typ, const std::vector< Prop > &props, IConversionSvc *&pSvc)
	Create conversion service.
void	releaseConnection (Connection &c)
	Finalize single service.
StatusCode	attachTuple (const std::string &filename, const std::string &logname, const char typ, const long t)
	Attach output/input file.
StatusCode	updateDirectories ()
	Update directory data.
Protected Attributes
DBaseEntries	m_output
	Output streams.
DBaseEntries	m_input
	Input streams.
Connections	m_connections
	Container of connection points.
Friends
class	SvcFactory< NTupleSvc >
Classes
struct	Connection

---

Member Typedef Documentation

typedef std::vector< std::string > NTupleSvc::DBaseEntries [protected]

Definition at line 39 of file NTupleSvc.h.

typedef std::map<std::string, Connection> NTupleSvc::Connections [protected]

Definition at line 40 of file NTupleSvc.h.

typedef std::pair<std::string,std::string> NTupleSvc::Prop [protected]

Definition at line 41 of file NTupleSvc.h.

---

Constructor & Destructor Documentation

NTupleSvc::NTupleSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Standard Constructor.

Definition at line 54 of file NTupleSvc.cpp.

References CLID_DataObject.

 : DataSvc(name, svc)
{
  declareProperty("Input",  m_input);
  declareProperty("Output", m_output);
  m_rootName = "/NTUPLES";
  m_rootCLID = CLID_DataObject;
}

NTupleSvc::~NTupleSvc

(

)

[virtual]

Standard Destructor.

Definition at line 64 of file NTupleSvc.cpp.

                        {
}

---

Member Function Documentation

StatusCode NTupleSvc::initialize

(

)

[virtual]

DataSvc overrides: Initialize the service.

Reimplemented from DataSvc.

Reimplemented in TagCollectionSvc.

Definition at line 68 of file NTupleSvc.cpp.

References std::vector< _Tp, _Alloc >::begin(), connect(), std::vector< _Tp, _Alloc >::end(), DataSvc::initialize(), StatusCode::isSuccess(), m_input, m_output, DataSvc::m_rootName, Service::setProperties(), DataSvc::setRoot(), and StatusCode::SUCCESS.

Referenced by TagCollectionSvc::initialize().

                                     {
  StatusCode status = DataSvc::initialize();
  if ( status.isSuccess() )   {
    status = setProperties();
    if ( status.isSuccess() )   {
      StatusCode iret(StatusCode::SUCCESS,true);
      DataObject* root = new NTuple::Directory();
      status = setRoot(m_rootName, root);
      for ( DBaseEntries::iterator i = m_output.begin(); i != m_output.end(); ++i )    {
        iret = connect(*i);
        if ( !iret.isSuccess() )    {
          status = iret;
        }
      }
      for ( DBaseEntries::iterator j = m_input.begin(); j != m_input.end(); ++j )    {
        iret = connect(*j);
        if ( !iret.isSuccess() )    {
          status = iret;
        }
      }
    }
  }
  return status;
}

StatusCode NTupleSvc::reinitialize

(

)

[virtual]

DataSvc overrides: reinitialize service.

Reimplemented from DataSvc.

Definition at line 94 of file NTupleSvc.cpp.

References StatusCode::SUCCESS.

                                   {
  return StatusCode::SUCCESS;
}

StatusCode NTupleSvc::finalize

(

)

[virtual]

DataSvc overrides: stop the service.

Reimplemented from DataSvc.

Reimplemented in TagCollectionSvc.

Definition at line 209 of file NTupleSvc.cpp.

References DataSvc::clearStore(), disconnectAll(), DataSvc::finalize(), and updateDirectories().

Referenced by TagCollectionSvc::finalize().

                                    {
  StatusCode status = updateDirectories();
  status = clearStore();
  status = DataSvc::finalize();
  status = disconnectAll();
  return status;
}

StatusCode NTupleSvc::queryInterface	(	const InterfaceID &	riid,
		void **	ppvInterface
	)			[virtual]

DataSvc overrides: Query interface.

Reimplemented from DataSvc.

Definition at line 218 of file NTupleSvc.cpp.

References IInterface::addRef(), IID_IDataSourceMgr, IID_INTupleSvc, DataSvc::queryInterface(), and StatusCode::SUCCESS.

                                                                                  {
  if ( IID_INTupleSvc == riid )
    *ppvInterface = (INTupleSvc*)this;
  else if ( IID_IDataSourceMgr == riid )
    *ppvInterface = (IDataSourceMgr*)this;
  else  // Interface is not directly availible: try out a base class
    return DataSvc::queryInterface(riid, ppvInterface);
  addRef();
  return StatusCode::SUCCESS;
}

IConversionSvc * NTupleSvc::getDataLoader

(

IRegistry *

pReg

)

[virtual]

DataSvc overrides: Retrieve data loader.

Reimplemented from DataSvc.

Definition at line 105 of file NTupleSvc.cpp.

References std::basic_string< _CharT, _Traits, _Alloc >::find(), IRegistry::identifier(), std::basic_string< _CharT, _Traits, _Alloc >::length(), m_connections, DataSvc::m_rootName, std::basic_string< _CharT, _Traits, _Alloc >::npos, Gaudi::Utils::Histos::path(), IDataProviderSvc::SEPARATOR, and std::basic_string< _CharT, _Traits, _Alloc >::substr().

Referenced by createDirectory(), readRecord(), updateDirectories(), and writeRecord().

                                                                {
  if ( 0 != pRegistry )    {
    std::string full = pRegistry->identifier();
    size_t len = m_rootName.length();
    size_t idx = full.find(SEPARATOR,len+1);
    std::string path = (idx==std::string::npos) ? full : full.substr(0, idx);
    Connections::iterator i = m_connections.find(path);
    if ( i != m_connections.end() )   {
      return (*i).second.service;
    }
  }
  return 0;
}

NTuple::Directory * NTupleSvc::createDirectory	(	DataObject *	pParent,
		const std::string &	title
	)			[virtual]

Create Ntuple directory and register it with the data store.

Implements INTupleSvc.

Definition at line 468 of file NTupleSvc.cpp.

References IRegistry::identifier(), and DataObject::registry().

Referenced by book(), and createDirectory().

                                                                           {
  if ( 0 != pParent )   {
    IRegistry* pDir = pParent->registry();
    if ( 0 != pDir )    {
      std::string full = pDir->identifier();
      full += (relPath[0]=='/') ? "" : "/";
      full += relPath;
      return createDirectory(full);
    }
  }
  return 0;
}

NTuple::Directory * NTupleSvc::createDirectory	(	DataObject *	pParent,
		long	id
	)			[virtual]

Create Ntuple directory and register it with the data store.

Implements INTupleSvc.

Definition at line 483 of file NTupleSvc.cpp.

References _itoa(), and createDirectory().

                                                                            {
  char txt[32];
  return createDirectory( pParent, ::_itoa(id, txt,10) );
}

NTuple::Directory * NTupleSvc::createDirectory	(	const std::string &	dirPath,
		long	id
	)			[virtual]

Create Ntuple directory and register it with the data store.

Implements INTupleSvc.

Definition at line 489 of file NTupleSvc.cpp.

References _itoa(), and createDirectory().

                                                                                 {
  char txt[32];
  return createDirectory( dirPath, ::_itoa(id, txt,10) );
}

NTuple::Directory * NTupleSvc::createDirectory	(	const std::string &	dirPath,
		const std::string &	title
	)			[virtual]

Create Ntuple directory and register it with the data store.

Implements INTupleSvc.

Definition at line 495 of file NTupleSvc.cpp.

References createDirectory().

                                                                                                   {
  std::string full = dirPath;
  full += (relPath[0]=='/') ? "" : "/";
  full += relPath;
  return createDirectory(full);
}

NTuple::Directory * NTupleSvc::createDirectory

(

const std::string &

fullPath

)

[virtual]

Create Ntuple directory and register it with the data store.

Implements INTupleSvc.

Definition at line 526 of file NTupleSvc.cpp.

References createDirectory(), DataSvc::findObject(), getDataLoader(), StatusCode::isSuccess(), DataSvc::registerObject(), std::basic_string< _CharT, _Traits, _Alloc >::rfind(), IDataProviderSvc::SEPARATOR, std::basic_string< _CharT, _Traits, _Alloc >::substr(), and DataSvc::unregisterObject().

                                                                        {
  NTuple::Directory* p = 0;
  StatusCode status = findObject(fullPath, *pp_cast<DataObject>(&p));
  if ( !status.isSuccess() )   {
    int sep2 = fullPath.rfind(SEPARATOR);
    if ( sep2 > 0 )   {
      std::string relPath = fullPath.substr(0, sep2);
      p = createDirectory(relPath);
      if ( 0 != p )    {
        p = new NTuple::Directory();
        // Finally register the created N tuple with the store
        status = registerObject(fullPath, p);
        if ( status.isSuccess() )    {
          // ...starting from the file entries
          IConversionSvc* svc = getDataLoader(p->registry());
          if ( 0 != svc )   {
            IOpaqueAddress* pAddr = 0;
            status = svc->createRep (p, pAddr);
            if ( status.isSuccess() )   {
              p->registry()->setAddress(pAddr);
              status = svc->fillRepRefs (pAddr, p);
              if ( status.isSuccess() )   {
                return p;
              }
            }
          }
          unregisterObject(p);
        }
        p->release();
        p = 0;
      }
    }
  }
  try {
    p = dynamic_cast<NTuple::Directory*>(p);
    return p;
  }
  catch (...) {
  }
  return 0;
}

StatusCode NTupleSvc::create	(	const CLID &	typ,
		const std::string &	title,
		NTuple::Tuple *&	refpTuple
	)			[virtual]

Create requested N tuple (Hide constructor).

Eventually allow loading through factory?

Implements INTupleSvc.

Definition at line 370 of file NTupleSvc.cpp.

References CLID_ColumnWiseTuple, CLID_RowWiseTuple, StatusCode::FAILURE, NTuple::TupleImp::setTupleService(), and StatusCode::SUCCESS.

Referenced by book().

                                                                                                 {
  NTuple::TupleImp* pTuple = 0;
  StatusCode status = StatusCode::FAILURE;
  if ( typ == CLID_ColumnWiseTuple )    {
    pTuple = new NTuple::ColumnWiseTuple( title );
  }
  else if ( typ == CLID_RowWiseTuple )    {
    pTuple = new NTuple::RowWiseTuple( title );
  }
  else    {
  }
  if ( 0 != pTuple )      {
    pTuple->setTupleService(this);
    status = StatusCode::SUCCESS;
  }
  refpTuple = pTuple;
  return status;
}

NTuple::Tuple * NTupleSvc::book	(	const std::string &	fullPath,
		const CLID &	type,
		const std::string &	title
	)			[virtual]

Book Ntuple and register it with the data store.

Implements INTupleSvc.

Definition at line 391 of file NTupleSvc.cpp.

References createDirectory(), endmsg(), MSG::ERROR, StatusCode::isSuccess(), std::basic_string< _CharT, _Traits, _Alloc >::length(), DataSvc::m_rootName, Service::msgSvc(), Service::name(), Gaudi::Utils::Histos::path(), DataSvc::retrieveObject(), std::basic_string< _CharT, _Traits, _Alloc >::rfind(), and IDataProviderSvc::SEPARATOR.

Referenced by book().

                                                                                                  {
  DataObject* pObj = 0;
  std::string path = fullPath;
  MsgStream log(msgSvc(), name());
  if ( path[0] != SEPARATOR )   {
    path = m_rootName;
    path += SEPARATOR;
    path += fullPath;
  }
  StatusCode status = retrieveObject(path, pObj);
  if ( !status.isSuccess() )    {
    int sep = path.rfind(SEPARATOR);
    if ( sep > 0 )    {
      std::string p_path (path, 0, sep);
      std::string o_path (path, sep, path.length());
      DataObject* dir = createDirectory(p_path);
      if ( 0 != dir )   {
        NTuple::Tuple* tup = book( dir, o_path, type, title);
        if ( 0 == tup )   {
          log << MSG::ERROR << "Cannot book N-tuple " << path << " (Unknown reason)" << endmsg;
        }
        return tup;
      }
      log << MSG::ERROR << "Cannot book N-tuple " << path << " (Invalid parent directory)" << endmsg;
      return 0;
    }
    log << MSG::ERROR << "Cannot book N-tuple " << path << " (Invalid path)" << endmsg;
    return 0;
  }
  log << MSG::ERROR << "Cannot book N-tuple " << path << " (Exists already)" << endmsg;
  return 0;
}

NTuple::Tuple * NTupleSvc::book	(	const std::string &	dirPath,
		const std::string &	relPath,
		const CLID &	type,
		const std::string &	title
	)			[virtual]

Book Ntuple and register it with the data store.

Implements INTupleSvc.

Definition at line 425 of file NTupleSvc.cpp.

References book(), and IDataProviderSvc::SEPARATOR.

                                                                                                                           {
  std::string full = dirPath;
  if (relPath[0] != SEPARATOR) full += SEPARATOR;
  full += relPath;
  return book(full, type, title);
}

NTuple::Tuple * NTupleSvc::book	(	const std::string &	dirPath,
		long	id,
		const CLID &	type,
		const std::string &	title
	)			[virtual]

Book Ntuple and register it with the data store.

Implements INTupleSvc.

Definition at line 433 of file NTupleSvc.cpp.

References _itoa(), and book().

                                                                                                          {
  char txt[32];
  return book( dirPath, _itoa(id, txt, 10), type, title);
}

NTuple::Tuple * NTupleSvc::book	(	DataObject *	pParent,
		const std::string &	relPath,
		const CLID &	type,
		const std::string &	title
	)			[virtual]

Book Ntuple and register it with the data store.

Implements INTupleSvc.

Definition at line 439 of file NTupleSvc.cpp.

References create(), DataSvc::findObject(), StatusCode::isSuccess(), and DataSvc::registerObject().

                                                                                                                      {
  NTuple::Tuple* pObj = 0;
  // Check if object is already present
  StatusCode status = findObject(pParent, relPath, *pp_cast<DataObject>(&pObj));
  // No ? Then create it!
  if ( !status.isSuccess() )    {
    status = create( type, title, pObj);
    if ( status.isSuccess() )   {
      // Finally register the created N tuple with the store
      status = registerObject(pParent, relPath, pObj);
      if ( status.isSuccess() )    {
        return pObj;
      }
      pObj->release();
    }
  }
  return 0;
}

NTuple::Tuple * NTupleSvc::book	(	DataObject *	pParent,
		long	id,
		const CLID &	type,
		const std::string &	title
	)			[virtual]

Book Ntuple and register it with the data store.

Implements INTupleSvc.

Definition at line 459 of file NTupleSvc.cpp.

References _itoa(), and book().

                                                         {
  char txt[32];
  return book( pParent, ::_itoa(id, txt,10), type, title);
}

NTuple::Tuple * NTupleSvc::access	(	const std::string &	fullPath,
		const std::string &	filename
	)			[virtual]

Access N tuple on disk.

Implements INTupleSvc.

Definition at line 569 of file NTupleSvc.cpp.

References Service::msgSvc(), and Service::name().

                                                                  {
  MsgStream log ( msgSvc(), name() );
  return 0;
}

StatusCode NTupleSvc::save

(

const std::string &

fullPath

)

[virtual]

Save N tuple to disk. Must be called in order to close the ntuple file properly.

Implements INTupleSvc.

Definition at line 575 of file NTupleSvc.cpp.

References DataSvc::findObject(), IDataProviderSvc::INVALID_OBJ_PATH, StatusCode::isSuccess(), Service::msgSvc(), and Service::name().

Referenced by save().

                                                     {
  MsgStream log ( msgSvc(), name() );
  NTuple::Tuple* pObj = 0;
  StatusCode status = findObject(fullPath, *pp_cast<DataObject>(&pObj));  // Check if object is  present
  if ( status.isSuccess() )   {
    return save ( pObj );
  }
  return INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::save

(

NTuple::Tuple *

tuple

)

[virtual]

Save N tuple to disk. Must be called in order to close the ntuple file properly.

Implements INTupleSvc.

Definition at line 586 of file NTupleSvc.cpp.

References IRegistry::address(), NTuple::TupleImp::conversionService(), IDataProviderSvc::INVALID_OBJECT, StatusCode::isSuccess(), IDataProviderSvc::NO_DATA_LOADER, DataObject::registry(), IConverter::updateRep(), and IConverter::updateRepRefs().

                                                {
  NTuple::TupleImp* tuple = (NTuple::TupleImp*)n_tuple;
  if ( 0 != tuple )   {
    try   {
      IConversionSvc* pSvc = tuple->conversionService();
      IRegistry*      pReg = tuple->registry();
      if ( 0 != pSvc && 0 != pReg )    {
        IOpaqueAddress* pAddr = pReg->address();
        StatusCode status = pSvc->updateRep(pAddr, n_tuple);
        if ( status.isSuccess() )   {
          status = pSvc->updateRepRefs(pAddr, n_tuple);
        }
        return status;
      }
      return IDataProviderSvc::NO_DATA_LOADER;
    }
    catch(...)    {
    }
  }
  return INVALID_OBJECT;
}

StatusCode NTupleSvc::save	(	DataObject *	pParent,
		const std::string &	relPath
	)			[virtual]

Save N tuple to disk. Must be called in order to close the ntuple file properly.

Implements INTupleSvc.

Definition at line 609 of file NTupleSvc.cpp.

References DataSvc::findObject(), IDataProviderSvc::INVALID_OBJ_PATH, StatusCode::isSuccess(), and save().

                                                                         {
  NTuple::Tuple* pObj = 0;
  StatusCode status = findObject(pParent, relPath, *pp_cast<DataObject>(&pObj));  // Check if object is  present
  if ( status.isSuccess() )   {
    return save ( pObj );
  }
  return INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::writeRecord

(

NTuple::Tuple *

tuple

)

[virtual]

Write single record to N tuple.

Implements INTupleSvc.

Definition at line 619 of file NTupleSvc.cpp.

References IRegistry::address(), NTuple::TupleImp::conversionService(), IConverter::createRep(), IConverter::fillRepRefs(), getDataLoader(), IDataProviderSvc::INVALID_OBJECT, StatusCode::isSuccess(), IDataProviderSvc::NO_DATA_LOADER, DataObject::registry(), IRegistry::setAddress(), and NTuple::TupleImp::setConversionService().

Referenced by writeRecord().

                                                          {
  NTuple::TupleImp* tuple = (NTuple::TupleImp*)n_tuple;
  if ( 0 != tuple )   {
    try   {
      IConversionSvc* pSvc = tuple->conversionService();
      if ( 0 == pSvc )    {
        pSvc = getDataLoader(n_tuple->registry());
        tuple->setConversionService(pSvc);
      }
      if ( 0 != pSvc )    {
        IRegistry* pReg = n_tuple->registry();
        IOpaqueAddress* pAddr = pReg->address();
        StatusCode status = pSvc->createRep(n_tuple, pAddr);
        if ( status.isSuccess() )   {
          pReg->setAddress(pAddr);
          status = pSvc->fillRepRefs(pAddr, n_tuple);
        }
        return status;
      }
      return IDataProviderSvc::NO_DATA_LOADER;
    }
    catch(...)    {
    }
  }
  return INVALID_OBJECT;
}

StatusCode NTupleSvc::writeRecord

(

const std::string &

fullPath

)

[virtual]

Write single record to N tuple.

Implements INTupleSvc.

Definition at line 647 of file NTupleSvc.cpp.

References DataSvc::findObject(), IDataProviderSvc::INVALID_OBJ_PATH, StatusCode::isSuccess(), and writeRecord().

                                                              {
  NTuple::Tuple* pObj = 0;
  StatusCode status = findObject(fullPath, *pp_cast<DataObject>(&pObj));  // Check if object is  present
  if ( status.isSuccess() )   {
    return writeRecord ( pObj );
  }
  return INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::writeRecord	(	DataObject *	pParent,
		const std::string &	relPath
	)			[virtual]

Write single record to N tuple.

Implements INTupleSvc.

Definition at line 657 of file NTupleSvc.cpp.

References DataSvc::findObject(), IDataProviderSvc::INVALID_OBJ_PATH, StatusCode::isSuccess(), and writeRecord().

                                                                                  {
  NTuple::Tuple* pObj = 0;
  StatusCode status = findObject(pParent, relPath, *pp_cast<DataObject>(&pObj));  // Check if object is  present
  if ( status.isSuccess() )   {
    return writeRecord ( pObj );
  }
  return INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::readRecord

(

NTuple::Tuple *

tuple

)

[virtual]

Read single record from N tuple.

Implements INTupleSvc.

Definition at line 667 of file NTupleSvc.cpp.

References IRegistry::address(), NTuple::TupleImp::conversionService(), getDataLoader(), IDataProviderSvc::INVALID_OBJECT, StatusCode::isSuccess(), IDataProviderSvc::NO_DATA_LOADER, DataObject::registry(), NTuple::TupleImp::setConversionService(), IConverter::updateObj(), and IConverter::updateObjRefs().

Referenced by readRecord().

                                                        {
  StatusCode status = INVALID_OBJECT;
  NTuple::TupleImp* tuple = (NTuple::TupleImp*)n_tuple;
  if ( 0 != tuple )   {
    try   {
      IConversionSvc* pSvc = tuple->conversionService();
      if ( 0 == pSvc )    {
        pSvc = getDataLoader(n_tuple->registry());
        tuple->setConversionService(pSvc);
      }
      if ( 0 != pSvc )    {
        IRegistry*      pReg  = n_tuple->registry();
        IOpaqueAddress* pAddr = pReg->address();
        status = pSvc->updateObj(pAddr, n_tuple);
        if ( status.isSuccess() )   {
          status = pSvc->updateObjRefs(pAddr, n_tuple);
        }
        return status;
      }
      status = IDataProviderSvc::NO_DATA_LOADER;
    }
    catch(...)    {
      status = INVALID_OBJECT;
    }
  }
  return status;
}

StatusCode NTupleSvc::readRecord

(

const std::string &

fullPath

)

[virtual]

Read single record from N tuple.

Implements INTupleSvc.

Definition at line 696 of file NTupleSvc.cpp.

References DataSvc::findObject(), IDataProviderSvc::INVALID_OBJ_PATH, StatusCode::isSuccess(), and readRecord().

                                                           {
  NTuple::Tuple* pObj = 0;
  StatusCode status = findObject(fullPath, *pp_cast<DataObject>(&pObj));  // Check if object is  present
  if ( status.isSuccess() )   {
    return readRecord ( pObj );
  }
  return INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::readRecord	(	DataObject *	pParent,
		const std::string &	relPath
	)			[virtual]

Read single record from N tuple.

Implements INTupleSvc.

Definition at line 706 of file NTupleSvc.cpp.

References DataSvc::findObject(), IDataProviderSvc::INVALID_OBJ_PATH, StatusCode::isSuccess(), and readRecord().

                                                                               {
  NTuple::Tuple* pObj = 0;
  StatusCode status = findObject(pParent, relPath, *pp_cast<DataObject>(&pObj));  // Check if object is  present
  if ( status.isSuccess() )   {
    return readRecord ( pObj );
  }
  return INVALID_OBJ_PATH;
}

bool NTupleSvc::isConnected

(

const std::string &

identifier

)

const [virtual]

Check if a datasource is connected.

Implements IDataSourceMgr.

Definition at line 99 of file NTupleSvc.cpp.

References m_connections.

                                                                {
  Connections::const_iterator i = m_connections.find(identifier);
  return !(i==m_connections.end());
}

StatusCode NTupleSvc::connect

(

const std::string &

ident

)

[virtual]

Add file to list I/O list.

Implements IDataSourceMgr.

Definition at line 229 of file NTupleSvc.cpp.

Referenced by initialize().

                                                       {
  std::string logName;
  return connect(ident, logName);
}

StatusCode NTupleSvc::connect	(	const std::string &	ident,
		std::string &	logname
	)			[virtual]

Add file to list I/O list.

Implements IDataSourceMgr.

Reimplemented in TagCollectionSvc.

Definition at line 234 of file NTupleSvc.cpp.

References Tokenizer::analyse(), attachTuple(), createService(), endmsg(), MSG::ERROR, StatusCode::FAILURE, std::basic_string< _CharT, _Traits, _Alloc >::find(), DataSvc::findObject(), StatusCode::isSuccess(), Tokenizer::items(), std::basic_string< _CharT, _Traits, _Alloc >::length(), m_connections, DataSvc::m_rootName, Service::msgSvc(), Service::name(), std::vector< _Tp, _Alloc >::push_back(), IConverter::repSvcType(), std::basic_string< _CharT, _Traits, _Alloc >::substr(), StatusCode::SUCCESS, and toupper().

                                                                           {
  MsgStream log ( msgSvc(), name() );
  DataObject* pO = 0;
  StatusCode status = findObject(m_rootName, pO);
  if ( status.isSuccess() )   {
    char typ=0;
    Tokenizer tok(true);
    std::vector<Prop> props;
    long loc = ident.find(" ");
    std::string filename, auth, svc = "", db_typ = "";
    logname = ident.substr(0,loc);
    tok.analyse(ident.substr(loc+1,ident.length()), " ", "", "", "=", "'", "'");
    for ( Tokenizer::Items::iterator i = tok.items().begin(); i != tok.items().end(); ++i)    {
      const std::string& tag = (*i).tag();
      switch( ::toupper(tag[0]) )   {
      case 'A':
        break;
      case 'F':   // FILE='<file name>'
      case 'D':   // DATAFILE='<file name>'
        filename = (*i).value();
        break;
      case 'O':   // OPT='<NEW<CREATE,WRITE>, UPDATE, READ>'
        switch( ::toupper((*i).value()[0]) )   {
        case 'C':
        case 'N':
        case 'W':
          typ = 'N';
          break;
        case 'U':
          typ = 'U';
          break;
        case 'O':
        case 'R':
          typ = 'O';
          break;
        default:
          typ = 0;
          break;
        }
        break;
      case 'T':   // TYP='<HBOOK,ROOT,OBJY,...>'
        db_typ = (*i).value();
        break;
      default:
        props.push_back( Prop((*i).tag(), (*i).value()));
        break;
      }
    }
    if ( 0 != typ )    {
      IConversionSvc* pSvc = 0;
      status = createService(name()+'.'+logname, db_typ, props, pSvc);
      if ( status.isSuccess() )   {
        status = attachTuple(filename, logname, typ, pSvc->repSvcType());
        if ( status.isSuccess() )    {
          m_connections.insert(Connections::value_type(m_rootName+'/'+logname,Connection(pSvc)));
          return StatusCode::SUCCESS;
        }
      }
    }
  }
  log << MSG::ERROR << "Cannot add " << ident << " invalid filename!" << endmsg;
  return StatusCode::FAILURE;
}

StatusCode NTupleSvc::disconnect

(

const std::string &

nam

)

[virtual]

Close open connection.

Implements IDataSourceMgr.

Definition at line 189 of file NTupleSvc.cpp.

References StatusCode::FAILURE, m_connections, releaseConnection(), and StatusCode::SUCCESS.

                                                          {
  Connections::iterator i = m_connections.find(nam);
  if ( i != m_connections.end() )    {
    releaseConnection((*i).second);
    m_connections.erase(i);
    return StatusCode::SUCCESS;
  }
  return StatusCode::FAILURE;
}

StatusCode NTupleSvc::disconnectAll

(

)

[virtual]

Close all open connections.

Implements IDataSourceMgr.

Definition at line 200 of file NTupleSvc.cpp.

References m_connections, releaseConnection(), and StatusCode::SUCCESS.

Referenced by finalize().

                                         {
  for(Connections::iterator i = m_connections.begin(); i != m_connections.end(); ++i) {
    releaseConnection((*i).second);
  }
  m_connections.erase(m_connections.begin(), m_connections.end());
  return StatusCode::SUCCESS;
}

StatusCode NTupleSvc::createService	(	const std::string &	nam,
		const std::string &	typ,
		const std::vector< Prop > &	props,
		IConversionSvc *&	pSvc
	)			[protected]

Create conversion service.

CGL: set the storage type

Reimplemented in TagCollectionSvc.

Definition at line 298 of file NTupleSvc.cpp.

References endmsg(), MSG::ERROR, StatusCode::FAILURE, HBOOK_StorageType, IID_IConversionSvc, IID_IProperty, IID_IService, StatusCode::isSuccess(), std::basic_string< _CharT, _Traits, _Alloc >::length(), Service::msgSvc(), Service::name(), IInterface::queryInterface(), ROOT_StorageType, Service::serviceLocator(), IConverter::setDataProvider(), TEST_StorageType, PropertyWithValue< TYPE >::value(), and MSG::WARNING.

Referenced by connect().

{
  MsgStream log ( msgSvc(), name() );
  // Get the value of the Stat persistancy mechanism from the AppMgr
  IProperty*   appPropMgr = 0;
  StatusCode sts = serviceLocator()->queryInterface(IID_IProperty, pp_cast<void>(&appPropMgr) );
  if( !sts.isSuccess() ) {
   // Report an error and return the FAILURE status code
   log << MSG::ERROR << "Could not get PropMgr" << endmsg;
   return sts;
  }

  StringProperty sp("HistogramPersistency","");
  sts = appPropMgr->getProperty( &sp );
  if ( !sts.isSuccess() ) {
   log << MSG::ERROR << "Could not get NTuple Persistency format"
       << " from ApplicationMgr properties" << endmsg;
   return sts;
  }

  long storage_typ = TEST_StorageType;
  if ( sp.value() == "HBOOK" ) {
    storage_typ = HBOOK_StorageType;
  } 
  else if ( sp.value() == "ROOT" ) {
    storage_typ = ROOT_StorageType;
  } 
  else {
    appPropMgr->release();
    log << MSG::ERROR << "Unknown NTuple Persistency format: " << sp.value() << endmsg;
    return StatusCode::FAILURE;
  }
  // Clean up
  appPropMgr->release();

  if ( typ.length() > 0 && typ != sp.value() )    {
    log << MSG::WARNING << "NTuple persistency type is " 
        << sp.value() << "." << endmsg
        << "Type given by job option "
        << "NTupleSvc.Input/Output ignored!" << endmsg;
  }

  //      log << MSG::DEBUG << "storage type: " << m_storageType << endmsg;
  
  // FIXME: (MCl) why NTupleSvc has to directly create a ConversionSvc?  
  IService* pService = 0;
  IInterface* iface = new ConversionSvc(name()+"Conversions", serviceLocator(), storage_typ);
  StatusCode status = iface->queryInterface(IID_IService, pp_cast<void>(&pService));
  if ( status.isSuccess() )   {
    status = iface->queryInterface(IID_IConversionSvc, pp_cast<void>(&pSvc));
    if ( !status.isSuccess() )   {
      pService->release();
      return status;
    }
  }
  status = pService->sysInitialize();
  if ( !status.isSuccess() )    {
    return status;
  }
  pService->release();
  status = pSvc->setDataProvider(this);
  if ( !status.isSuccess() )    {
    return status;
  }
  return status;
}

void NTupleSvc::releaseConnection

(

Connection &

c

)

[protected]

Finalize single service.

Definition at line 179 of file NTupleSvc.cpp.

References c, IID_IService, and SmartIFBase< TYPE >::isValid().

Referenced by disconnect(), and disconnectAll().

                                                {
  SmartIF<IService> isvc(IID_IService, c.service );
  if ( isvc.isValid( ) )   {
    isvc->finalize().ignore();
  }
  c.service->release();
  c.service = 0;
}

StatusCode NTupleSvc::attachTuple	(	const std::string &	filename,
		const std::string &	logname,
		const char	typ,
		const long	t
	)			[protected]

Attach output/input file.

Definition at line 502 of file NTupleSvc.cpp.

References CLID_NTupleFile, endmsg(), MSG::ERROR, MSG::INFO, StatusCode::isSuccess(), DataSvc::m_rootName, Service::msgSvc(), Service::name(), DataSvc::registerAddress(), GenericAddress::release(), and DataSvc::retrieveObject().

Referenced by TagCollectionSvc::connect(), and connect().

                                                                                                                     {
  MsgStream log(msgSvc(), name());
  DataObject* p;
  // First get the root object
  StatusCode status = retrieveObject(m_rootName, p);
  if ( status.isSuccess() )   {
    // Now add the registry entry to the store
    std::string entryname = m_rootName;
    entryname += '/';
    entryname += logname;
    GenericAddress* pA =
       new GenericAddress(t, CLID_NTupleFile, filename, entryname, 0, typ);
    status = registerAddress(p, logname, pA);
    if ( status.isSuccess() )    {
      log << MSG::INFO << "Added stream file:" << filename << " as " << logname << endmsg;
      return status;
    }
    pA->release();
  }
  log << MSG::ERROR << "Cannot add file:" << filename << " as " << logname << endmsg;
  return status;
}

StatusCode NTupleSvc::updateDirectories

(

)

[protected]

Update directory data.

Definition at line 119 of file NTupleSvc.cpp.

References IRegistry::address(), endmsg(), MSG::ERROR, DataSvc::findObject(), getDataLoader(), MSG::INFO, StatusCode::isSuccess(), DataSvc::m_rootName, Service::msgSvc(), Service::name(), DataSvc::objectLeaves(), DataSelectionAgent::selectedObjects(), DataSvc::traverseSubTree(), IConverter::updateRep(), and IConverter::updateRepRefs().

Referenced by finalize().

                                          {
  typedef std::vector<IRegistry*> Leaves;
  long need_update = 0;
  DataObject* pO = 0;
  StatusCode iret = findObject(m_rootName, pO);
  MsgStream log ( msgSvc(), name() );
  //  log << MSG::DEBUG << "in finalize()" << endmsg;
  if ( iret.isSuccess() )   {
    Leaves leaves;
    iret = objectLeaves(pO, leaves);
    if ( iret.isSuccess() )    {
      // Only traverse the tree below the files
      for ( Leaves::iterator d = leaves.begin(); d != leaves.end(); d++ )    {
        if ( (*d)->object() )   {
          IOpaqueAddress* pA = (*d)->address();
          if ( pA )   {
            unsigned long typ = pA->ipar()[1];
            if ( typ == 'R' || typ == 'N' || typ == 'U' )   {
              // ...starting from the file entries: first save the directories/ntuples
              IConversionSvc* svc = getDataLoader(*d);
              if ( 0 != svc )   {
                StatusCode status;
                DataSelectionAgent agent;
                IDataSelector*     sel = agent.selectedObjects();
                traverseSubTree ( (*d)->object(), &agent ).ignore();
                for(int i = sel->size()-1; i >= 0; i-- )    {
                  DataObject* o = (*sel)[i];
                  IRegistry*  r = o->registry();
                  status = svc->updateRep(r->address(), o);
                  if ( !status.isSuccess() )    {
                    iret = status;
                  }
                }
                for(int j = sel->size()-1; j >= 0; j-- )    {
                  DataObject* o = (*sel)[j];
                  IRegistry*  r = o->registry();
                  status = svc->updateRepRefs(r->address(), o);
                  if ( !status.isSuccess() )    {
                    iret = status;
                  }
                }
                if ( iret.isSuccess() ) need_update += sel->size();
              }
            }
          }
        }
      }
    }
  }
  if ( !iret.isSuccess() )    {
    log << MSG::ERROR << "ERROR while saving NTuples" << endmsg;
    return iret;
  }
  else if ( need_update > 0 )    {
    log << MSG::INFO << "NTuples saved successfully" << endmsg;
  }
  return iret;
}

---

Friends And Related Function Documentation

friend class SvcFactory< NTupleSvc > [friend]

Definition at line 38 of file NTupleSvc.h.

---

Member Data Documentation

DBaseEntries NTupleSvc::m_output [protected]

Output streams.

Definition at line 130 of file NTupleSvc.h.

Referenced by initialize().

DBaseEntries NTupleSvc::m_input [protected]

Input streams.

Definition at line 132 of file NTupleSvc.h.

Referenced by initialize().

Connections NTupleSvc::m_connections [protected]

Container of connection points.

Definition at line 134 of file NTupleSvc.h.

Referenced by TagCollectionSvc::connect(), connect(), disconnect(), disconnectAll(), getDataLoader(), and isConnected().

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiSvc/v17r1/src/NTupleSvc/NTupleSvc.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r2/GaudiSvc/v17r1/src/NTupleSvc/NTupleSvc.cpp

---