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

#include <src/PersSvc.h>

Inheritance diagram for RootHistCnv::PersSvc:

Collaboration diagram for RootHistCnv::PersSvc:

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...

	~PersSvc () override=default
	Standard destructor. More...

Public Member Functions inherited from ConversionSvc
virtual long	repSvcType () const
	Retrieve the class type of the data store the converter uses. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	ConversionSvc (const std::string &name, ISvcLocator *svc, long type)
	Standard Constructor. 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...

	~extends () override=default
	Virtual destructor. More...

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

StatusCode	configure () override

StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

StatusCode	terminate () override

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

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

StatusCode	reinitialize () override

StatusCode	restart () override

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

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

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

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

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

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

StatusCode	setProperty (const Property &p) override

StatusCode	setProperty (const std::string &s) override

StatusCode	setProperty (const std::string &n, const std::string &v) override

StatusCode	getProperty (Property *p) const override

const Property &	getProperty (const std::string &name) const override

StatusCode	getProperty (const std::string &n, std::string &v) const override

const std::vector< Property * > &	getProperties () const override

bool	hasProperty (const std::string &name) const override

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

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

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

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

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

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

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

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

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Attributes
std::string	m_defFileName
	Default file name. More...

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

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

bool	m_alphaIds
	Force alphabetic histograms/ntuple IDs. More...

bool	m_outputEnabled
	Flag to enable/disable the output to file. 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
typedef Gaudi::PluginService::Factory< IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging

Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Protected Member Functions inherited from ConversionSvc
virtual	~ConversionSvc ()
	Standard Destructor. More...

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 CommonMessaging< implements< IService, IProperty, IStateful > >
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
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...

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

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

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
	)

Standard constructor.

Definition at line 127 of file PersSvc.cpp.

 : ConversionSvc(name, svc, ROOT_StorageType) {
   declareProperty("OutputFile", m_defFileName = undefFileName);
   declareProperty("ForceAlphaIds", m_alphaIds = false);
   declareProperty("OutputEnabled", m_outputEnabled = true,
                   "Flag to enable/disable the output to file.");
 }

RootHistCnv::PersSvc::~PersSvc ( )

overridedefault

Standard destructor.

Member Function Documentation

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

overridevirtual

Convert a collection of transient data objects into another representation.

Reimplemented from ConversionSvc.

Definition at line 76 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 ( 0 != 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,
                                             long(pDir),
                                             long(0));
           return StatusCode::SUCCESS;
         }
         else    {
           StatusCode sc = ConversionSvc::createRep(pObject, refpAddress);
           if( sc.isFailure() )   {
             MsgStream log( msgSvc(), name() );
             log << MSG::ERROR
                 << "Error while creating persistent Histogram:"
                 << pReg->identifier()
                 << endmsg;
           }
           return sc;
         }
       }
     }
     MsgStream err( msgSvc(), name() );
     err << MSG::ERROR
         << "Internal error while creating Histogram persistent representations"
         << endmsg;
     return StatusCode::FAILURE;
   } else {
     if (m_outputEnabled && !m_prtWar) {
       m_prtWar = true;
       MsgStream log( msgSvc(), name() );
       log << MSG::WARNING
       << "no ROOT output file name, "
       << "Histograms cannot be persistified" << endmsg;
     }
   }
   return StatusCode::SUCCESS;
 }

StatusCode RootHistCnv::PersSvc::finalize ( )

overridevirtual

Finalise the service.

Reimplemented from ConversionSvc.

Definition at line 62 of file PersSvc.cpp.

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

StatusCode RootHistCnv::PersSvc::initialize ( )

overridevirtual

Initialise the service.

Reimplemented from ConversionSvc.

Definition at line 31 of file PersSvc.cpp.

 {
   MsgStream log( msgSvc(), name() );
 
   StatusCode status = ConversionSvc::initialize();
   if( status.isFailure() ) return status;
 
   // Get my properties from the JobOptionsSvc
   if (setProperties().isFailure()) {
     log << MSG::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.c_str(),"RECREATE","GAUDI Histograms") );
     } else {
       m_hfile.reset();
     }
     log << MSG::INFO << "Writing ROOT histograms to: " << m_defFileName
         << endmsg;
   }
   else {
     log << MSG::INFO << "Writing ROOT histograms disabled." << endmsg;
   }
   return StatusCode(StatusCode::SUCCESS,true);
 }

Member Data Documentation

bool RootHistCnv::PersSvc::m_alphaIds

private

Force alphabetic histograms/ntuple IDs.

Definition at line 40 of file PersSvc.h.

std::string RootHistCnv::PersSvc::m_defFileName

private

Default file name.

Definition at line 37 of file PersSvc.h.

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

private

Pointer to the ROOT file.

Definition at line 38 of file PersSvc.h.

bool RootHistCnv::PersSvc::m_outputEnabled

private

Flag to enable/disable the output to file.

Definition at line 41 of file PersSvc.h.

bool RootHistCnv::PersSvc::m_prtWar = false

private

Already printed a Warning.

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