The Gaudi Framework  v32r2 (46d42edc)
NTupleSvc Class Reference

NTuple service. More...

#include <src/NTupleSvc/NTupleSvc.h>

Inheritance diagram for NTupleSvc:
Collaboration diagram for NTupleSvc:

Classes

struct  Connection
 

Public Member Functions

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

Protected Types

typedef std::vector< std::stringDBaseEntries
 
typedef std::pair< std::string, std::stringProp
 

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 DataObjectcreateDefaultObject () 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, std::string_view path, DataSvcHelpers::RegistryEntry *&pEntry)
 Retrieve registry entry from store. More...
 
DataObjecthandleDataFault (IRegistry *pReg, std::string_view path="")
 Invoke data fault handling if enabled. More...
 
- Protected Member Functions inherited from Service
 ~Service () override
 Standard Destructor. More...
 
int outputLevel () const
 get the Service's output level More...
 
- Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBaseproperty (const std::string &name) const
 
- Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level setUpMessaging () const
 Set up local caches. More...
 
MSG::Level resetMessaging ()
 Reinitialize internal states. More...
 
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 

Protected Attributes

Gaudi::Property< DBaseEntriesm_input {this, "Input", {}, "input streams"}
 
Gaudi::Property< DBaseEntriesm_output {this, "Output", {}, "output streams"}
 
std::map< std::string, Connectionm_connections
 Container of connection points. More...
 
- Protected Attributes inherited from DataSvc
SmartIF< IIncidentSvcm_incidentSvc = nullptr
 Pointer to incident service. More...
 
Gaudi::Property< CLIDm_rootCLID {this, "RootCLID", 110 , "CLID of root entry"}
 
Gaudi::Property< std::stringm_rootName {this, "RootName", "/Event", "name of root entry"}
 
std::unique_ptr< DataSvcHelpers::RegistryEntrym_root
 Pointer to root entry. More...
 
- Protected Attributes inherited from Service
Gaudi::StateMachine::State m_state = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::StateMachine::State m_targetState = Gaudi::StateMachine::OFFLINE
 Service state. More...
 
Gaudi::Property< int > m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}
 
Gaudi::Property< bool > m_auditInit {this, "AuditServices", false, " unused"}
 
Gaudi::Property< bool > m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}
 
Gaudi::Property< bool > m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}
 
Gaudi::Property< bool > m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}
 
Gaudi::Property< bool > m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}
 
Gaudi::Property< bool > m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}
 
Gaudi::Property< bool > m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}
 
SmartIF< IAuditorSvcm_pAuditorSvc
 Auditor Service. More...
 

Additional Inherited Members

- Public Types inherited from extends< DataSvc, INTupleSvc, IDataSourceMgr >
using base_class = extends
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces... >
 Typedef to the base of this class. More...
 
- Public Types inherited from extends< Service, IDataProviderSvc, IDataManagerSvc >
using base_class = extends
 Typedef to this class. More...
 
using extend_interfaces_base = extend_interfaces< Interfaces... >
 Typedef to the base of this class. More...
 
- Public Types inherited from Service
using Factory = Gaudi::PluginService::Factory< IService *(const std::string &, ISvcLocator *)>
 
- Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
 Typedef used to refer to this class from derived classes, as in. More...
 
- Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using base_class = CommonMessaging
 
- Public Types inherited from extend_interfaces< Interfaces... >
using ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
 take union of the ext_iids of all Interfaces... More...
 

Detailed Description

NTuple service.

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

Author
M.Frank

Definition at line 23 of file NTupleSvc.h.

Member Typedef Documentation

◆ DBaseEntries

Definition at line 30 of file NTupleSvc.h.

◆ Prop

Definition at line 31 of file NTupleSvc.h.

Constructor & Destructor Documentation

◆ NTupleSvc()

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

Standard Constructor.

Definition at line 51 of file NTupleSvc.cpp.

51  : base_class( name, svc ) {
52  m_rootName = "/NTUPLES";
53  m_rootCLID = CLID_DataObject;
54 }
Gaudi::Property< CLID > m_rootCLID
Definition: DataSvc.h:51
Gaudi::Property< std::string > m_rootName
Definition: DataSvc.h:52
extends base_class
Typedef to this class.
Definition: extends.h:14
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274

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

484 { 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 426 of file NTupleSvc.cpp.

427  {
428  DataObject* p;
429  // First get the root object
430  StatusCode status = retrieveObject( m_rootName.value(), p );
431  if ( status.isSuccess() ) {
432  // Now add the registry entry to the store
433  std::string entryname = m_rootName;
434  entryname += '/';
435  entryname += logname;
436  GenericAddress* pA = new GenericAddress( t, CLID_NTupleFile, filename, entryname, 0, typ );
437  status = registerAddress( p, logname, pA );
438  if ( status.isSuccess() ) {
439  info() << "Added stream file:" << filename << " as " << logname << endmsg;
440  return status;
441  }
442  pA->release();
443  }
444  error() << "Cannot add file:" << filename << " as " << logname << endmsg;
445  return status;
446 }
unsigned long release() override
release reference to object
Gaudi::Property< std::string > m_rootName
Definition: DataSvc.h:52
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
Generic Transient Address.
STL class.
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
bool isSuccess() const
Definition: StatusCode.h:267
StatusCode registerAddress(std::string_view fullPath, IOpaqueAddress *pAddress) override
IDataManagerSvc: Register object address with the data store.
Definition: DataSvc.cpp:215
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
StatusCode retrieveObject(IRegistry *pDirectory, std::string_view path, DataObject *&pObject) override
Retrieve object from data store.
Definition: DataSvc.cpp:618
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

◆ book() [1/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 320 of file NTupleSvc.cpp.

320  {
321  DataObject* pObj = nullptr;
322  std::string path = fullPath;
323  assert( !path.empty() );
324  if ( path[0] != SEPARATOR ) {
325  path = m_rootName;
326  path += SEPARATOR;
327  path += fullPath;
328  }
329  StatusCode status = retrieveObject( path, pObj );
330  if ( status.isSuccess() ) {
331  error() << "Cannot book N-tuple " << path << " (Exists already)" << endmsg;
332  return nullptr;
333  }
334  auto sep = path.rfind( SEPARATOR );
335  if ( sep == std::string::npos ) {
336  error() << "Cannot book N-tuple " << path << " (Invalid path)" << endmsg;
337  return nullptr;
338  }
339 
340  std::string p_path( path, 0, sep );
341  std::string o_path( path, sep, path.length() );
342  DataObject* dir = createDirectory( p_path );
343  if ( !dir ) {
344  error() << "Cannot book N-tuple " << path << " (Invalid parent directory)" << endmsg;
345  return nullptr;
346  }
347 
348  NTuple::Tuple* tup = book( dir, o_path, type, title );
349  if ( !tup ) { error() << "Cannot book N-tuple " << path << " (Unknown reason)" << endmsg; }
350  return tup;
351 }
constexpr char SEPARATOR
Gaudi::Property< std::string > m_rootName
Definition: DataSvc.h:52
NTuple::Tuple * book(const std::string &fullPath, const CLID &type, const std::string &title) override
Book Ntuple and register it with the data store.
Definition: NTupleSvc.cpp:320
STL class.
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
NTuple::Directory * createDirectory(DataObject *pParent, const std::string &title) override
Create Ntuple directory and register it with the data store.
Definition: NTupleSvc.cpp:393
bool isSuccess() const
Definition: StatusCode.h:267
Abstract base class which allows the user to interact with the actual N tuple implementation.
Definition: NTuple.h:375
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
StatusCode retrieveObject(IRegistry *pDirectory, std::string_view path, DataObject *&pObject) override
Retrieve object from data store.
Definition: DataSvc.cpp:618
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

◆ book() [2/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 354 of file NTupleSvc.cpp.

355  {
356  std::string full = dirPath;
357  assert( !relPath.empty() );
358  if ( relPath[0] != SEPARATOR ) full += SEPARATOR;
359  full += relPath;
360  return book( full, type, title );
361 }
T empty(T... args)
constexpr char SEPARATOR
NTuple::Tuple * book(const std::string &fullPath, const CLID &type, const std::string &title) override
Book Ntuple and register it with the data store.
Definition: NTupleSvc.cpp:320
STL class.

◆ book() [3/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 364 of file NTupleSvc.cpp.

364  {
365  return book( dirPath, std::to_string( id ), type, title );
366 }
T to_string(T... args)
NTuple::Tuple * book(const std::string &fullPath, const CLID &type, const std::string &title) override
Book Ntuple and register it with the data store.
Definition: NTupleSvc.cpp:320

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

370  {
371  NTuple::Tuple* pObj = nullptr;
372  // Check if object is already present
373  StatusCode status = findObject( pParent, relPath, *pp_cast<DataObject>( &pObj ) );
374  // No ? Then create it!
375  if ( !status.isSuccess() ) {
376  status = create( type, title, pObj );
377  if ( status.isSuccess() ) {
378  // Finally register the created N tuple with the store
379  status = registerObject( pParent, relPath, pObj );
380  if ( status.isSuccess() ) return pObj;
381  pObj->release();
382  }
383  }
384  return nullptr;
385 }
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
bool isSuccess() const
Definition: StatusCode.h:267
Abstract base class which allows the user to interact with the actual N tuple implementation.
Definition: NTuple.h:375
virtual unsigned long release()
release reference to object
Definition: DataObject.cpp:46
StatusCode registerObject(std::string_view parentPath, std::string_view objPath, DataObject *pObject) override
Register object with the data store.
Definition: DataSvc.cpp:293
StatusCode create(const CLID &typ, const std::string &title, NTuple::Tuple *&refpTuple) override
Create requested N tuple (Hide constructor)
Definition: NTupleSvc.cpp:301
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640

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

388  {
389  return book( pParent, std::to_string( id ), type, title );
390 }
T to_string(T... args)
NTuple::Tuple * book(const std::string &fullPath, const CLID &type, const std::string &title) override
Book Ntuple and register it with the data store.
Definition: NTupleSvc.cpp:320

◆ connect() [1/2]

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

Add file to list I/O list.

Definition at line 180 of file NTupleSvc.cpp.

180  {
181  std::string logName;
182  return connect( ident, logName );
183 }
STL class.
StatusCode connect(const std::string &ident) override
Add file to list I/O list.
Definition: NTupleSvc.cpp:180

◆ connect() [2/2]

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

Add file to list I/O list.

Definition at line 185 of file NTupleSvc.cpp.

185  {
186  DataObject* pO = nullptr;
187  StatusCode status = findObject( m_rootName.value(), pO );
188  if ( status.isSuccess() ) {
189  char typ = 0;
190  std::vector<Prop> props;
191  long loc = ident.find( " " );
192  std::string filename, auth, svc = "", db_typ = "";
193  logname = ident.substr( 0, loc );
194  using Parser = Gaudi::Utils::AttribStringParser;
195  // we assume that there is always a " "
196  // (but if it is not there, we probably will not match the pattern)
197  for ( auto attrib : Parser( ident.substr( loc + 1 ) ) ) {
198  switch ( ::toupper( attrib.tag[0] ) ) {
199  case 'A':
200  break;
201  case 'F': // FILE='<file name>'
202  case 'D': // DATAFILE='<file name>'
203  filename = std::move( attrib.value );
204  break;
205  case 'O': // OPT='<NEW<CREATE,WRITE>, UPDATE, READ>'
206  switch ( ::toupper( attrib.value[0] ) ) {
207  case 'C':
208  case 'N':
209  case 'W':
210  typ = 'N';
211  break;
212  case 'U':
213  typ = 'U';
214  break;
215  case 'O':
216  case 'R':
217  typ = 'O';
218  break;
219  default:
220  typ = 0;
221  break;
222  }
223  break;
224  case 'T': // TYP='<HBOOK,ROOT,OBJY,...>'
225  db_typ = std::move( attrib.value );
226  break;
227  default:
228  props.emplace_back( attrib.tag, attrib.value );
229  break;
230  }
231  }
232  if ( 0 != typ ) {
233  IConversionSvc* pSvc = nullptr;
234  status = createService( name() + '.' + logname, db_typ, props, pSvc );
235  if ( status.isSuccess() ) {
236  status = attachTuple( filename, logname, typ, pSvc->repSvcType() );
237  if ( status.isSuccess() ) {
238  m_connections.insert( {m_rootName + '/' + logname, Connection( pSvc )} );
239  return StatusCode::SUCCESS;
240  }
241  }
242  }
243  }
244  error() << "Cannot add " << ident << " invalid filename!" << endmsg;
245  return StatusCode::FAILURE;
246 }
Parse attribute strings allowing iteration over the various attributes.
Gaudi::Property< std::string > m_rootName
Definition: DataSvc.h:52
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
std::map< std::string, Connection > m_connections
Container of connection points.
Definition: NTupleSvc.h:118
StatusCode createService(const std::string &nam, const std::string &typ, const std::vector< Prop > &props, IConversionSvc *&pSvc)
Create conversion service.
Definition: NTupleSvc.cpp:248
STL class.
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
virtual long repSvcType() const =0
Retrieve the class type of the data store the converter uses.
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
bool isSuccess() const
Definition: StatusCode.h:267
T move(T... args)
T find(T... args)
STL class.
constexpr static const auto FAILURE
Definition: StatusCode.h:86
T substr(T... args)
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640
StatusCode attachTuple(const std::string &filename, const std::string &logname, const char typ, const long t)
Attach output/input file.
Definition: NTupleSvc.cpp:426
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
void toupper(std::string &s)
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192
T emplace_back(T... args)

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

301  {
302  NTuple::TupleImp* pTuple = nullptr;
304  if ( typ == CLID_ColumnWiseTuple ) {
305  pTuple = new NTuple::ColumnWiseTuple( title );
306  } else if ( typ == CLID_RowWiseTuple ) {
307  pTuple = new NTuple::RowWiseTuple( title );
308  } else {
310  }
311  if ( pTuple ) {
312  pTuple->setTupleService( this );
313  status = StatusCode::SUCCESS;
314  }
315  refpTuple = pTuple;
316  return status;
317 }
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
void setTupleService(INTupleSvc *svc)
Access conversion service.
constexpr static const auto FAILURE
Definition: StatusCode.h:86

◆ createDirectory() [1/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 393 of file NTupleSvc.cpp.

393  {
394  assert( !relPath.empty() );
395  if ( pParent ) {
396  IRegistry* pDir = pParent->registry();
397  if ( pDir ) {
398  std::string full = pDir->identifier();
399  if ( relPath[0] != '/' ) full += "/";
400  full += relPath;
401  return createDirectory( full );
402  }
403  }
404  return nullptr;
405 }
IRegistry * registry() const
Get pointer to Registry.
Definition: DataObject.h:72
STL class.
NTuple::Directory * createDirectory(DataObject *pParent, const std::string &title) override
Create Ntuple directory and register it with the data store.
Definition: NTupleSvc.cpp:393
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:22
virtual const id_type & identifier() const =0
Full identifier (or key)

◆ createDirectory() [2/5]

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

Create Ntuple directory and register it with the data store.

Definition at line 408 of file NTupleSvc.cpp.

408  {
409  return createDirectory( pParent, std::to_string( id ) );
410 }
T to_string(T... args)
NTuple::Directory * createDirectory(DataObject *pParent, const std::string &title) override
Create Ntuple directory and register it with the data store.
Definition: NTupleSvc.cpp:393

◆ createDirectory() [3/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 413 of file NTupleSvc.cpp.

413  {
414  return createDirectory( dirPath, std::to_string( id ) );
415 }
T to_string(T... args)
NTuple::Directory * createDirectory(DataObject *pParent, const std::string &title) override
Create Ntuple directory and register it with the data store.
Definition: NTupleSvc.cpp:393

◆ createDirectory() [4/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 418 of file NTupleSvc.cpp.

418  {
419  assert( !relPath.empty() );
420  std::string full = dirPath;
421  if ( relPath[0] != '/' ) full += "/";
422  full += relPath;
423  return createDirectory( full );
424 }
STL class.
NTuple::Directory * createDirectory(DataObject *pParent, const std::string &title) override
Create Ntuple directory and register it with the data store.
Definition: NTupleSvc.cpp:393

◆ createDirectory() [5/5]

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

Create Ntuple directory and register it with the data store.

Definition at line 449 of file NTupleSvc.cpp.

449  {
450  NTuple::Directory* p = nullptr;
451  StatusCode status = findObject( fullPath, *pp_cast<DataObject>( &p ) );
452  if ( !status.isSuccess() ) {
453  auto sep2 = fullPath.rfind( SEPARATOR );
454  if ( sep2 != std::string::npos ) {
455  std::string relPath = fullPath.substr( 0, sep2 );
456  p = createDirectory( relPath );
457  if ( p ) {
458  p = new NTuple::Directory();
459  // Finally register the created N tuple with the store
460  status = registerObject( fullPath, p );
461  if ( status.isSuccess() ) {
462  // ...starting from the file entries
463  IConversionSvc* svc = getDataLoader( p->registry() );
464  if ( svc ) {
465  IOpaqueAddress* pAddr = nullptr;
466  status = svc->createRep( p, pAddr );
467  if ( status.isSuccess() ) {
468  p->registry()->setAddress( pAddr );
469  status = svc->fillRepRefs( pAddr, p );
470  if ( status.isSuccess() ) return p;
471  }
472  }
473  unregisterObject( p );
474  }
475  p->release();
476  p = nullptr;
477  }
478  }
479  }
480  return p;
481 }
IRegistry * registry() const
Get pointer to Registry.
Definition: DataObject.h:72
constexpr char SEPARATOR
T rfind(T... args)
virtual StatusCode createRep(DataObject *pObject, IOpaqueAddress *&refpAddress)=0
Convert the transient object to the requested representation.
STL class.
StatusCode unregisterObject(std::string_view fullPath) override
Unregister object from the data store.
Definition: DataSvc.cpp:373
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
NTuple::Directory * createDirectory(DataObject *pParent, const std::string &title) override
Create Ntuple directory and register it with the data store.
Definition: NTupleSvc.cpp:393
bool isSuccess() const
Definition: StatusCode.h:267
virtual unsigned long release()
release reference to object
Definition: DataObject.cpp:46
IConversionSvc * getDataLoader(IRegistry *pReg) override
DataSvc overrides: Retrieve data loader.
Definition: NTupleSvc.cpp:88
virtual void setAddress(IOpaqueAddress *pAddress)=0
Set/Update Opaque storage address.
StatusCode registerObject(std::string_view parentPath, std::string_view objPath, DataObject *pObject) override
Register object with the data store.
Definition: DataSvc.cpp:293
T substr(T... args)
Small class representing an N tuple directory in the transient store.
Definition: NTuple.h:901
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640
Opaque address interface definition.
virtual StatusCode fillRepRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Resolve the references of the converted object.

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

249  {
251  // Get the value of the Stat persistancy mechanism from the AppMgr
252  auto appPropMgr = serviceLocator()->as<IProperty>();
253  if ( !appPropMgr ) {
254  // Report an error and return the FAILURE status code
255  error() << "Could not get PropMgr" << endmsg;
256  return StatusCode::FAILURE;
257  }
258 
259  Gaudi::Property<std::string> sp( "HistogramPersistency", "" );
260  StatusCode sts = appPropMgr->getProperty( &sp );
261  if ( !sts.isSuccess() ) {
262  error() << "Could not get NTuple Persistency format"
263  << " from ApplicationMgr properties" << endmsg;
264  return sts;
265  }
266 
267  long storage_typ = TEST_StorageType;
268  if ( sp.value() == "HBOOK" ) {
269  storage_typ = HBOOK_StorageType;
270  } else if ( sp.value() == "ROOT" ) {
271  storage_typ = ROOT_StorageType;
272  } else {
273  error() << "Unknown NTuple Persistency format: " << sp.value() << endmsg;
274  return StatusCode::FAILURE;
275  }
276 
277  if ( !typ.empty() && typ != sp.value() ) {
278  warning() << "NTuple persistency type is " << sp.value() << "." << endmsg << "Type given by job option "
279  << "NTupleSvc.Input/Output ignored!" << endmsg;
280  }
281 
282  // debug() << "storage type: " << m_storageType << endmsg;
283 
284  // FIXME: (MCl) why NTupleSvc has to directly create a ConversionSvc?
285  IInterface* iface = new ConversionSvc( name() + "Conversions", serviceLocator(), storage_typ );
286  auto pService = SmartIF<IService>( iface );
287  if ( !pService ) return StatusCode::FAILURE;
288 
289  auto cnvSvc = pService.as<IConversionSvc>();
290  if ( !cnvSvc ) return StatusCode::FAILURE;
291 
292  pSvc = cnvSvc.get();
293  pSvc->addRef(); // make sure the caller gets a pSvc which points at something
294  // with a refCount of (at least) one...
295  auto status = pService->sysInitialize();
296  if ( !status.isSuccess() ) return status;
297  return pSvc->setDataProvider( this );
298 }
const long TEST_StorageType
Definition: ClassID.h:49
SmartIF< ISvcLocator > & serviceLocator() const override
Retrieve pointer to service locator.
Definition: Service.cpp:277
T empty(T... args)
const long HBOOK_StorageType
Definition: ClassID.h:56
Implementation of property with value of concrete type.
Definition: Property.h:352
MsgStream & warning() const
shortcut for the method msgStream(MSG::WARNING)
virtual StatusCode setDataProvider(IDataProviderSvc *pService)=0
Set Data provider service.
SmartIF< IFace > as()
Definition: ISvcLocator.h:103
const std::string & name() const override
Retrieve name of the service.
Definition: Service.cpp:274
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
Definition of the basic interface.
Definition: IInterface.h:244
const long ROOT_StorageType
Definition: ClassID.h:52
bool isSuccess() const
Definition: StatusCode.h:267
constexpr static const auto FAILURE
Definition: StatusCode.h:86
virtual unsigned long addRef()=0
Increment the reference count of Interface instance.
Base class for all conversion services.
Definition: ConversionSvc.h:45
The IProperty is the basic interface for all components which have properties that can be set or get.
Definition: IProperty.h:20
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

◆ disconnect()

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

Close open connection.

Definition at line 156 of file NTupleSvc.cpp.

156  {
157  auto i = m_connections.find( nam );
158  if ( i == m_connections.end() ) return StatusCode::FAILURE;
159  releaseConnection( i->second );
160  m_connections.erase( i );
161  return StatusCode::SUCCESS;
162 }
void releaseConnection(Connection &c)
Finalize single service.
Definition: NTupleSvc.cpp:148
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
std::map< std::string, Connection > m_connections
Container of connection points.
Definition: NTupleSvc.h:118
constexpr static const auto FAILURE
Definition: StatusCode.h:86

◆ disconnectAll()

StatusCode NTupleSvc::disconnectAll ( )
override

Close all open connections.

Definition at line 165 of file NTupleSvc.cpp.

165  {
166  for ( auto& i : m_connections ) releaseConnection( i.second );
167  m_connections.clear();
168  return StatusCode::SUCCESS;
169 }
void releaseConnection(Connection &c)
Finalize single service.
Definition: NTupleSvc.cpp:148
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
std::map< std::string, Connection > m_connections
Container of connection points.
Definition: NTupleSvc.h:118

◆ finalize()

StatusCode NTupleSvc::finalize ( )
override

DataSvc overrides: stop the service.

stop the service.

Definition at line 172 of file NTupleSvc.cpp.

172  {
173  StatusCode status = updateDirectories();
174  status = clearStore();
175  status = DataSvc::finalize();
176  status = disconnectAll();
177  return status;
178 }
StatusCode updateDirectories()
Update directory data.
Definition: NTupleSvc.cpp:98
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
StatusCode finalize() override
Service initialization.
Definition: DataSvc.cpp:845
StatusCode disconnectAll() override
Close all open connections.
Definition: NTupleSvc.cpp:165
StatusCode clearStore() override
IDataManagerSvc: Remove all data objects in the data store.
Definition: DataSvc.cpp:101

◆ getDataLoader()

IConversionSvc * NTupleSvc::getDataLoader ( IRegistry pReg)
overridevirtual

DataSvc overrides: Retrieve data loader.

DataSvc override: Retrieve data loader.

Reimplemented from DataSvc.

Definition at line 88 of file NTupleSvc.cpp.

88  {
89  if ( !pRegistry ) return nullptr;
90  std::string full = pRegistry->identifier();
91  auto len = m_rootName.length();
92  auto idx = full.find( SEPARATOR, len + 1 );
93  std::string path = ( idx == std::string::npos ) ? full : full.substr( 0, idx );
94  auto i = m_connections.find( path );
95  return ( i != m_connections.end() ) ? i->second.service : nullptr;
96 }
constexpr char SEPARATOR
Gaudi::Property< std::string > m_rootName
Definition: DataSvc.h:52
std::map< std::string, Connection > m_connections
Container of connection points.
Definition: NTupleSvc.h:118
STL class.

◆ initialize()

StatusCode NTupleSvc::initialize ( )
override

DataSvc overrides: Initialize the service.

Definition at line 57 of file NTupleSvc.cpp.

57  {
59  if ( status.isSuccess() ) {
60  status = setProperties();
61  if ( status.isSuccess() ) {
62  StatusCode iret( StatusCode::SUCCESS, true );
64  status = setRoot( m_rootName, root );
65  for ( auto& i : m_output ) {
66  iret = connect( i );
67  if ( !iret.isSuccess() ) status = iret;
68  }
69  for ( auto& j : m_input ) {
70  iret = connect( j );
71  if ( !iret.isSuccess() ) status = iret;
72  }
73  }
74  }
75  return status;
76 }
StatusCode setRoot(std::string root_name, DataObject *pRootObj) override
Initialize data store for new event by giving new event path and root object.
Definition: DataSvc.cpp:132
Gaudi::Property< std::string > m_rootName
Definition: DataSvc.h:52
constexpr static const auto SUCCESS
Definition: StatusCode.h:85
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
Gaudi::Property< DBaseEntries > m_output
Definition: NTupleSvc.h:115
bool isSuccess() const
Definition: StatusCode.h:267
StatusCode setProperties()
Method for setting declared properties to the values specified for the job.
Definition: Service.cpp:280
StatusCode initialize() override
Service initialization.
Definition: DataSvc.cpp:812
Gaudi::Property< DBaseEntries > m_input
Definition: NTupleSvc.h:114
StatusCode connect(const std::string &ident) override
Add file to list I/O list.
Definition: NTupleSvc.cpp:180
Small class representing an N tuple directory in the transient store.
Definition: NTuple.h:901
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30

◆ isConnected()

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

Check if a datasource is connected.

Definition at line 82 of file NTupleSvc.cpp.

82  {
83  auto i = m_connections.find( identifier );
84  return i != m_connections.end();
85 }
std::map< std::string, Connection > m_connections
Container of connection points.
Definition: NTupleSvc.h:118

◆ readRecord() [1/3]

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

Read single record from N tuple.

Definition at line 560 of file NTupleSvc.cpp.

560  {
561  StatusCode status = Status::INVALID_OBJECT;
562  NTuple::TupleImp* tuple = (NTuple::TupleImp*)n_tuple;
563  if ( tuple ) {
564  try {
565  IConversionSvc* pSvc = tuple->conversionService();
566  if ( !pSvc ) {
567  pSvc = getDataLoader( n_tuple->registry() );
568  tuple->setConversionService( pSvc );
569  }
570  if ( pSvc ) {
571  IRegistry* pReg = n_tuple->registry();
572  IOpaqueAddress* pAddr = pReg->address();
573  status = pSvc->updateObj( pAddr, n_tuple );
574  if ( status.isSuccess() ) { status = pSvc->updateObjRefs( pAddr, n_tuple ); }
575  return status;
576  }
577  status = Status::NO_DATA_LOADER;
578  } catch ( ... ) { status = Status::INVALID_OBJECT; }
579  }
580  return status;
581 }
IConversionSvc * conversionService() const
Access conversion service.
virtual StatusCode updateObj(IOpaqueAddress *pAddress, DataObject *refpObject)=0
Update the transient object from the other representation.
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
virtual StatusCode updateObjRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Update the references of an updated transient object.
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:22
bool isSuccess() const
Definition: StatusCode.h:267
virtual IOpaqueAddress * address() const =0
Retrieve opaque storage address.
IConversionSvc * getDataLoader(IRegistry *pReg) override
DataSvc overrides: Retrieve data loader.
Definition: NTupleSvc.cpp:88
void setConversionService(IConversionSvc *svc)
Access conversion service.
Opaque address interface definition.

◆ readRecord() [2/3]

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

Read single record from N tuple.

Definition at line 584 of file NTupleSvc.cpp.

584  {
585  NTuple::Tuple* pObj = nullptr;
586  StatusCode status = findObject( fullPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is present
587  return status.isSuccess() ? readRecord( pObj ) : Status::INVALID_OBJ_PATH;
588 }
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
StatusCode readRecord(NTuple::Tuple *tuple) override
Read single record from N tuple.
Definition: NTupleSvc.cpp:560
bool isSuccess() const
Definition: StatusCode.h:267
Abstract base class which allows the user to interact with the actual N tuple implementation.
Definition: NTuple.h:375
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640

◆ readRecord() [3/3]

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

Read single record from N tuple.

Definition at line 591 of file NTupleSvc.cpp.

591  {
592  NTuple::Tuple* pObj = nullptr;
593  StatusCode status = findObject( pParent, relPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is present
594  return status.isSuccess() ? readRecord( pObj ) : Status::INVALID_OBJ_PATH;
595 }
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
StatusCode readRecord(NTuple::Tuple *tuple) override
Read single record from N tuple.
Definition: NTupleSvc.cpp:560
bool isSuccess() const
Definition: StatusCode.h:267
Abstract base class which allows the user to interact with the actual N tuple implementation.
Definition: NTuple.h:375
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640

◆ reinitialize()

StatusCode NTupleSvc::reinitialize ( )
override

DataSvc overrides: reinitialize service.

Initialize the service.

Definition at line 79 of file NTupleSvc.cpp.

79 { return StatusCode::SUCCESS; }
constexpr static const auto SUCCESS
Definition: StatusCode.h:85

◆ releaseConnection()

void NTupleSvc::releaseConnection ( Connection c)
protected

Finalize single service.

Definition at line 148 of file NTupleSvc.cpp.

148  {
149  SmartIF<IService> isvc( c.service );
150  if ( isvc ) isvc->finalize().ignore();
151  c.service->release();
152  c.service = nullptr;
153 }

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

487  {
488  NTuple::Tuple* pObj = nullptr;
489  StatusCode status = findObject( fullPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is present
490  return status.isSuccess() ? save( pObj ) : Status::INVALID_OBJ_PATH;
491 }
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
bool isSuccess() const
Definition: StatusCode.h:267
Abstract base class which allows the user to interact with the actual N tuple implementation.
Definition: NTuple.h:375
StatusCode save(const std::string &fullPath) override
Save N tuple to disk. Must be called in order to close the ntuple file properly.
Definition: NTupleSvc.cpp:487
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640

◆ save() [2/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 494 of file NTupleSvc.cpp.

494  {
495  NTuple::TupleImp* tuple = (NTuple::TupleImp*)n_tuple;
496  if ( tuple ) {
497  try {
498  IConversionSvc* pSvc = tuple->conversionService();
499  IRegistry* pReg = tuple->registry();
500  if ( pSvc && pReg ) {
501  IOpaqueAddress* pAddr = pReg->address();
502  StatusCode sc = pSvc->updateRep( pAddr, n_tuple );
503  if ( sc.isSuccess() ) sc = pSvc->updateRepRefs( pAddr, n_tuple );
504  return sc;
505  }
506  return Status::NO_DATA_LOADER;
507  } catch ( ... ) {}
508  }
509  return Status::INVALID_OBJECT;
510 }
IRegistry * registry() const
Get pointer to Registry.
Definition: DataObject.h:72
virtual StatusCode updateRepRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Update the references of an already converted object.
IConversionSvc * conversionService() const
Access conversion service.
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:22
virtual StatusCode updateRep(IOpaqueAddress *pAddress, DataObject *pObject)=0
Update the converted representation of a transient object.
bool isSuccess() const
Definition: StatusCode.h:267
virtual IOpaqueAddress * address() const =0
Retrieve opaque storage address.
Opaque address interface definition.

◆ save() [3/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 513 of file NTupleSvc.cpp.

513  {
514  NTuple::Tuple* pObj = nullptr;
515  StatusCode status = findObject( pParent, relPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is present
516  return status.isSuccess() ? save( pObj ) : Status::INVALID_OBJ_PATH;
517 }
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
bool isSuccess() const
Definition: StatusCode.h:267
Abstract base class which allows the user to interact with the actual N tuple implementation.
Definition: NTuple.h:375
StatusCode save(const std::string &fullPath) override
Save N tuple to disk. Must be called in order to close the ntuple file properly.
Definition: NTupleSvc.cpp:487
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640

◆ updateDirectories()

StatusCode NTupleSvc::updateDirectories ( )
protected

Update directory data.

Definition at line 98 of file NTupleSvc.cpp.

98  {
99  long need_update = 0;
100  DataObject* pO = nullptr;
101  StatusCode iret = findObject( m_rootName.value(), pO );
102  // debug() << "in finalize()" << endmsg;
103  if ( iret.isSuccess() ) {
105  iret = objectLeaves( pO, leaves );
106  if ( iret.isSuccess() ) {
107  // Only traverse the tree below the files
108  for ( auto d = leaves.begin(); d != leaves.end(); d++ ) {
109  if ( !( *d )->object() ) continue;
110  IOpaqueAddress* pA = ( *d )->address();
111  if ( !pA ) continue;
112  unsigned long typ = pA->ipar()[1];
113  if ( typ != 'R' && typ != 'N' && typ != 'U' ) continue;
114  // ...starting from the file entries: first save the directories/ntuples
115  IConversionSvc* svc = getDataLoader( *d );
116  if ( !svc ) continue;
117 
119  IDataManagerSvc::traverseSubTree( ( *d )->object(), [&sel]( IRegistry* r, int ) {
120  DataObject* obj = r->object();
121  if ( obj ) sel.push_back( obj );
122  return true;
123  } ).ignore();
124  for ( DataObject* o : reverse( sel ) ) {
125  IRegistry* r = o->registry();
126  auto status = svc->updateRep( r->address(), o );
127  if ( !status.isSuccess() ) iret = status;
128  }
129  for ( DataObject* o : reverse( sel ) ) {
130  IRegistry* r = o->registry();
131  auto status = svc->updateRepRefs( r->address(), o );
132  if ( !status.isSuccess() ) iret = status;
133  }
134 
135  if ( iret.isSuccess() ) need_update += sel.size();
136  }
137  }
138  }
139  if ( !iret.isSuccess() ) {
140  error() << "ERROR while saving NTuples" << endmsg;
141  return iret;
142  }
143  if ( need_update > 0 ) { info() << "NTuples saved successfully" << endmsg; }
144  return iret;
145 }
virtual StatusCode traverseSubTree(std::string_view sub_tree_path, IDataStoreAgent *pAgent)=0
Analyse by traversing all data objects below the sub tree identified by its full path name.
::details::reverse_wrapper< T > reverse(T &&iterable)
Definition: reverse.h:49
sel
Definition: IOTest.py:94
Gaudi::Property< std::string > m_rootName
Definition: DataSvc.h:52
T end(T... args)
MsgStream & info() const
shortcut for the method msgStream(MSG::INFO)
virtual StatusCode updateRepRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Update the references of an already converted object.
MsgStream & error() const
shortcut for the method msgStream(MSG::ERROR)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
StatusCode objectLeaves(const DataObject *pObject, std::vector< IRegistry * > &refLeaves) override
IDataManagerSvc: Explore the object store: retrieve all leaves attached to the object.
Definition: DataSvc.cpp:198
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:22
virtual StatusCode updateRep(IOpaqueAddress *pAddress, DataObject *pObject)=0
Update the converted representation of a transient object.
bool isSuccess() const
Definition: StatusCode.h:267
virtual IOpaqueAddress * address() const =0
Retrieve opaque storage address.
virtual DataObject * object() const =0
Retrieve object behind the link.
IConversionSvc * getDataLoader(IRegistry *pReg) override
DataSvc overrides: Retrieve data loader.
Definition: NTupleSvc.cpp:88
T begin(T... args)
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640
Opaque address interface definition.
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
virtual const unsigned long * ipar() const =0
Access to generic link parameters.
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:192

◆ writeRecord() [1/3]

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

Write single record to N tuple.

Definition at line 520 of file NTupleSvc.cpp.

520  {
521  NTuple::TupleImp* tuple = (NTuple::TupleImp*)n_tuple;
522  if ( tuple ) {
523  try {
524  IConversionSvc* pSvc = tuple->conversionService();
525  if ( !pSvc ) {
526  pSvc = getDataLoader( n_tuple->registry() );
527  tuple->setConversionService( pSvc );
528  }
529  if ( pSvc ) {
530  IRegistry* pReg = n_tuple->registry();
531  IOpaqueAddress* pAddr = pReg->address();
532  StatusCode status = pSvc->createRep( n_tuple, pAddr );
533  if ( status.isSuccess() ) {
534  pReg->setAddress( pAddr );
535  status = pSvc->fillRepRefs( pAddr, n_tuple );
536  }
537  return status;
538  }
539  return Status::NO_DATA_LOADER;
540  } catch ( ... ) {}
541  }
542  return Status::INVALID_OBJECT;
543 }
virtual StatusCode createRep(DataObject *pObject, IOpaqueAddress *&refpAddress)=0
Convert the transient object to the requested representation.
IConversionSvc * conversionService() const
Access conversion service.
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:22
bool isSuccess() const
Definition: StatusCode.h:267
virtual IOpaqueAddress * address() const =0
Retrieve opaque storage address.
IConversionSvc * getDataLoader(IRegistry *pReg) override
DataSvc overrides: Retrieve data loader.
Definition: NTupleSvc.cpp:88
virtual void setAddress(IOpaqueAddress *pAddress)=0
Set/Update Opaque storage address.
void setConversionService(IConversionSvc *svc)
Access conversion service.
Opaque address interface definition.
virtual StatusCode fillRepRefs(IOpaqueAddress *pAddress, DataObject *pObject)=0
Resolve the references of the converted object.

◆ writeRecord() [2/3]

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

Write single record to N tuple.

Definition at line 546 of file NTupleSvc.cpp.

546  {
547  NTuple::Tuple* pObj = nullptr;
548  StatusCode status = findObject( fullPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is present
549  return status.isSuccess() ? writeRecord( pObj ) : Status::INVALID_OBJ_PATH;
550 }
StatusCode writeRecord(NTuple::Tuple *tuple) override
Write single record to N tuple.
Definition: NTupleSvc.cpp:520
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
bool isSuccess() const
Definition: StatusCode.h:267
Abstract base class which allows the user to interact with the actual N tuple implementation.
Definition: NTuple.h:375
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640

◆ writeRecord() [3/3]

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

Write single record to N tuple.

Definition at line 553 of file NTupleSvc.cpp.

553  {
554  NTuple::Tuple* pObj = nullptr;
555  StatusCode status = findObject( pParent, relPath, *pp_cast<DataObject>( &pObj ) ); // Check if object is present
556  return status.isSuccess() ? writeRecord( pObj ) : Status::INVALID_OBJ_PATH;
557 }
StatusCode writeRecord(NTuple::Tuple *tuple) override
Write single record to N tuple.
Definition: NTupleSvc.cpp:520
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:50
bool isSuccess() const
Definition: StatusCode.h:267
Abstract base class which allows the user to interact with the actual N tuple implementation.
Definition: NTuple.h:375
StatusCode findObject(std::string_view fullPath, DataObject *&pObject) override
Find object identified by its full path in the data store.
Definition: DataSvc.cpp:640

Member Data Documentation

◆ m_connections

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

Container of connection points.

Definition at line 118 of file NTupleSvc.h.

◆ m_input

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

Definition at line 114 of file NTupleSvc.h.

◆ m_output

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

Definition at line 115 of file NTupleSvc.h.


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