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
virtual StatusCode	initialize ()
	DataSvc overrides: Initialize the service. More...
virtual StatusCode	reinitialize ()
	DataSvc overrides: reinitialize service. More...
virtual StatusCode	finalize ()
	DataSvc overrides: stop the service. More...
virtual IConversionSvc *	getDataLoader (IRegistry *pReg)
	DataSvc overrides: Retrieve data loader. More...
virtual NTuple::Directory *	createDirectory (DataObject *pParent, const std::string &title)
	Create Ntuple directory and register it with the data store. More...
virtual NTuple::Directory *	createDirectory (DataObject *pParent, long id)
	Create Ntuple directory and register it with the data store. More...
virtual NTuple::Directory *	createDirectory (const std::string &dirPath, long id)
	Create Ntuple directory and register it with the data store. More...
virtual NTuple::Directory *	createDirectory (const std::string &dirPath, const std::string &title)
	Create Ntuple directory and register it with the data store. More...
virtual NTuple::Directory *	createDirectory (const std::string &fullPath)
	Create Ntuple directory and register it with the data store. More...
virtual StatusCode	create (const CLID &typ, const std::string &title, NTuple::Tuple *&refpTuple)
	Create requested N tuple (Hide constructor) More...
virtual NTuple::Tuple *	book (const std::string &fullPath, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store. More...
virtual NTuple::Tuple *	book (const std::string &dirPath, const std::string &relPath, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store. More...
virtual NTuple::Tuple *	book (const std::string &dirPath, long id, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store. More...
virtual NTuple::Tuple *	book (DataObject *pParent, const std::string &relPath, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store. More...
virtual NTuple::Tuple *	book (DataObject *pParent, long id, const CLID &type, const std::string &title)
	Book Ntuple and register it with the data store. More...
virtual NTuple::Tuple *	access (const std::string &fullPath, const std::string &filename)
	Access N tuple on disk. More...
virtual StatusCode	save (const std::string &fullPath)
	Save N tuple to disk. Must be called in order to close the ntuple file properly. More...
virtual StatusCode	save (NTuple::Tuple *tuple)
	Save N tuple to disk. Must be called in order to close the ntuple file properly. More...
virtual StatusCode	save (DataObject *pParent, const std::string &relPath)
	Save N tuple to disk. Must be called in order to close the ntuple file properly. More...
virtual StatusCode	writeRecord (NTuple::Tuple *tuple)
	Write single record to N tuple. More...
virtual StatusCode	writeRecord (const std::string &fullPath)
	Write single record to N tuple. More...
virtual StatusCode	writeRecord (DataObject *pParent, const std::string &relPath)
	Write single record to N tuple. More...
virtual StatusCode	readRecord (NTuple::Tuple *tuple)
	Read single record from N tuple. More...
virtual StatusCode	readRecord (const std::string &fullPath)
	Read single record from N tuple. More...
virtual StatusCode	readRecord (DataObject *pParent, const std::string &relPath)
	Read single record from N tuple. More...
virtual bool	isConnected (const std::string &identifier) const
	Check if a datasource is connected. More...
virtual StatusCode	connect (const std::string &ident)
	Add file to list I/O list. More...
virtual StatusCode	connect (const std::string &ident, std::string &logname)
	Add file to list I/O list. More...
virtual StatusCode	disconnect (const std::string &nam)
	Close open connection. More...
virtual StatusCode	disconnectAll ()
	Close all open connections. More...
	NTupleSvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor. More...
virtual	~NTupleSvc ()
	Standard Destructor. 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...
	~extends () override=default
	Virtual destructor. 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 (const std::string &fullPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	registerAddress (DataObject *parentObj, const std::string &objectPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	registerAddress (IRegistry *parentObj, const std::string &objectPath, IOpaqueAddress *pAddress) override
	IDataManagerSvc: Register object address with the data store. More...
StatusCode	unregisterAddress (const std::string &fullPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	unregisterAddress (DataObject *pParent, const std::string &objPath) override
	IDataManagerSvc: Unregister object address from the data store. More...
StatusCode	unregisterAddress (IRegistry *pParent, const std::string &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 (const std::string &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 (const std::string &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	addPreLoadItem (const std::string &itemPath) override
	Add an item to the preload list. More...
StatusCode	removePreLoadItem (const DataStoreItem &item) override
	Remove an item from the preload list. More...
StatusCode	removePreLoadItem (const std::string &itemPath) override
	Add an item to 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 (const std::string &fullPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (const std::string &parentPath, const std::string &objPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (const std::string &parentPath, int item, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (DataObject *parentObj, const std::string &objPath, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	registerObject (DataObject *parentObj, int item, DataObject *pObject) override
	Register object with the data store. More...
StatusCode	unregisterObject (const std::string &fullPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (const std::string &parentPath, const std::string &objectPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (const std::string &parentPath, int item) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject, const std::string &objectPath) override
	Unregister object from the data store. More...
StatusCode	unregisterObject (DataObject *pObject, int item) override
	Unregister object from the data store. More...
StatusCode	retrieveObject (IRegistry *pDirectory, const std::string &path, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (const std::string &fullPath, DataObject *&pObject) override
	Retrieve object identified by its full path from the data store. More...
StatusCode	retrieveObject (const std::string &parentPath, const std::string &objPath, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (const std::string &parentPath, int item, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (DataObject *parentObj, const std::string &objPath, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	retrieveObject (DataObject *parentObj, int item, DataObject *&pObject) override
	Retrieve object from data store. More...
StatusCode	findObject (const std::string &fullPath, DataObject *&pObject) override
	Find object identified by its full path in the data store. More...
StatusCode	findObject (IRegistry *pDirectory, const std::string &path, DataObject *&pObject) override
	Find object identified by its full path in the data store. More...
StatusCode	findObject (const std::string &parentPath, const std::string &objPath, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	findObject (const std::string &parentPath, int item, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	findObject (DataObject *parentObj, const std::string &objPath, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	findObject (DataObject *parentObj, int item, DataObject *&pObject) override
	Find object in the data store. More...
StatusCode	linkObject (IRegistry *from, const std::string &objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (const std::string &fromPath, const std::string &objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (DataObject *from, const std::string &objPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	linkObject (const std::string &fullPath, DataObject *to) override
	Add a link to another object. More...
StatusCode	unlinkObject (IRegistry *from, const std::string &objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (const std::string &fromPath, const std::string &objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (DataObject *fromObj, const std::string &objPath) override
	Remove a link to another object. More...
StatusCode	unlinkObject (const std::string &fullPath) override
	Remove a link to another object. More...
StatusCode	updateObject (IRegistry *pDirectory) override
	Update object identified by its directory entry. More...
StatusCode	updateObject (const std::string &updatePath) override
	Update object. More...
StatusCode	updateObject (DataObject *toUpdate) override
	Update object. More...
StatusCode	updateObject (const std::string &parentPath, const std::string &updatePath) override
	Update object. More...
StatusCode	updateObject (DataObject *pParent, const std::string &updatePath) override
	Update object. More...
StatusCode	initialize () override
	Service initialization. More...
StatusCode	reinitialize () override
	Service initialization. More...
StatusCode	finalize () override
	Service initialization. More...
	DataSvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor. More...
	~DataSvc () override
	Standard Destructor. 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...
	~extends () override=default
	Virtual destructor. 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...
StatusCode	setProperty (const Property &p) override
StatusCode	setProperty (const std::string &s) override
StatusCode	setProperty (const std::string &n, const std::string &v) override
StatusCode	getProperty (Property *p) const override
const Property &	getProperty (const std::string &name) const override
StatusCode	getProperty (const std::string &n, std::string &v) const override
const std::vector< Property * > &	getProperties () const override
bool	hasProperty (const std::string &name) const override
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value 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 >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...
Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...
template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...
template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public 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 CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
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...
MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...
MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Protected Types
typedef std::vector< std::string >	DBaseEntries
typedef std::map< std::string, Connection >	Connections
typedef std::pair< std::string, std::string >	Prop

Protected Member Functions
StatusCode	createService (const std::string &nam, const std::string &typ, const std::vector< Prop > &props, IConversionSvc *&pSvc)
	Create conversion service. 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, const std::string &path, DataSvcHelpers::RegistryEntry *&pEntry)
	Retrieve registry entry from store. More...
DataObject *	handleDataFault (IRegistry *pReg, const std::string &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 CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes
DBaseEntries	m_output
	Output streams. More...
DBaseEntries	m_input
	Input streams. More...
Connections	m_connections
	Container of connection points. More...
Protected Attributes inherited from DataSvc
CLID	m_rootCLID = 110
	Integer Property corresponding to CLID of root entry. More...
std::string	m_rootName = "/Event"
	Name of root event. More...
SmartIF< IConversionSvc >	m_dataLoader = nullptr
	Pointer to data loader service. More...
SmartIF< IIncidentSvc >	m_incidentSvc = nullptr
	Pointer to incident service. More...
LoadItems	m_preLoads
	Items to be pre-loaded. More...
bool	m_forceLeaves = false
	Allow forced creation of default leaves on registerObject. More...
bool	m_enableAccessHdlr = false
	Flag to enable interrupts on data access requests. More...
bool	m_enableFaultHdlr = false
	Flag to enable interrupts on data creation requests. More...
DataSvcHelpers::RegistryEntry *	m_root = nullptr
	Pointer to root entry. More...
DataSvcHelpers::InhibitMap *	m_inhibitMap = nullptr
	Map with object paths to be inhibited from loading. More...
std::vector< std::string >	m_inhibitPathes
	Property for the inhibited leaves. More...
std::string	m_accessName = "DataAccess"
	Name of the data access incident. More...
std::string	m_faultName = "DataFault"
	Name of the data fault incident. More...
Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. 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 DataSvc
typedef std::vector< DataStoreItem >	LoadItems
	Define set of load items. 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
typedef Gaudi::PluginService::Factory< IService *, const std::string &, ISvcLocator * >	Factory
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 24 of file NTupleSvc.h.

Member Typedef Documentation

typedef std::map<std::string, Connection> NTupleSvc::Connections

protected

Definition at line 36 of file NTupleSvc.h.

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

protected

Definition at line 35 of file NTupleSvc.h.

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

protected

Definition at line 37 of file NTupleSvc.h.

Constructor & Destructor Documentation

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

Standard Constructor.

Definition at line 60 of file NTupleSvc.cpp.

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

NTupleSvc::~NTupleSvc ( )

virtual

Standard Destructor.

Definition at line 70 of file NTupleSvc.cpp.

                        {
}

Member Function Documentation

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

virtual

Access N tuple on disk.

Definition at line 519 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 461 of file NTupleSvc.cpp.

                                                                                                                     {
  DataObject* p;
  // First get the root object
  StatusCode status = retrieveObject(m_rootName, p);
  if ( status.isSuccess() )   {
    // Now add the registry entry to the store
    std::string entryname = m_rootName;
    entryname += '/';
    entryname += logname;
    GenericAddress* pA =
       new GenericAddress(t, CLID_NTupleFile, filename, entryname, 0, typ);
    status = registerAddress(p, logname, pA);
    if ( status.isSuccess() )    {
      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  )

virtual

Book Ntuple and register it with the data store.

Definition at line 355 of file NTupleSvc.cpp.

                                                                                                  {
  DataObject* pObj = nullptr;
  std::string path = fullPath;
  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  )

virtual

Book Ntuple and register it with the data store.

Definition at line 390 of file NTupleSvc.cpp.

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

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

virtual

Book Ntuple and register it with the data store.

Definition at line 398 of file NTupleSvc.cpp.

                                                                                                          {
  return book( dirPath, toStr(id), type, title);
}

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

virtual

Book Ntuple and register it with the data store.

Definition at line 403 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  )

virtual

Book Ntuple and register it with the data store.

Definition at line 421 of file NTupleSvc.cpp.

                                                         {
  return book( pParent, toStr(id), type, title);
}

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

virtual

Add file to list I/O list.

Definition at line 206 of file NTupleSvc.cpp.

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

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

virtual

Add file to list I/O list.

Reimplemented in TagCollectionSvc.

Definition at line 211 of file NTupleSvc.cpp.

                                                                           {
  DataObject* pO = nullptr;
  StatusCode status = findObject(m_rootName, 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(Connections::value_type(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  )

virtual

Create requested N tuple (Hide constructor)

Eventually allow loading through factory?

Definition at line 334 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  )

virtual

Create Ntuple directory and register it with the data store.

Definition at line 429 of file NTupleSvc.cpp.

                                                                           {
  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  )

virtual

Create Ntuple directory and register it with the data store.

Definition at line 444 of file NTupleSvc.cpp.

                                                                            {
  return createDirectory( pParent, toStr(id) );
}

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

virtual

Create Ntuple directory and register it with the data store.

Definition at line 449 of file NTupleSvc.cpp.

                                                                                 {
  return createDirectory( dirPath, toStr(id) );
}

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

virtual

Create Ntuple directory and register it with the data store.

Definition at line 454 of file NTupleSvc.cpp.

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

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

virtual

Create Ntuple directory and register it with the data store.

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

  StringProperty 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 )

virtual

Close open connection.

Definition at line 180 of file NTupleSvc.cpp.

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

StatusCode NTupleSvc::disconnectAll ( )

virtual

Close all open connections.

Definition at line 191 of file NTupleSvc.cpp.

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

StatusCode NTupleSvc::finalize ( )

virtual

DataSvc overrides: stop the service.

stop the service.

Definition at line 198 of file NTupleSvc.cpp.

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

IConversionSvc * NTupleSvc::getDataLoader ( IRegistry *  pReg )

virtual

DataSvc overrides: Retrieve data loader.

DataSvc override: Retrieve data loader.

Reimplemented from DataSvc.

Definition at line 107 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 ( )

virtual

DataSvc overrides: Initialize the service.

Initialize the service.

Definition at line 74 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

virtual

Check if a datasource is connected.

Definition at line 101 of file NTupleSvc.cpp.

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

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

virtual

Read single record from N tuple.

Definition at line 603 of file NTupleSvc.cpp.

                                                        {
  StatusCode 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 = IDataProviderSvc::NO_DATA_LOADER;
    }
    catch(...)    {
      status = INVALID_OBJECT;
    }
  }
  return status;
}

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

virtual

Read single record from N tuple.

Definition at line 632 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 ) : INVALID_OBJ_PATH;
}

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

virtual

Read single record from N tuple.

Definition at line 639 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 ) : INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::reinitialize ( )

virtual

DataSvc overrides: reinitialize service.

Initialize the service.

Definition at line 96 of file NTupleSvc.cpp.

                                   {
  return StatusCode::SUCCESS;
}

void NTupleSvc::releaseConnection ( Connection &  c )

protected

Finalize single service.

Definition at line 172 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 )

virtual

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

Definition at line 524 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 ) : INVALID_OBJ_PATH;
}

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

virtual

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

Definition at line 531 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 status = pSvc->updateRep(pAddr, n_tuple);
        if ( status.isSuccess() )   {
          status = pSvc->updateRepRefs(pAddr, n_tuple);
        }
        return status;
      }
      return IDataProviderSvc::NO_DATA_LOADER;
    }
    catch(...)    {
    }
  }
  return INVALID_OBJECT;
}

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

virtual

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

Definition at line 554 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 ) : INVALID_OBJ_PATH;
}

StatusCode NTupleSvc::updateDirectories ( )

protected

Update directory data.

Definition at line 118 of file NTupleSvc.cpp.

                                          {
  typedef std::vector<IRegistry*> Leaves;
  long need_update = 0;
  DataObject* pO = nullptr;
  StatusCode iret = findObject(m_rootName, pO);
  //  debug() << "in finalize()" << endmsg;
  if ( iret.isSuccess() )   {
    Leaves 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;

        StatusCode status;
        DataSelectionAgent agent;
        IDataSelector*     sel = agent.selectedObjects();
        traverseSubTree ( (*d)->object(), &agent ).ignore();
        for(int i = sel->size()-1; i >= 0; i-- )    {
          DataObject* o = (*sel)[i];
          IRegistry*  r = o->registry();
          status = svc->updateRep(r->address(), o);
          if ( !status.isSuccess() )    {
            iret = status;
          }
        }
        for(int j = sel->size()-1; j >= 0; j-- )    {
          DataObject* o = (*sel)[j];
          IRegistry*  r = o->registry();
          status = svc->updateRepRefs(r->address(), o);
          if ( !status.isSuccess() ) iret = status;
        }
        if ( iret.isSuccess() ) need_update += sel->size();
      }
    }
  }
  if ( !iret.isSuccess() )    {
    error() << "ERROR while saving NTuples" << endmsg;
    return iret;
  }
  else if ( need_update > 0 )    {
    info() << "NTuples saved successfully" << endmsg;
  }
  return iret;
}

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

virtual

Write single record to N tuple.

Definition at line 561 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 IDataProviderSvc::NO_DATA_LOADER;
    }
    catch(...)    {
    }
  }
  return INVALID_OBJECT;
}

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

virtual

Write single record to N tuple.

Definition at line 589 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 ) : INVALID_OBJ_PATH;
}

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

virtual

Write single record to N tuple.

Definition at line 596 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 ) : INVALID_OBJ_PATH;
}

Member Data Documentation

Connections NTupleSvc::m_connections

protected

Container of connection points.

Definition at line 128 of file NTupleSvc.h.

DBaseEntries NTupleSvc::m_input

protected

Input streams.

Definition at line 126 of file NTupleSvc.h.

DBaseEntries NTupleSvc::m_output

protected

Output streams.

Definition at line 124 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