Persistency service - to store histograms in ROOT format. More...

#include <src/PersSvc.h>

Inheritance diagram for RootHistCnv::PersSvc:

[legend]

Collaboration diagram for RootHistCnv::PersSvc:

[legend]

Public Member Functions
StatusCode	initialize () override
	Initialise the service. More...

StatusCode	finalize () override
	Finalise the service. More...

StatusCode	createRep (DataObject pObject, IOpaqueAddress &refpAddress) override
	Convert a collection of transient data objects into another representation. More...

	PersSvc (const std::string &name, ISvcLocator *svc)
	Standard constructor. More...

Public Member Functions inherited from ConversionSvc
	ConversionSvc (const std::string &name, ISvcLocator *svc, long type)
	Standard Constructor. More...

	ConversionSvc (const ConversionSvc &)=delete
	disable copy and assignment More...

ConversionSvc &	operator= (const ConversionSvc &)=delete

StatusCode	initialize () override
	Initialize the service. More...

StatusCode	finalize () override
	stop the service. More...

long	repSvcType () const override
	Retrieve the class type of the data store the converter uses. More...

const CLID &	objType () const override
	Implementation of IConverter: dummy call. More...

StatusCode	setDataProvider (IDataProviderSvc *pService) override
	Implementation of IConverter: Set Data provider service. More...

SmartIF< IDataProviderSvc > &	dataProvider () const override
	Implementation of IConverter: Get Data provider service. More...

StatusCode	setConversionSvc (IConversionSvc *svc) override
	Implementation of IConverter: Set conversion service the converter is connected to. More...

SmartIF< IConversionSvc > &	conversionSvc () const override
	Implementation of IConverter: Get conversion service the converter is connected to. More...

StatusCode	setAddressCreator (IAddressCreator *creator) override
	Set address creator facility. More...

SmartIF< IAddressCreator > &	addressCreator () const override
	Retrieve address creator facility. More...

StatusCode	createObj (IOpaqueAddress pAddress, DataObject &refpObject) override
	Implementation of IConverter: Create the transient representation of an object. More...

StatusCode	fillObjRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Resolve the references of the created transient object. More...

StatusCode	updateObj (IOpaqueAddress pAddress, DataObject refpObject) override
	Implementation of IConverter: Update the transient object from the other representation. More...

StatusCode	updateObjRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Update the references of an updated transient object. More...

StatusCode	createRep (DataObject pObject, IOpaqueAddress &refpAddress) override
	Implementation of IConverter: Convert the transient object to the requested representation. More...

StatusCode	fillRepRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Resolve the references of the converted object. More...

StatusCode	updateRep (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Update the converted representation of a transient object. More...

StatusCode	updateRepRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Implementation of IConverter: Update the references of an already converted object. More...

StatusCode	addConverter (const CLID &clid) override
	Add converter object to conversion service. More...

StatusCode	addConverter (IConverter *pConverter) override
	Add converter object to conversion service. More...

StatusCode	removeConverter (const CLID &clid) override
	Remove converter object from conversion service (if present). More...

IConverter *	converter (const CLID &wanted) override
	Retrieve converter from list. More...

StatusCode	connectOutput (const std::string &outputFile, const std::string &openMode) override
	Connect the output file to the service with open mode. More...

StatusCode	connectOutput (const std::string &output) override
	Connect the output file to the service. More...

StatusCode	commitOutput (const std::string &output, bool do_commit) override
	Commit pending output. More...

StatusCode	createAddress (long svc_type, const CLID &clid, const std::string par, const unsigned long ip, IOpaqueAddress *&refpAddress) override
	Create a Generic address using explicit arguments to identify a single object. More...

StatusCode	convertAddress (const IOpaqueAddress *pAddress, std::string &refAddress) override
	Convert an address to string form. More...

StatusCode	createAddress (long svc_type, const CLID &clid, const std::string &refAddress, IOpaqueAddress *&refpAddress) override
	Convert an address in string form to object form. More...

virtual StatusCode	updateServiceState (IOpaqueAddress *pAddress)
	Update state of the service. More...

Public Member Functions inherited from extends< Service, IConversionSvc, IAddressCreator >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

Gaudi::StateMachine::State	FSMState () const override

Gaudi::StateMachine::State	targetFSMState () const override

StatusCode	reinitialize () override

StatusCode	restart () override

StatusCode	sysInitialize () override
	Initialize Service. More...

StatusCode	sysStart () override
	Initialize Service. More...

StatusCode	sysStop () override
	Initialize Service. More...

StatusCode	sysFinalize () override
	Finalize Service. More...

StatusCode	sysReinitialize () override
	Re-initialize the Service. More...

StatusCode	sysRestart () override
	Re-initialize the Service. More...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...

template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, TYPE &value, const std::string &doc="none")
	Helper to wrap a regular data member and use it as a regular property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p) override
	set the property form another property More...

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...

StatusCode	setProperty (const std::string &n, const std::string &v) override
	set the property from name and the value More...

StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (const std::string &name) const override
	get the property by name More...

StatusCode	getProperty (const std::string &n, std::string &v) const override
	convert the property to the string More...

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...

bool	hasProperty (const std::string &name) const override
	Return true if we have a property with the given name. More...

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

MSG::Level	outputLevel () const
	Backward compatibility function for getting the output level. More...

Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...

const SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...

MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...

MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...

MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...

MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...

MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...

MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...

MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...

MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...

Private Attributes
Gaudi::Property< std::string >	m_defFileName {this, "OutputFile", undefFileName, "default file name"}

Gaudi::Property< bool >	m_alphaIds {this, "ForceAlphaIds", false, "force alphabetic histograms/ntuple IDs"}

Gaudi::Property< bool >	m_outputEnabled {this, "OutputEnabled", true, "Flag to enable/disable the output to file."}

std::unique_ptr< TFile >	m_hfile
	Pointer to the ROOT file. More...

bool	m_prtWar = false
	Already printed a Warning. More...

Additional Inherited Members
Public Types inherited from extends< Service, IConversionSvc, IAddressCreator >
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...

Protected Member Functions inherited from ConversionSvc
virtual IConverter *	createConverter (long typ, const CLID &clid, const ICnvFactory *fac)
	Create new Converter using factory. More...

virtual StatusCode	configureConverter (long typ, const CLID &clid, IConverter *cnv)
	Configure the new converter before initialize is called. More...

virtual StatusCode	initializeConverter (long typ, const CLID &clid, IConverter *cnv)
	Initialize the new converter. More...

virtual StatusCode	activateConverter (long typ, const CLID &clid, IConverter *cnv)
	Activate the new converter after initialization. More...

virtual void	loadConverter (DataObject *pObject)
	Load converter or dictionary needed by the converter. More...

virtual SmartIF< IAddressCreator > &	addressCreator ()
	Retrieve address creation interface. More...

StatusCode	makeCall (int typ, bool ignore_add, bool ignore_obj, bool update, IOpaqueAddress &pAddress, DataObject &pObject)

Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
Gaudi::Details::PropertyBase *	property (const std::string &name) const

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from ConversionSvc
SmartIF< IDataProviderSvc >	m_dataSvc
	Pointer to data provider service. More...

SmartIF< IAddressCreator >	m_addressCreator
	Pointer to the address creation service interface. More...

SmartIF< IConversionSvc >	m_cnvSvc
	Pointer to the IConversionSvc interface of this. More...

long	m_type
	Conversion service type. More...

std::vector< WorkerEntry >	m_workers
	List of conversion workers. More...

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...

Gaudi::Property< int >	m_outputLevel {this, "OutputLevel", MSG::NIL, "output level"}

Gaudi::Property< bool >	m_auditInit {this, "AuditServices", false, "[[deprecated]] unused"}

Gaudi::Property< bool >	m_auditorInitialize {this, "AuditInitialize", false, "trigger auditor on initialize()"}

Gaudi::Property< bool >	m_auditorStart {this, "AuditStart", false, "trigger auditor on start()"}

Gaudi::Property< bool >	m_auditorStop {this, "AuditStop", false, "trigger auditor on stop()"}

Gaudi::Property< bool >	m_auditorFinalize {this, "AuditFinalize", false, "trigger auditor on finalize()"}

Gaudi::Property< bool >	m_auditorReinitialize {this, "AuditReinitialize", false, "trigger auditor on reinitialize()"}

Gaudi::Property< bool >	m_auditorRestart {this, "AuditRestart", false, "trigger auditor on restart()"}

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service. More...

Detailed Description

Persistency service - to store histograms in ROOT format.

Author: Charles Leggett

Definition at line 19 of file PersSvc.h.

Constructor & Destructor Documentation

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

inline

Standard constructor.

Definition at line 32 of file PersSvc.h.

32 : ConversionSvc( name, svc, ROOT_StorageType ) {}

ConversionSvc::ConversionSvc

ConversionSvc(const std::string &name, ISvcLocator *svc, long type)

Standard Constructor.

Definition: ConversionSvc.cpp:347

ROOT_StorageType

const long ROOT_StorageType

Definition: ClassID.h:52

Member Function Documentation

StatusCode RootHistCnv::PersSvc::createRep	(	DataObject *	pObject,
		IOpaqueAddress *&	refpAddress
	)

override

Convert a collection of transient data objects into another representation.

Definition at line 75 of file PersSvc.cpp.

 {
   // There are objects in the HDS to be stored
   if ( m_outputEnabled && undefFileName != m_defFileName ) {
     SmartDataPtr<DataObject> top( dataProvider(), stat_dir );
     if ( top ) {
       IRegistry* pReg = top->registry();
       if ( pReg ) {
         if ( top.ptr() == pObject ) {
           TDirectory* pDir = m_hfile.get();
           refpAddress      = new RootObjAddress( repSvcType(), CLID_DataObject, stat_dir, m_defFileName.value(),
                                             long( pDir ), long( 0 ) );
           return StatusCode::SUCCESS;
         } else {
           StatusCode sc = ConversionSvc::createRep( pObject, refpAddress );
           if ( sc.isFailure() ) {
             error() << "Error while creating persistent Histogram:" << pReg->identifier() << endmsg;
           }
           return sc;
         }
       }
     }
     error() << "Internal error while creating Histogram persistent representations" << endmsg;
     return StatusCode::FAILURE;
   } else {
     if ( m_outputEnabled && !m_prtWar ) {
       m_prtWar = true;
       warning() << "no ROOT output file name, "
                 << "Histograms cannot be persistified" << endmsg;
     }
   }
   return StatusCode::SUCCESS;
 }

StatusCode RootHistCnv::PersSvc::finalize ( )

override

Finalise the service.

Definition at line 60 of file PersSvc.cpp.

 {
   // Close ROOT only if the output file name is defined
   debug() << "RootHistCnv::PersSvc::finalize()" << endmsg;
   if ( m_outputEnabled ) {
     if ( undefFileName != m_defFileName ) {
       m_hfile->Write( "", TObject::kOverwrite );
       m_hfile->Close();
     }
   }
   return ConversionSvc::finalize();
 }

StatusCode RootHistCnv::PersSvc::initialize ( )

override

Initialise the service.

Definition at line 33 of file PersSvc.cpp.

 {
 
   StatusCode status = ConversionSvc::initialize();
   if ( status.isFailure() ) return status;
 
   // Get my properties from the JobOptionsSvc
   if ( setProperties().isFailure() ) {
     error() << "Could not set my properties" << endmsg;
     return StatusCode::FAILURE;
   }
   if ( m_outputEnabled ) {
     // Initialize ROOT if output file name is defined
     if ( undefFileName != m_defFileName ) {
       m_hfile.reset( TFile::Open( m_defFileName.value().c_str(), "RECREATE", "GAUDI Histograms" ) );
     } else {
       m_hfile.reset();
     }
     info() << "Writing ROOT histograms to: " << m_defFileName.value() << endmsg;
   } else {
     info() << "Writing ROOT histograms disabled." << endmsg;
   }
   return StatusCode( StatusCode::SUCCESS, true );
 }

Member Data Documentation

Gaudi::Property<bool> RootHistCnv::PersSvc::m_alphaIds {this, "ForceAlphaIds", false, "force alphabetic histograms/ntuple IDs"}

private

Definition at line 37 of file PersSvc.h.

Gaudi::Property<std::string> RootHistCnv::PersSvc::m_defFileName {this, "OutputFile", undefFileName, "default file name"}

private

Definition at line 36 of file PersSvc.h.

std::unique_ptr<TFile> RootHistCnv::PersSvc::m_hfile

private

Pointer to the ROOT file.

Definition at line 40 of file PersSvc.h.

Gaudi::Property<bool> RootHistCnv::PersSvc::m_outputEnabled {this, "OutputEnabled", true, "Flag to enable/disable the output to file."}

private

Definition at line 38 of file PersSvc.h.

bool RootHistCnv::PersSvc::m_prtWar = false

private

Already printed a Warning.

Definition at line 41 of file PersSvc.h.

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

RootHistCnv/src/PersSvc.h
RootHistCnv/src/PersSvc.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation