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
virtual StatusCode	initialize ()
	Initialise the service. More...

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

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

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

virtual	~PersSvc ()
	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 extends2< Service, IConversionSvc, IAddressCreator >
	extends2 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments. More...

	extends2 (A1 a1, A2 a2)
	Templated constructor with 2 arguments. More...

	extends2 (A1 a1)
	Templated constructor with 1 argument. More...

	extends2 ()
	Default constructor. More...

virtual void *	i_cast (const InterfaceID &tid) const
	Implementation of IInterface::i_cast. More...

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

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

virtual	~extends2 ()
	Virtual destructor. More...

Public Member Functions inherited from Service
virtual unsigned long	release ()
	Release Interface instance. More...

virtual const std::string &	name () const
	Retrieve name of the service. More...

virtual StatusCode	configure ()
	Configuration (from OFFLINE to CONFIGURED). More...

virtual StatusCode	start ()
	Start (from INITIALIZED to RUNNING). More...

virtual StatusCode	stop ()
	Stop (from RUNNING to INITIALIZED). More...

virtual StatusCode	terminate ()
	Initialization (from CONFIGURED to OFFLINE). More...

virtual Gaudi::StateMachine::State	FSMState () const
	Get the current state. More...

virtual Gaudi::StateMachine::State	targetFSMState () const
	When we are in the middle of a transition, get the state where the transition is leading us. More...

virtual StatusCode	reinitialize ()
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...

virtual StatusCode	restart ()
	Initialization (from RUNNING to RUNNING, via INITIALIZED). More...

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

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

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

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

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

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

virtual StatusCode	setProperty (const Property &p)
	Set the property by property. More...

virtual StatusCode	setProperty (const std::string &s)
	Set the property by string. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Set the property by std::string. More...

virtual StatusCode	getProperty (Property *p) const
	Get the property by property. More...

virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Get the property by std::string. More...

virtual const std::vector < Property * > &	getProperties () const
	Get list of properties. More...

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

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

SmartIF< ISvcLocator > &	serviceLocator () const
	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<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...

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

Public Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
	CommonMessaging (const A1 &a1, const A2 &a2, const A3 &a3)
	Templated constructor with 3 arguments. More...

	CommonMessaging (const A1 &a1, const A2 &a2)
	Templated constructor with 2 arguments. More...

	CommonMessaging (const A1 &a1)
	Templated constructor with 1 argument. More...

	CommonMessaging ()
	Default constructor. More...

virtual	~CommonMessaging ()
	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...

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

Public Member Functions inherited from extend_interfaces3< IService, IProperty, IStateful >
virtual	~extend_interfaces3 ()
	Virtual destructor. More...

Public Member Functions inherited from IService
	DeclareInterfaceID (IService, 3, 0)
	InterfaceID. More...

virtual	~IService ()
	virtual destructor More...

Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...

virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...

Public Member Functions inherited from IInterface
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual unsigned long	refCount () const =0
	Current reference count. More...

virtual	~IInterface ()
	Virtual destructor. More...

Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 0)
	InterfaceID. More...

Public Member Functions inherited from IStateful
	DeclareInterfaceID (IStateful, 1, 0)
	InterfaceID. More...

virtual	~IStateful ()

Public Member Functions inherited from extend_interfaces2< IConversionSvc, IAddressCreator >
virtual	~extend_interfaces2 ()
	Virtual destructor. More...

Public Member Functions inherited from IConversionSvc
	DeclareInterfaceID (IConversionSvc, 4, 0)
	InterfaceID. More...

virtual	~IConversionSvc ()
	Virtual destructor. More...

Public Member Functions inherited from IConverter
	DeclareInterfaceID (IConverter, 3, 0)
	InterfaceID. More...

virtual	~IConverter ()
	Virtual destructor. More...

Public Member Functions inherited from IAddressCreator
	DeclareInterfaceID (IAddressCreator, 3, 0)
	InterfaceID. More...

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

TFile *	m_hfile
	Pointer to the ROOT file. More...

bool	m_prtWar
	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 ConversionSvc
typedef std::vector< WorkerEntry >	Workers

Public Types inherited from extends2< Service, IConversionSvc, IAddressCreator >
typedef extends2	base_class
	Typedef to this class. More...

typedef extend_interfaces2 < IConversionSvc, IAddressCreator >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from Service
typedef Gaudi::PluginService::Factory2 < IService , const std::string &, ISvcLocator >	Factory

Public Types inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
typedef CommonMessaging	base_class

Public Types inherited from implements3< IService, IProperty, IStateful >
typedef implements3	base_class
	Typedef to this class. More...

typedef extend_interfaces3 < IService, IProperty, IStateful >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from extend_interfaces3< IService, IProperty, IStateful >
typedef mpl::fold< typename IService::iid::iids::type, typename mpl::fold< typename IProperty::iid::iids::type, typename IStateful::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

typedef Gaudi::InterfaceId < IInterface, 0, 0 >	iid
	Interface ID. More...

typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...

Public Types inherited from extend_interfaces2< IConversionSvc, IAddressCreator >
typedef mpl::fold< typename IConversionSvc::iid::iids::type, typename IAddressCreator::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IConversionSvc
enum	Status { CONVERSIONSVC_NO_ERROR = ICONVERSIONSVC_LAST_ERROR+1, NO_CONVERTER }
	Status code definitions. More...

Public Types inherited from IConverter
enum	Status { INVALID_ADDRESS = IInterface::LAST_ERROR+1, INVALID_OBJECT, NO_MEMORY, BAD_STORAGE_TYPE, NO_SOURCE_OBJECT, ICONVERSIONSVC_LAST_ERROR }
	Status code. More...

Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. 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
virtual	~Service ()
	Standard Destructor. More...

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

Protected Member Functions inherited from CommonMessaging< implements3< 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...

Workers *	m_workers
	List of conversion workers. More...

Protected Attributes inherited from Service
IntegerProperty	m_outputLevel
	Service output level. More...

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

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

Protected Attributes inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
SmartIF< IMessageSvc >	m_msgsvc
	Pointer to the message service;. More...

std::auto_ptr< MsgStream >	m_msgStream
	The predefined message stream. More...

bool	m_streamWithService
	Flag to create a new MsgStream if it was created without the message service. More...

Detailed Description

Persistency service - to store histograms in ROOT format.

Author: Charles Leggett

Definition at line 20 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), m_hfile(0), m_prtWar(false) {
   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 ( )

virtual

Standard destructor.

Definition at line 137 of file PersSvc.cpp.

 {
   if ( m_hfile != 0 ) {
     delete m_hfile;
     m_hfile = 0;
   }
 }

Member Function Documentation

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

virtual

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;
           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 ( )

virtual

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

virtual

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 = TFile::Open(m_defFileName.c_str(),"RECREATE","GAUDI Histograms");
     } else {
       m_hfile = 0;
     }
     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 41 of file PersSvc.h.

std::string RootHistCnv::PersSvc::m_defFileName

private

Default file name.

Definition at line 38 of file PersSvc.h.

TFile* RootHistCnv::PersSvc::m_hfile

private

Pointer to the ROOT file.

Definition at line 39 of file PersSvc.h.

bool RootHistCnv::PersSvc::m_outputEnabled

private

Flag to enable/disable the output to file.

Definition at line 42 of file PersSvc.h.

bool RootHistCnv::PersSvc::m_prtWar

private

Already printed a Warning.

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