NTupleSvc Class Reference

NTuple service. More...

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

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.
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 Member Functions inherited from DataSvc
bool	checkRoot ()
	Check if root path is valid.
virtual DataObject *	createDefaultObject () const
	Create default objects in case forced creation of leaves is requested.
virtual StatusCode	loadObject (IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation.
virtual StatusCode	loadObject (IConversionSvc *pLoader, IRegistry *pNode)
	Invoke Persistency service to create transient object from its persistent representation.
StatusCode	retrieveEntry (DataSvcHelpers::RegistryEntry *pNode, std::string_view path, DataSvcHelpers::RegistryEntry *&pEntry)
	Retrieve registry entry from store.
DataObject *	handleDataFault (IRegistry *pReg, std::string_view path="")
	Invoke data fault handling if enabled.
Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()
	~Service () override
int	outputLevel () const
	get the Service's output level
Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches.
MSG::Level	resetMessaging ()
	Reinitialize internal states.
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.

Protected Attributes
Gaudi::Property< DBaseEntries >	m_input { this, "Input", {}, "input streams" }
Gaudi::Property< DBaseEntries >	m_output { this, "Output", {}, "output streams" }
Gaudi::Property< int >	m_basketsize { this, "BasketSize", 32000, "BasketSize" }
std::map< std::string, Connection >	m_connections
	Container of connection points.
Protected Attributes inherited from DataSvc
SmartIF< IIncidentSvc >	m_incidentSvc = nullptr
	Pointer to incident service.
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.
Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state.
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state.
Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools
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()" }
Gaudi::Property< bool >	m_autoRetrieveTools
Gaudi::Property< bool >	m_checkToolDeps
SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Additional Inherited Members
Public Types inherited from extends< DataSvc, INTupleSvc, IDataSourceMgr >
using	base_class
	Typedef to this class.
using	extend_interfaces_base
	Typedef to the base of this class.
Public Types inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
using	base_class
	Typedef to this class.
using	extend_interfaces_base
	Typedef to the base of this class.
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
	Typedef used to refer to this class from derived classes, as in.
Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

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

Member Typedef Documentation

DBaseEntries

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

protected

Definition at line 39 of file NTupleSvc.h.

Prop

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

protected

Definition at line 40 of file NTupleSvc.h.

Constructor & Destructor Documentation

NTupleSvc()

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

Standard Constructor.

Definition at line 61 of file NTupleSvc.cpp.

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

Member Function Documentation

access()

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

override

Access N tuple on disk.

Definition at line 491 of file NTupleSvc.cpp.

{ return nullptr; }

attachTuple()

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 433 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;
}

book() [1/5]

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

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

book() [2/5]

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

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

book() [3/5]

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 327 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;
}

book() [4/5]

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 376 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;
}

book() [5/5]

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

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

connect() [1/2]

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

override

Add file to list I/O list.

Definition at line 187 of file NTupleSvc.cpp.

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

connect() [2/2]

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

override

Add file to list I/O list.

Definition at line 192 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;
}

create()

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 308 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;
}

createDirectory() [1/5]

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

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

createDirectory() [2/5]

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

override

Create Ntuple directory and register it with the data store.

Definition at line 420 of file NTupleSvc.cpp.

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

createDirectory() [3/5]

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

override

Create Ntuple directory and register it with the data store.

Definition at line 456 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 ).ignore( /* AUTOMATICALLY ADDED FOR gaudi/Gaudi!763 */ );
        }
        p->release();
        p = nullptr;
      }
    }
  }
  return p;
}

createDirectory() [4/5]

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

override

Create Ntuple directory and register it with the data store.

Definition at line 400 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;
}

createDirectory() [5/5]

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

override

Create Ntuple directory and register it with the data store.

Definition at line 415 of file NTupleSvc.cpp.

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

createService()

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 255 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 );
}

disconnect()

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

override

Close open connection.

Definition at line 163 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;
}

disconnectAll()

StatusCode NTupleSvc::disconnectAll ( )

override

Close all open connections.

Definition at line 172 of file NTupleSvc.cpp.

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

finalize()

StatusCode NTupleSvc::finalize ( )

override

DataSvc overrides: stop the service.

stop the service.

Definition at line 179 of file NTupleSvc.cpp.

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

getDataLoader()

IConversionSvc * NTupleSvc::getDataLoader ( IRegistry * pReg )

overridevirtual

DataSvc overrides: Retrieve data loader.

DataSvc override: Retrieve data loader.

Reimplemented from DataSvc.

Definition at line 95 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;
}

initialize()

StatusCode NTupleSvc::initialize ( )

override

DataSvc overrides: Initialize the service.

Definition at line 67 of file NTupleSvc.cpp.

                                 {
  StatusCode status = DataSvc::initialize();
  if ( status.isSuccess() ) {
    StatusCode  iret = StatusCode::SUCCESS;
    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;
}

isConnected()

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

override

Check if a datasource is connected.

Definition at line 89 of file NTupleSvc.cpp.

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

readRecord() [1/3]

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

override

Read single record from N tuple.

Definition at line 591 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;
}

readRecord() [2/3]

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

override

Read single record from N tuple.

Definition at line 598 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;
}

readRecord() [3/3]

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

override

Read single record from N tuple.

Definition at line 567 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;
}

reinitialize()

StatusCode NTupleSvc::reinitialize ( )

override

DataSvc overrides: reinitialize service.

Initialize the service.

Definition at line 86 of file NTupleSvc.cpp.

{ return StatusCode::SUCCESS; }

releaseConnection()

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;
}

save() [1/3]

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 494 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;
}

save() [2/3]

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 520 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;
}

save() [3/3]

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 501 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;
}

updateDirectories()

StatusCode NTupleSvc::updateDirectories ( )

protected

Update directory data.

Definition at line 105 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;
}

writeRecord() [1/3]

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

override

Write single record to N tuple.

Definition at line 553 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;
}

writeRecord() [2/3]

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

override

Write single record to N tuple.

Definition at line 560 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;
}

writeRecord() [3/3]

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

override

Write single record to N tuple.

Definition at line 527 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;
}

Member Data Documentation

m_basketsize

Gaudi::Property<int> NTupleSvc::m_basketsize { this, "BasketSize", 32000, "BasketSize" }

protected

Definition at line 127 of file NTupleSvc.h.

{ this, "BasketSize", 32000, "BasketSize" }; // ROOT default

m_connections

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

protected

Container of connection points.

Definition at line 129 of file NTupleSvc.h.

m_input

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

protected

Definition at line 124 of file NTupleSvc.h.

{ this, "Input", {}, "input streams" };

m_output

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

protected

Definition at line 125 of file NTupleSvc.h.

{ this, "Output", {}, "output streams" };

---

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

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