NTupleSvc Class Reference

NTuple service. More...

#include <src/NTupleSvc/NTupleSvc.h>

Inheritance diagram for NTupleSvc:

Collaboration diagram for NTupleSvc:

Classes
struct	Connection

Public Member Functions
StatusCode	initialize () override
	DataSvc overrides: Initialize the service. More...
StatusCode	reinitialize () override
	DataSvc overrides: reinitialize service. More...
StatusCode	finalize () override
	DataSvc overrides: stop the service. More...
IConversionSvc *	getDataLoader (IRegistry *pReg) override
	DataSvc overrides: Retrieve data loader. More...
NTuple::Directory *	createDirectory (DataObject *pParent, const std::string &title) override
	Create Ntuple directory and register it with the data store. More...
NTuple::Directory *	createDirectory (DataObject *pParent, long id) override
	Create Ntuple directory and register it with the data store. More...
NTuple::Directory *	createDirectory (const std::string &dirPath, long id) override
	Create Ntuple directory and register it with the data store. More...
NTuple::Directory *	createDirectory (const std::string &dirPath, const std::string &title) override
	Create Ntuple directory and register it with the data store. More...
NTuple::Directory *	createDirectory (const std::string &fullPath) override
	Create Ntuple directory and register it with the data store. More...
StatusCode	create (const CLID &typ, const std::string &title, NTuple::Tuple *&refpTuple) override
	Create requested N tuple (Hide constructor) More...
NTuple::Tuple *	book (const std::string &fullPath, const CLID &type, const std::string &title) override
	Book Ntuple and register it with the data store. More...
NTuple::Tuple *	book (const std::string &dirPath, const std::string &relPath, const CLID &type, const std::string &title) override
	Book Ntuple and register it with the data store. More...
NTuple::Tuple *	book (const std::string &dirPath, long id, const CLID &type, const std::string &title) override
	Book Ntuple and register it with the data store. More...
NTuple::Tuple *	book (DataObject *pParent, const std::string &relPath, const CLID &type, const std::string &title) override
	Book Ntuple and register it with the data store. More...
NTuple::Tuple *	book (DataObject *pParent, long id, const CLID &type, const std::string &title) override
	Book Ntuple and register it with the data store. More...
NTuple::Tuple *	access (const std::string &fullPath, const std::string &filename) override
	Access N tuple on disk. More...
StatusCode	save (const std::string &fullPath) override
	Save N tuple to disk. Must be called in order to close the ntuple file properly. More...
StatusCode	save (NTuple::Tuple *tuple) override
	Save N tuple to disk. Must be called in order to close the ntuple file properly. More...
StatusCode	save (DataObject *pParent, const std::string &relPath) override
	Save N tuple to disk. Must be called in order to close the ntuple file properly. More...
StatusCode	writeRecord (NTuple::Tuple *tuple) override
	Write single record to N tuple. More...
StatusCode	writeRecord (const std::string &fullPath) override
	Write single record to N tuple. More...
StatusCode	writeRecord (DataObject *pParent, const std::string &relPath) override
	Write single record to N tuple. More...
StatusCode	readRecord (NTuple::Tuple *tuple) override
	Read single record from N tuple. More...
StatusCode	readRecord (const std::string &fullPath) override
	Read single record from N tuple. More...
StatusCode	readRecord (DataObject *pParent, const std::string &relPath) override
	Read single record from N tuple. More...
bool	isConnected (const std::string &identifier) const override
	Check if a datasource is connected. More...
StatusCode	connect (const std::string &ident) override
	Add file to list I/O list. More...
StatusCode	connect (const std::string &ident, std::string &logname) override
	Add file to list I/O list. More...
StatusCode	disconnect (const std::string &nam) override
	Close open connection. More...
StatusCode	disconnectAll () override
	Close all open connections. More...
	NTupleSvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor. More...
Public Member Functions inherited from extends< DataSvc, INTupleSvc, IDataSourceMgr >
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...
Public Member Functions inherited from DataSvc
CLID	rootCLID () const override
	IDataManagerSvc: Accessor for root event CLID. More...
const std::string &	rootName () const override
	IDataManagerSvc: Accessor for root event name. More...
StatusCode	registerAddress (boost::string_ref fullPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	registerAddress (IRegistry *parentObj, boost::string_ref objectPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	unregisterAddress (boost::string_ref fullPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	unregisterAddress (IRegistry *pParent, boost::string_ref objPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	objectLeaves (const DataObject *pObject, std::vector< IRegistry * > &refLeaves) override
	IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object. More...
StatusCode	objectLeaves (const IRegistry *pRegistry, std::vector< IRegistry * > &refLeaves) override
	IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object. More...
StatusCode	objectParent (const DataObject *pObject, IRegistry *&refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent. More...
StatusCode	objectParent (const IRegistry *pRegistry, IRegistry *&refpParent) override
	IDataManagerSvc: Explore the object store: retrieve the object's parent. More...
StatusCode	clearSubTree (boost::string_ref sub_tree_path) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by its full path name. More...
StatusCode	clearSubTree (DataObject *pObject) override
	IDataManagerSvc: Remove all data objects below the sub tree identified by the object. More...
StatusCode	clearStore () override
	IDataManagerSvc: Remove all data objects in the data store. More...
StatusCode	traverseSubTree (boost::string_ref sub_tree_path, IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree identified by its full path name. More...
StatusCode	traverseSubTree (DataObject *pObject, IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects below the sub tree. More...
StatusCode	traverseTree (IDataStoreAgent *pAgent) override
	IDataManagerSvc: Analyze by traversing all data objects in the data store. More...
StatusCode	setRoot (std::string root_name, DataObject *pRootObj) override
	Initialize data store for new event by giving new event path and root object. More...
virtual StatusCode	i_setRoot (std::string root_name, DataObject *pRootObj)
	Initialize data store for new event by giving new event path and root object. More...
StatusCode	setRoot (std::string root_path, IOpaqueAddress *pRootAddr) override
	Initialize data store for new event by giving new event path and address of root object. More...
virtual StatusCode	i_setRoot (std::string root_path, IOpaqueAddress *pRootAddr)
	Initialize data store for new event by giving new event path and address of root object. More...
StatusCode	setDataLoader (IConversionSvc *svc, IDataProviderSvc *dpsvc=nullptr) override
	IDataManagerSvc: IDataManagerSvc: Pass a default data loader to the service and optionally a data provider. More...
StatusCode	addPreLoadItem (const DataStoreItem &item) override
	Add an item to the preload list. More...
StatusCode	removePreLoadItem (const DataStoreItem &item) override
	Remove an item from the preload list. More...
StatusCode	resetPreLoad () override
	Clear the preload list. More...
virtual StatusCode	preLoad (int depth, int load_depth, DataObject *pObject)
	Execute one level of preloading and recursively load until the final level is reached. More...
StatusCode	preLoad () override
	load all preload items of the list More...
StatusCode	registerObject (boost::string_ref parentPath, boost::string_ref objPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (DataObject *parentObj, boost::string_ref objPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	unregisterObject (boost::string_ref fullPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject, boost::string_ref objectPath) override
	Unregister object from the data store. More...
StatusCode	retrieveObject (IRegistry *pDirectory, boost::string_ref path, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	findObject (boost::string_ref fullPath, DataObject *&pObject) override
	Find object identified by its full path in the data store. More...
StatusCode	findObject (IRegistry *pDirectory, boost::string_ref path, DataObject *&pObject) override
	Find object identified by its full path in the data store. More...
StatusCode	linkObject (IRegistry *from, boost::string_ref objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (boost::string_ref fullPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	unlinkObject (IRegistry *from, boost::string_ref objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (DataObject *fromObj, boost::string_ref objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (boost::string_ref fullPath) override
	Remove a link to another object. More...
StatusCode	updateObject (IRegistry *pDirectory) override
	Update object identified by its directory entry. More...
StatusCode	updateObject (DataObject *toUpdate) override
	Update object. More...
StatusCode	initialize () override
	Service initialization. More...
StatusCode	reinitialize () override
	Service initialization. More...
StatusCode	finalize () override
	Service initialization. More...
	DataSvc (const DataSvc &)=delete
	copy constructor disabled More...
DataSvc &	operator= (const DataSvc &)=delete
	Fake assignment operator (never implemented). More...
Public Member Functions inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
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...
Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...
StatusCode	configure () override
StatusCode	initialize () override
StatusCode	start () override
StatusCode	stop () override
StatusCode	finalize () override
StatusCode	terminate () override
Gaudi::StateMachine::State	FSMState () const override
Gaudi::StateMachine::State	targetFSMState () const override
StatusCode	reinitialize () override
StatusCode	restart () override
StatusCode	sysInitialize () override
	Initialize Service. More...
StatusCode	sysStart () override
	Initialize Service. More...
StatusCode	sysStop () override
	Initialize Service. More...
StatusCode	sysFinalize () override
	Finalize Service. More...
StatusCode	sysReinitialize () override
	Re-initialize the Service. More...
StatusCode	sysRestart () override
	Re-initialize the Service. More...
	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...
StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...
template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const
template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...
template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...
Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...
StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...
const Gaudi::Details::PropertyBase &	getProperty (const std::string &name) const override
	get the property by name More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	convert the property to the string More...
const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...
bool	hasProperty (const std::string &name) const override
	Return true if we have a property with the given name. More...
	PropertyHolder (const PropertyHolder &)=delete
PropertyHolder &	operator= (const PropertyHolder &)=delete
Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
MSG::Level	outputLevel () const
	Backward compatibility function for getting the output level. More...
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

Protected Types
typedef std::vector< std::string >	DBaseEntries
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. More...
void	releaseConnection (Connection &c)
	Finalize single service. More...
StatusCode	attachTuple (const std::string &filename, const std::string &logname, const char typ, const long t)
	Attach output/input file. More...
StatusCode	updateDirectories ()
	Update directory data. More...
Protected Member Functions inherited from DataSvc
bool	checkRoot ()
	Check if root path is valid. More...
virtual DataObject *	createDefaultObject () const
	Create default objects in case forced creation of leaves is requested. More...
virtual StatusCode	loadObject (IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation. More...
virtual StatusCode	loadObject (IConversionSvc *pLoader, IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation. More...
StatusCode	retrieveEntry (DataSvcHelpers::RegistryEntry *pNode, boost::string_ref path, DataSvcHelpers::RegistryEntry *&pEntry)
	Retrieve registry entry from store. More...
DataObject *	handleDataFault (IRegistry *pReg, boost::string_ref path="")
	Invoke data fault handling if enabled. More...
Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...
int	outputLevel () const
	get the Service's output level More...
Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const
Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...
MSG::Level	resetMessaging ()
	Reinitialize internal states. More...
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes
Gaudi::Property< DBaseEntries >	m_input {this, "Input", {}, "input streams"}
Gaudi::Property< DBaseEntries >	m_output {this, "Output", {}, "output streams"}
std::map< std::string, Connection >	m_connections
	Container of connection points. More...
Protected Attributes inherited from DataSvc
SmartIF< IIncidentSvc >	m_incidentSvc = nullptr
	Pointer to incident service. More...
Gaudi::Property< CLID >	m_rootCLID {this, "RootCLID", 110 , "CLID of root entry"}
Gaudi::Property< std::string >	m_rootName {this, "RootName", "/Event", "name of root entry"}
std::unique_ptr< DataSvcHelpers::RegistryEntry >	m_root
	Pointer to root entry. More...
Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::Property< int >	m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
Gaudi::Property< bool >	m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}
Gaudi::Property< bool >	m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}
Gaudi::Property< bool >	m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}
Gaudi::Property< bool >	m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}
Gaudi::Property< bool >	m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}
Gaudi::Property< bool >	m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}
Gaudi::Property< bool >	m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}
SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Additional Inherited Members
Public Types inherited from extends< DataSvc, INTupleSvc, IDataSourceMgr >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
Public Types inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory< IService *(const std::string &, ISvcLocator *)>
Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...
Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging
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...

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 23 of file NTupleSvc.h.

Member Typedef Documentation

typedef std::vector<std::string> NTupleSvc::DBaseEntries

protected

Definition at line 31 of file NTupleSvc.h.

typedef std::pair<std::string, std::string> NTupleSvc::Prop

protected

Definition at line 32 of file NTupleSvc.h.

Constructor & Destructor Documentation

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

Standard Constructor.

Definition at line 51 of file NTupleSvc.cpp.

                                                              : base_class( name, svc )
{
  m_rootName = "/NTUPLES";
  m_rootCLID = CLID_DataObject;
}

Member Function Documentation

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

override

Access N tuple on disk.

Definition at line 512 of file NTupleSvc.cpp.

{ return nullptr; }

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 452 of file NTupleSvc.cpp.

{
  DataObject* p;
  // First get the root object
  StatusCode status = retrieveObject( m_rootName.value(), 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() ) {
      info() << "Added stream file:" << filename << " as " << logname << endmsg;
      return status;
    }
    pA->release();
  }
  error() << "Cannot add file:" << filename << " as " << logname << endmsg;
  return status;
}

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

override

Book Ntuple and register it with the data store.

Definition at line 335 of file NTupleSvc.cpp.

{
  DataObject* pObj = nullptr;
  std::string path = fullPath;
  assert( !path.empty() );
  if ( path[0] != SEPARATOR ) {
    path = m_rootName;
    path += SEPARATOR;
    path += fullPath;
  }
  StatusCode status = retrieveObject( path, pObj );
  if ( status.isSuccess() ) {
    error() << "Cannot book N-tuple " << path << " (Exists already)" << endmsg;
    return nullptr;
  }
  auto sep = path.rfind( SEPARATOR );
  if ( sep == std::string::npos ) {
    error() << "Cannot book N-tuple " << path << " (Invalid path)" << endmsg;
    return nullptr;
  }

  std::string p_path( path, 0, sep );
  std::string o_path( path, sep, path.length() );
  DataObject* dir = createDirectory( p_path );
  if ( !dir ) {
    error() << "Cannot book N-tuple " << path << " (Invalid parent directory)" << endmsg;
    return nullptr;
  }

  NTuple::Tuple* tup = book( dir, o_path, type, title );
  if ( !tup ) {
    error() << "Cannot book N-tuple " << path << " (Unknown reason)" << endmsg;
  }
  return tup;
}

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

override

Book Ntuple and register it with the data store.

Definition at line 372 of file NTupleSvc.cpp.

{
  std::string full = dirPath;
  assert( !relPath.empty() );
  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  )

override

Book Ntuple and register it with the data store.

Definition at line 383 of file NTupleSvc.cpp.

{
  return book( dirPath, std::to_string( id ), type, title );
}

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

override

Book Ntuple and register it with the data store.

Definition at line 389 of file NTupleSvc.cpp.

{
  NTuple::Tuple* pObj = nullptr;
  // 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 nullptr;
}

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

override

Book Ntuple and register it with the data store.

Definition at line 409 of file NTupleSvc.cpp.

{
  return book( pParent, std::to_string( id ), type, title );
}

StatusCode NTupleSvc::connect ( const std::string &  ident )

override

Add file to list I/O list.

Definition at line 191 of file NTupleSvc.cpp.

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

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

override

Add file to list I/O list.

Definition at line 197 of file NTupleSvc.cpp.

{
  DataObject* pO     = nullptr;
  StatusCode  status = findObject( m_rootName.value(), pO );
  if ( status.isSuccess() ) {
    char              typ = 0;
    std::vector<Prop> props;
    long              loc = ident.find( " " );
    std::string       filename, auth, svc = "", db_typ = "";
    logname      = ident.substr( 0, loc );
    using Parser = Gaudi::Utils::AttribStringParser;
    // we assume that there is always a " "
    // (but if it is not there, we probably will not match the pattern)
    for ( auto attrib : Parser( ident.substr( loc + 1 ) ) ) {
      switch (::toupper( attrib.tag[0] ) ) {
      case 'A':
        break;
      case 'F': // FILE='<file name>'
      case 'D': // DATAFILE='<file name>'
        filename = std::move( attrib.value );
        break;
      case 'O': // OPT='<NEW<CREATE,WRITE>, UPDATE, READ>'
        switch (::toupper( attrib.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 = std::move( attrib.value );
        break;
      default:
        props.emplace_back( attrib.tag, attrib.value );
        break;
      }
    }
    if ( 0 != typ ) {
      IConversionSvc* pSvc = nullptr;
      status               = createService( name() + '.' + logname, db_typ, props, pSvc );
      if ( status.isSuccess() ) {
        status = attachTuple( filename, logname, typ, pSvc->repSvcType() );
        if ( status.isSuccess() ) {
          m_connections.insert( {m_rootName + '/' + logname, Connection( pSvc )} );
          return StatusCode::SUCCESS;
        }
      }
    }
  }
  error() << "Cannot add " << ident << " invalid filename!" << endmsg;
  return StatusCode::FAILURE;
}

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

override

Create requested N tuple (Hide constructor)

Eventually allow loading through factory?

Definition at line 315 of file NTupleSvc.cpp.

{
  NTuple::TupleImp* pTuple = nullptr;
  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 ( pTuple ) {
    pTuple->setTupleService( this );
    status = StatusCode::SUCCESS;
  }
  refpTuple = pTuple;
  return status;
}

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

override

Create Ntuple directory and register it with the data store.

Definition at line 415 of file NTupleSvc.cpp.

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

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

override

Create Ntuple directory and register it with the data store.

Definition at line 431 of file NTupleSvc.cpp.

{
  return createDirectory( pParent, std::to_string( id ) );
}

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

override

Create Ntuple directory and register it with the data store.

Definition at line 437 of file NTupleSvc.cpp.

{
  return createDirectory( dirPath, std::to_string( id ) );
}

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

override

Create Ntuple directory and register it with the data store.

Definition at line 443 of file NTupleSvc.cpp.

{
  assert( !relPath.empty() );
  std::string full = dirPath;
  if ( relPath[0] != '/' ) full += "/";
  full += relPath;
  return createDirectory( full );
}

NTuple::Directory * NTupleSvc::createDirectory ( const std::string &  fullPath )

override

Create Ntuple directory and register it with the data store.

Definition at line 476 of file NTupleSvc.cpp.

{
  NTuple::Directory* p      = nullptr;
  StatusCode         status = findObject( fullPath, *pp_cast<DataObject>( &p ) );
  if ( !status.isSuccess() ) {
    auto sep2 = fullPath.rfind( SEPARATOR );
    if ( sep2 != std::string::npos ) {
      std::string relPath = fullPath.substr( 0, sep2 );
      p                   = createDirectory( relPath );
      if ( 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 ( svc ) {
            IOpaqueAddress* pAddr = nullptr;
            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 = nullptr;
      }
    }
  }
  return dynamic_cast<NTuple::Directory*>( p );
}

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

Definition at line 261 of file NTupleSvc.cpp.

{
  // Get the value of the Stat persistancy mechanism from the AppMgr
  auto appPropMgr = serviceLocator()->as<IProperty>();
  if ( !appPropMgr ) {
    // Report an error and return the FAILURE status code
    error() << "Could not get PropMgr" << endmsg;
    return StatusCode::FAILURE;
  }

  Gaudi::Property<std::string> sp( "HistogramPersistency", "" );
  StatusCode                   sts = appPropMgr->getProperty( &sp );
  if ( !sts.isSuccess() ) {
    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 {
    error() << "Unknown NTuple Persistency format: " << sp.value() << endmsg;
    return StatusCode::FAILURE;
  }

  if ( !typ.empty() && typ != sp.value() ) {
    warning() << "NTuple persistency type is " << sp.value() << "." << endmsg << "Type given by job option "
              << "NTupleSvc.Input/Output ignored!" << endmsg;
  }

  //      debug() << "storage type: " << m_storageType << endmsg;

  // FIXME: (MCl) why NTupleSvc has to directly create a ConversionSvc?
  IInterface* iface    = new ConversionSvc( name() + "Conversions", serviceLocator(), storage_typ );
  auto        pService = SmartIF<IService>( iface );
  if ( !pService ) return StatusCode::FAILURE;

  auto cnvSvc = pService.as<IConversionSvc>();
  if ( !cnvSvc ) return StatusCode::FAILURE;

  pSvc = cnvSvc.get();
  pSvc->addRef(); // make sure the caller gets a pSvc which points at something
                  // with a refCount of (at least) one...
  auto status = pService->sysInitialize();
  if ( !status.isSuccess() ) return status;
  return pSvc->setDataProvider( this );
}

StatusCode NTupleSvc::disconnect ( const std::string &  nam )

override

Close open connection.

Definition at line 164 of file NTupleSvc.cpp.

{
  auto i = m_connections.find( nam );
  if ( i == m_connections.end() ) return StatusCode::FAILURE;
  releaseConnection( i->second );
  m_connections.erase( i );
  return StatusCode::SUCCESS;
}

StatusCode NTupleSvc::disconnectAll ( )

override

Close all open connections.

Definition at line 174 of file NTupleSvc.cpp.

{
  for ( auto& i : m_connections ) releaseConnection( i.second );
  m_connections.clear();
  return StatusCode::SUCCESS;
}

StatusCode NTupleSvc::finalize ( )

override

DataSvc overrides: stop the service.

stop the service.

Definition at line 182 of file NTupleSvc.cpp.

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

IConversionSvc * NTupleSvc::getDataLoader ( IRegistry *  pReg )

overridevirtual

DataSvc overrides: Retrieve data loader.

DataSvc override: Retrieve data loader.

Reimplemented from DataSvc.

Definition at line 91 of file NTupleSvc.cpp.

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

StatusCode NTupleSvc::initialize ( )

override

DataSvc overrides: Initialize the service.

Definition at line 58 of file NTupleSvc.cpp.

{
  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 ( auto& i : m_output ) {
        iret                            = connect( i );
        if ( !iret.isSuccess() ) status = iret;
      }
      for ( auto& j : m_input ) {
        iret                            = connect( j );
        if ( !iret.isSuccess() ) status = iret;
      }
    }
  }
  return status;
}

bool NTupleSvc::isConnected ( const std::string &  identifier ) const

override

Check if a datasource is connected.

Definition at line 84 of file NTupleSvc.cpp.

{
  auto i = m_connections.find( identifier );
  return i != m_connections.end();
}

StatusCode NTupleSvc::readRecord ( NTuple::Tuple *  tuple )

override

Read single record from N tuple.

Definition at line 596 of file NTupleSvc.cpp.

{
  StatusCode        status = Status::INVALID_OBJECT;
  NTuple::TupleImp* tuple  = (NTuple::TupleImp*)n_tuple;
  if ( tuple ) {
    try {
      IConversionSvc* pSvc = tuple->conversionService();
      if ( !pSvc ) {
        pSvc = getDataLoader( n_tuple->registry() );
        tuple->setConversionService( pSvc );
      }
      if ( 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 = Status::NO_DATA_LOADER;
    } catch ( ... ) {
      status = Status::INVALID_OBJECT;
    }
  }
  return status;
}

StatusCode NTupleSvc::readRecord ( const std::string &  fullPath )

override

Read single record from N tuple.

Definition at line 625 of file NTupleSvc.cpp.

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

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

override

Read single record from N tuple.

Definition at line 633 of file NTupleSvc.cpp.

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

StatusCode NTupleSvc::reinitialize ( )

override

DataSvc overrides: reinitialize service.

Initialize the service.

Definition at line 81 of file NTupleSvc.cpp.

{ return StatusCode::SUCCESS; }

void NTupleSvc::releaseConnection ( Connection &  c )

protected

Finalize single service.

Definition at line 155 of file NTupleSvc.cpp.

{
  SmartIF<IService> isvc( c.service );
  if ( isvc ) isvc->finalize().ignore();
  c.service->release();
  c.service = nullptr;
}

StatusCode NTupleSvc::save ( const std::string &  fullPath )

override

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

Definition at line 515 of file NTupleSvc.cpp.

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

StatusCode NTupleSvc::save ( NTuple::Tuple *  tuple )

override

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

Definition at line 523 of file NTupleSvc.cpp.

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

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

override

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

Definition at line 544 of file NTupleSvc.cpp.

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

StatusCode NTupleSvc::updateDirectories ( )

protected

Update directory data.

Definition at line 102 of file NTupleSvc.cpp.

{
  long        need_update = 0;
  DataObject* pO          = nullptr;
  StatusCode  iret        = findObject( m_rootName.value(), pO );
  //  debug() << "in finalize()" << endmsg;
  if ( iret.isSuccess() ) {
    std::vector<IRegistry*> leaves;
    iret = objectLeaves( pO, leaves );
    if ( iret.isSuccess() ) {
      // Only traverse the tree below the files
      for ( auto d = leaves.begin(); d != leaves.end(); d++ ) {
        if ( !( *d )->object() ) continue;
        IOpaqueAddress* pA = ( *d )->address();
        if ( !pA ) continue;
        unsigned long typ = pA->ipar()[1];
        if ( typ != 'R' && typ != 'N' && typ != 'U' ) continue;
        // ...starting from the file entries: first save the directories/ntuples
        IConversionSvc* svc = getDataLoader( *d );
        if ( !svc ) continue;

        IDataSelector sel;
        IDataManagerSvc::traverseSubTree( ( *d )->object(), [&sel]( IRegistry* r, int ) {
          DataObject* obj = r->object();
          if ( obj ) sel.push_back( obj );
          return true;
        } ).ignore();
        for ( DataObject* o : reverse( sel ) ) {
          IRegistry* r                    = o->registry();
          auto       status               = svc->updateRep( r->address(), o );
          if ( !status.isSuccess() ) iret = status;
        }
        for ( DataObject* o : reverse( sel ) ) {
          IRegistry* r                    = o->registry();
          auto       status               = svc->updateRepRefs( r->address(), o );
          if ( !status.isSuccess() ) iret = status;
        }

        if ( iret.isSuccess() ) need_update += sel.size();
      }
    }
  }
  if ( !iret.isSuccess() ) {
    error() << "ERROR while saving NTuples" << endmsg;
    return iret;
  }
  if ( need_update > 0 ) {
    info() << "NTuples saved successfully" << endmsg;
  }
  return iret;
}

StatusCode NTupleSvc::writeRecord ( NTuple::Tuple *  tuple )

override

Write single record to N tuple.

Definition at line 552 of file NTupleSvc.cpp.

{
  NTuple::TupleImp* tuple = (NTuple::TupleImp*)n_tuple;
  if ( tuple ) {
    try {
      IConversionSvc* pSvc = tuple->conversionService();
      if ( !pSvc ) {
        pSvc = getDataLoader( n_tuple->registry() );
        tuple->setConversionService( pSvc );
      }
      if ( 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 Status::NO_DATA_LOADER;
    } catch ( ... ) {
    }
  }
  return Status::INVALID_OBJECT;
}

StatusCode NTupleSvc::writeRecord ( const std::string &  fullPath )

override

Write single record to N tuple.

Definition at line 580 of file NTupleSvc.cpp.

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

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

override

Write single record to N tuple.

Definition at line 588 of file NTupleSvc.cpp.

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

Member Data Documentation

std::map<std::string, Connection> NTupleSvc::m_connections

protected

Container of connection points.

Definition at line 119 of file NTupleSvc.h.

Gaudi::Property<DBaseEntries> NTupleSvc::m_input {this, "Input", {}, "input streams"}

protected

Definition at line 115 of file NTupleSvc.h.

Gaudi::Property<DBaseEntries> NTupleSvc::m_output {this, "Output", {}, "output streams"}

protected

Definition at line 116 of file NTupleSvc.h.

---

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

• GaudiSvc/src/NTupleSvc/NTupleSvc.h
• GaudiSvc/src/NTupleSvc/NTupleSvc.cpp