HistogramPersistencySvc class implementation definition. More...

#include </builds/gaudi/Gaudi/GaudiCommonSvc/src/HistogramPersistencySvc/HistogramPersistencySvc.h>

Inheritance diagram for HistogramPersistencySvc:

[legend]

Collaboration diagram for HistogramPersistencySvc:

[legend]

Public Member Functions
PersistencySvc overrides
StatusCode	initialize () override
	Initialize the service.

StatusCode	reinitialize () override
	Reinitialize the service.

StatusCode	finalize () override
	Finalize the service.

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

Public Member Functions inherited from PersistencySvc
long	repSvcType () const override
	Return default service type.

const CLID &	objType () const override
	Retrieve the class type of objects the converter produces. (DUMMY)

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

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

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

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

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

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

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

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

StatusCode	setDataProvider (IDataProviderSvc *pStore) override
	Define transient datastore.

SmartIF< IDataProviderSvc > &	dataProvider () const override
	Access reference to transient datastore.

StatusCode	setConversionSvc (IConversionSvc *svc) override
	Set conversion service the converter is connected to.

SmartIF< IConversionSvc > &	conversionSvc () const override
	Get conversion service the converter is connected to.

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

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

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

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

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

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

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

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

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

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

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

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

StatusCode	addCnvService (IConversionSvc *service) override
	Add a new Service.

StatusCode	removeCnvService (long type) override
	Remove a Service.

StatusCode	setDefaultCnvService (long type) override
	Set default service type.

StatusCode	getService (long service_type, IConversionSvc *&refpSvc) override
	Retrieve conversion service identified by technology.

StatusCode	getService (const std::string &service_type, IConversionSvc *&refpSvc) override
	Retrieve conversion service identified by technology.

StatusCode	initialize () override
	Initialize the service.

StatusCode	finalize () override
	stop the service.

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

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

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

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

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.

StatusCode	sysStart () override
	Initialize Service.

StatusCode	sysStop () override
	Initialize Service.

StatusCode	sysFinalize () override
	Finalize Service.

StatusCode	sysReinitialize () override
	Re-initialize the Service.

StatusCode	sysRestart () override
	Re-initialize the Service.

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

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

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

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T>
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

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

template<class T>
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T>
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

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

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

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

	PropertyHolder ()=default

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

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.

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.

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

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name

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

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property.

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals.

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string.

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

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation

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

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

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

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

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

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	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)

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

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

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

MsgStream &	msgStream () const
	Return an uninitialized MsgStream.

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

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

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

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

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

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

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

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

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

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

: Object implementation
typedef std::set< std::string >	Set
	for report: unconverted histograms

Gaudi::Property< std::string >	m_histPersName { this, "HistogramPersistency", "", "name of the Hist Pers type" }

Gaudi::Property< std::string >	m_outputFile { this, "OutputFile", "", "name of the output file" }

Gaudi::Property< std::vector< std::string > >	m_convert

Gaudi::Property< std::vector< std::string > >	m_exclude

Gaudi::Property< bool >	m_warnings { this, "Warnings", true, "Set this property to false to suppress warning messages" }

Set	m_converted
	for the final report: the list of converted histograms

Set	m_excluded
	for the final report: the list of excluded histograms

	HistogramPersistencySvc (const std::string &name, ISvcLocator *svc)
	Standard Constructor.

Additional Inherited Members
Public Types inherited from extends< Service, IConversionSvc, IPersistencySvc, IAddressCreator >
using	base_class
	Typedef to this class.

using	extend_interfaces_base
	Typedef to the base of this class.

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
	Typedef used to refer to this class from derived classes, as in.

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

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...

Protected Types inherited from PersistencySvc
typedef std::map< long, ServiceEntry >	Services

SmartIF< IConversionSvc > &	service (const std::string &nam)
	Retrieve conversion service by name.

SmartIF< IConversionSvc > &	service (long service_type)
	Retrieve conversion service from list.

SmartIF< IAddressCreator > &	addressCreator (long service_type)
	Retrieve address creator from list.

void	encodeAddrHdr (long service_type, const CLID &clid, std::string &address) const
	Retrieve string from storage type and clid.

void	decodeAddrHdr (const std::string &address, long &service_type, CLID &clid, std::string &address_trailer) const
	Retrieve storage type and clid from address header of string.

StatusCode	makeCall (int typ, IOpaqueAddress &pAddress, DataObject &pObject)
	Implementation helper.

bool	enable (bool value)
	Set enabled flag.

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

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

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

MSG::Level	resetMessaging ()
	Reinitialize internal states.

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

long	m_cnvDefType = TEST_StorageType
	Default service type.

SmartIF< IDataProviderSvc >	m_dataSvc
	Pointer to data provider service.

Services	m_cnvServices
	List of conversion workers.

std::recursive_mutex	m_servicesMutex
	Mutex to protect accesses to m_cnvServices.

SmartIF< IConversionSvc >	m_cnvDefault
	Default output service.

Gaudi::Property< std::vector< std::string > >	m_svcNames

bool	m_enable = true
	Flag to indicate that the service is enabled.

SmartIF< IAddressCreator >	m_addrCreator
	Pointer to the IAddressCreator interface of this, for addressCreator().

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

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

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools

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

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service.

Detailed Description

HistogramPersistencySvc class implementation definition.

System: The LHCb Offline System

Package: HistogramPersistencySvc

Dependencies:

PersistencySvc definition: "Kernel/Interfaces/PersistencySvc.h"

History:

+---------+----------------------------------------------+---------+
|    Date |                 Comment                      | Who     |
+---------+----------------------------------------------+---------+
| 3/11/98 | Initial version                              | M.Frank |
+---------+----------------------------------------------+---------+

Author: Markus Frank

Version: 1.0

Definition at line 56 of file HistogramPersistencySvc.h.

Member Typedef Documentation

◆ Set

typedef std::set<std::string> HistogramPersistencySvc::Set

for report: unconverted histograms

Definition at line 79 of file HistogramPersistencySvc.h.

Constructor & Destructor Documentation

◆ HistogramPersistencySvc()

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

Standard Constructor.

Definition at line 212 of file HistogramPersistencySvc.cpp.

    : PersistencySvc( name, svc ) {
  // bypass update handler
  m_svcNames.value() = std::vector<std::string>{ { "RootHistSvc" } };
}

Member Function Documentation

◆ createRep()

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

override

Implementation of IConverter: Convert the transient object to the requested representation.

Definition at line 180 of file HistogramPersistencySvc.cpp.

                                                                                           {
  // enable the conversion
  enable( true );
  // conversion is possible ?
  if ( m_histPersName == "NONE" ) {
    enable( false );
    return PersistencySvc::createRep( pObj, refpAddr ); // RETURN
  }
  // histogram ?
  if ( dynamic_cast<AIDA::IBaseHistogram*>( pObj ) ) {
 
    auto match_pObj = [&]( const std::string& s ) { return match( pObj, s ); };
    // Empty ConvertHistos property means convert all
    bool select = ( m_convert.empty() || std::any_of( m_convert.begin(), m_convert.end(), match_pObj ) ) &&
                  std::none_of( m_exclude.begin(), m_exclude.end(), match_pObj );
    //
    enable( select );
    //
    const auto& path = oname( pObj );
    //
    if ( !select ) {
      m_excluded.insert( path );
    } else {
      m_converted.insert( path );
    }
  }
  //
  return PersistencySvc::createRep( pObj, refpAddr ); // RETURN
}

◆ finalize()

StatusCode HistogramPersistencySvc::finalize ( )

override

Finalize the service.

Definition at line 67 of file HistogramPersistencySvc.cpp.

                                             {
  //
  if ( !( m_convert.empty() && m_exclude.empty() ) ) { // print message if any of the two properties is used
    info() << "Histograms Converted/Excluded: " << m_converted.size() << "/" << m_excluded.size() << endmsg;
  }
  if ( msgLevel( MSG::DEBUG ) ) {
    if ( !m_excluded.empty() ) {
      auto& log = debug();
      log << "Excluded  Histos : #" << m_excluded.size();
      for ( const auto& item : m_excluded ) { log << std::endl << "  '" << item << "'"; }
      log << endmsg;
    }
    //
    if ( !m_converted.empty() ) {
      auto& log = debug();
      log << "Converted Histos : #" << m_converted.size();
      for ( const auto& item : m_converted ) { log << std::endl << "  '" << item << "'"; }
      log << endmsg;
    }
  }
  return PersistencySvc::finalize();
}

◆ initialize()

StatusCode HistogramPersistencySvc::initialize ( )

override

Initialize the service.

Definition at line 92 of file HistogramPersistencySvc.cpp.

                                               {
  StatusCode status = PersistencySvc::initialize();
  return status.isSuccess() ? reinitialize() : status;
}

◆ reinitialize()

StatusCode HistogramPersistencySvc::reinitialize ( )

override

Reinitialize the service.

Definition at line 99 of file HistogramPersistencySvc.cpp.

                                                 {
  // Obtain the IProperty of the ApplicationMgr
  auto prpMgr = serviceLocator()->as<IProperty>();
  if ( !prpMgr ) {
    fatal() << "IProperty interface not found in ApplicationMgr." << endmsg;
    return StatusCode::FAILURE;
  } else {
    setProperty( prpMgr->getProperty( "HistogramPersistency" ) ).ignore();
  }
 
  // To keep backward compatibility, we set the property of conversion service
  // into JobOptions catalogue
  if ( !m_outputFile.empty() ) {
    auto&             opts       = serviceLocator()->getOptsSvc();
    const std::string outputFile = '"' + m_outputFile + '"';
    if ( m_histPersName == "ROOT" ) {
      opts.set( "RootHistSvc.OutputFile", outputFile );
    } else if ( m_histPersName == "HBOOK" ) {
      opts.set( "HbookHistSvc.OutputFile", outputFile );
    }
  }
 
  // Load the Histogram persistency service that's required as default
  setConversionSvc( nullptr ).ignore();
  if ( m_histPersName == "ROOT" ) {
    setConversionSvc( service( "RootHistSvc" ) ).ignore();
    if ( !conversionSvc() ) { return StatusCode::FAILURE; }
    enable( true );
  } else if ( m_histPersName == "HBOOK" ) {
    setConversionSvc( service( "HbookHistSvc" ) ).ignore();
    if ( !conversionSvc() ) { return StatusCode::FAILURE; }
    enable( true );
  } else if ( m_histPersName == "NONE" ) {
    enable( false );
    if ( msgLevel( MSG::DEBUG ) ) debug() << "Histograms saving not required." << endmsg;
  } else {
    setConversionSvc( service( m_histPersName ) ).ignore();
    if ( !conversionSvc() ) { return StatusCode::FAILURE; }
    enable( true );
    if ( m_warnings ) { warning() << "Unknown Histogram Persistency Mechanism " << m_histPersName << endmsg; }
  }
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_convert

Gaudi::Property<std::vector<std::string> > HistogramPersistencySvc::m_convert

protected

Initial value:

{

this, "ConvertHistos", {}, "The list of patterns to be accepted for conversion" }

Definition at line 84 of file HistogramPersistencySvc.h.

84 {

85 this, "ConvertHistos", {}, "The list of patterns to be accepted for conversion" };

◆ m_converted

Set HistogramPersistencySvc::m_converted

protected

for the final report: the list of converted histograms

Definition at line 91 of file HistogramPersistencySvc.h.

◆ m_exclude

Gaudi::Property<std::vector<std::string> > HistogramPersistencySvc::m_exclude

protected

Initial value:

{

this, "ExcludeHistos", {}, "The list of patterns to be excluded from conversion" }

Definition at line 86 of file HistogramPersistencySvc.h.

86 {

87 this, "ExcludeHistos", {}, "The list of patterns to be excluded from conversion" };

◆ m_excluded

Set HistogramPersistencySvc::m_excluded

protected

for the final report: the list of excluded histograms

Definition at line 93 of file HistogramPersistencySvc.h.

◆ m_histPersName

Gaudi::Property<std::string> HistogramPersistencySvc::m_histPersName { this, "HistogramPersistency", "", "name of the Hist Pers type" }

protected

Definition at line 82 of file HistogramPersistencySvc.h.

82{ this, "HistogramPersistency", "", "name of the Hist Pers type" };

◆ m_outputFile

Gaudi::Property<std::string> HistogramPersistencySvc::m_outputFile { this, "OutputFile", "", "name of the output file" }

protected

Definition at line 83 of file HistogramPersistencySvc.h.

83{ this, "OutputFile", "", "name of the output file" };

◆ m_warnings

Gaudi::Property<bool> HistogramPersistencySvc::m_warnings { this, "Warnings", true, "Set this property to false to suppress warning messages" }

protected

Definition at line 88 of file HistogramPersistencySvc.h.

88{ this, "Warnings", true, "Set this property to false to suppress warning messages" };

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

GaudiCommonSvc/src/HistogramPersistencySvc/HistogramPersistencySvc.h
GaudiCommonSvc/src/HistogramPersistencySvc/HistogramPersistencySvc.cpp

Public Member Functions

: Object implementation

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Set

Constructor & Destructor Documentation

◆ HistogramPersistencySvc()

Member Function Documentation

◆ createRep()

◆ finalize()

◆ initialize()

◆ reinitialize()

Member Data Documentation

◆ m_convert

◆ m_converted

◆ m_exclude

◆ m_excluded

◆ m_histPersName

◆ m_outputFile

◆ m_warnings