#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/Histograming/Sink/Base.h>

Inheritance diagram for Gaudi::Histograming::Sink::Base:

[legend]

Collaboration diagram for Gaudi::Histograming::Sink::Base:

[legend]

Public Types
using	HistoIdentification = std::pair< std::string, int >

using	HistoHandler = std::function< void(TFile &file, std::string, std::string, nlohmann::json const &)>

using	HistoRegistry = std::map< HistoIdentification, HistoHandler >

using	HistoBinIdentification = std::type_index

using	HistoBinHandler = std::function< void(TFile &file, std::string, std::string, Monitoring::Hub::Entity const &)>

using	HistoBinRegistry = std::map< HistoBinIdentification, HistoBinHandler >

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 Member Functions
	Base (std::string name, ISvcLocator *svcloc)

StatusCode	initialize () override

void	flush (bool) override
	pure virtual method to be defined by children and responsible for flushing current data of the Sink. More...

void	registerHandler (HistoBinIdentification const &id, HistoBinHandler const &func)

void	registerHandler (HistoIdentification const &id, HistoHandler const &func)

Public Member Functions inherited from Gaudi::Monitoring::BaseSink
StatusCode	initialize () override

void	registerEntity (Hub::Entity ent) override
	handles registration of a new entity More...

void	removeEntity (Hub::Entity const &ent) override
	handles removal of an entity More...

StatusCode	start () override

StatusCode	stop () override

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor 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...

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 >
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, std::string toolTypeAndName, bool createIf=true)
	Declare used tool. More...

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. 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 std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

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

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

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

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

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

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

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

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

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

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

StatusCode	getProperty (std::string_view 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 (std::string_view name) const override
	Return true if we have a property with the given name. More...

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

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

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

Public Member Functions inherited from Gaudi::Monitoring::Hub::Sink
virtual	~Sink ()=default

Private Attributes
HistoBinRegistry	m_binRegistry {}
	map of supported type and the way to handle them More...

HistoRegistry	m_registry {}
	map of supported type and the way to handle them More...

Gaudi::Property< std::string >	m_fileName

Additional Inherited Members
Protected Member Functions inherited from Gaudi::Monitoring::BaseSink
template<typename Callable >
void	applyToAllEntities (Callable func) const
	applies a callable to all monitoring entities More...

template<typename Callable >
void	applyToAllSortedEntities (Callable func) const
	applies a callable to all monitoring entities ordered by component the callable will be called once per entity and should have a signature ( std::string const&, std::string const&, nlohmann::json const& ) More...

bool	wanted (std::string const &name, std::vector< std::string > const &searchNames)
	deciding whether a given name matches the list of regexps given empty list means everything matches More...

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

	~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 > >
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 Gaudi::Monitoring::BaseSink
std::set< Gaudi::Monitoring::Hub::Entity, EntityOrder >	m_monitoringEntities

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

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

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

std::thread	m_flushThread
	Handling of regular flushes, if requested. More...

std::promise< void >	m_flushThreadStop

Gaudi::Property< float >	m_autoFlushPeriod

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" }
	flag indicating whether ToolHandle tools have been added to m_tools More...

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

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

Definition at line 28 of file Base.h.

Member Typedef Documentation

◆ HistoBinHandler

using Gaudi::Histograming::Sink::Base::HistoBinHandler = std::function<void( TFile& file, std::string, std::string, Monitoring::Hub::Entity const& )>

Definition at line 35 of file Base.h.

◆ HistoBinIdentification

using Gaudi::Histograming::Sink::Base::HistoBinIdentification = std::type_index

Definition at line 34 of file Base.h.

◆ HistoBinRegistry

using Gaudi::Histograming::Sink::Base::HistoBinRegistry = std::map<HistoBinIdentification, HistoBinHandler>

Definition at line 37 of file Base.h.

◆ HistoHandler

using Gaudi::Histograming::Sink::Base::HistoHandler = std::function<void( TFile& file, std::string, std::string, nlohmann::json const& )>

Definition at line 31 of file Base.h.

◆ HistoIdentification

using Gaudi::Histograming::Sink::Base::HistoIdentification = std::pair<std::string, int>

Definition at line 30 of file Base.h.

◆ HistoRegistry

using Gaudi::Histograming::Sink::Base::HistoRegistry = std::map<HistoIdentification, HistoHandler>

Definition at line 32 of file Base.h.

Constructor & Destructor Documentation

◆ Base()

Gaudi::Histograming::Sink::Base::Base	(	std::string	name,
		ISvcLocator *	svcloc
	)

inline

Definition at line 39 of file Base.h.

                                                 : Monitoring::BaseSink( name, svcloc ) {
       // only deal with histograms
       setProperty( "TypesToSave", std::vector<std::string>{ "histogram:.*" } )
           .orThrow( "Unable to set typesToSaveProperty", "Histograming::Sink::Base" );
     }

Member Function Documentation

◆ flush()

void Gaudi::Histograming::Sink::Base::flush ( bool isStop )

inlineoverridevirtual

pure virtual method to be defined by children and responsible for flushing current data of the Sink.

This method is called every m_autoFlushPeriod (if not set to 0) and in the stop method by default

Parameters

isStop allows to know which case we are in

Implements Gaudi::Monitoring::BaseSink.

Definition at line 54 of file Base.h.

                                 {
       // File is updated so that multiple sinks can write to the same file
       // As we are in stop, there is no multithreading so it is safe
       // As we dropped the file at initialization, no old data from a previous
       // run may be mixed with new one
       TFile histoFile( m_fileName.value().c_str(), "UPDATE" );
       // get all entities, sorted by component and name
       applyToAllSortedEntities( [this, &histoFile]( std::string const& component, std::string const& name,
                                                     Monitoring::Hub::Entity const& ent ) {
         // try first a dedicated flush, bypassing json (more efficient)
         auto typeIndex = ent.typeIndex();
         auto binSaver  = m_binRegistry.find( typeIndex );
         if ( binSaver != m_binRegistry.end() ) {
           binSaver->second( histoFile, component, name, ent );
           return;
         }
         // no fast track, let's use json intermediate format
         nlohmann::json j    = ent;
         auto           dim  = j.at( "dimension" ).template get<unsigned int>();
         auto           type = j.at( "type" ).template get<std::string>();
         // cut type after last ':' if there is one. The rest is precision parameter that we do not need here
         // as ROOT anyway treats everything as doubles in histograms
         type       = type.substr( 0, type.find_last_of( ':' ) );
         auto saver = m_registry.find( { type, dim } );
         if ( saver != m_registry.end() ) ( saver->second )( histoFile, component, name, j );
       } );
       info() << "Completed update of ROOT histograms in: " << m_fileName.value() << endmsg;
     }

◆ initialize()

StatusCode Gaudi::Histograming::Sink::Base::initialize ( )

inlineoverride

Definition at line 45 of file Base.h.

                                      {
       return BaseSink::initialize().andThen( [&] {
         // empty output file if it exists, as we will update it at the end
         // This allows multiple Sinks to write to the same ROOT file
         std::filesystem::remove( m_fileName.value() );
         info() << "Writing ROOT histograms to: " << m_fileName.value() << endmsg;
       } );
     }

◆ registerHandler() [1/2]

void Gaudi::Histograming::Sink::Base::registerHandler	(	HistoBinIdentification const &	id,
		HistoBinHandler const &	func
	)

inline

Definition at line 83 of file Base.h.

                                                                                           {
       m_binRegistry.emplace( std::piecewise_construct, std::make_tuple( id ), std::make_tuple( func ) );
     }

◆ registerHandler() [2/2]

void Gaudi::Histograming::Sink::Base::registerHandler	(	HistoIdentification const &	id,
		HistoHandler const &	func
	)

inline

Definition at line 87 of file Base.h.

                                                                                     {
       m_registry.emplace( std::piecewise_construct, std::make_tuple( id ), std::make_tuple( func ) );
     }

Member Data Documentation

◆ m_binRegistry

HistoBinRegistry Gaudi::Histograming::Sink::Base::m_binRegistry {}

private

map of supported type and the way to handle them

Definition at line 93 of file Base.h.

◆ m_fileName

Gaudi::Property<std::string> Gaudi::Histograming::Sink::Base::m_fileName

private

Initial value:

{ this, "FileName", "testHisto.root",

"Name of file where to save histograms" }

Definition at line 97 of file Base.h.

◆ m_registry

HistoRegistry Gaudi::Histograming::Sink::Base::m_registry {}

private

map of supported type and the way to handle them

Definition at line 95 of file Base.h.

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

GaudiKernel/include/Gaudi/Histograming/Sink/Base.h

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ HistoBinHandler

◆ HistoBinIdentification

◆ HistoBinRegistry

◆ HistoHandler

◆ HistoIdentification

◆ HistoRegistry

Constructor & Destructor Documentation

◆ Base()

Member Function Documentation

◆ flush()

◆ initialize()

◆ registerHandler() [1/2]

◆ registerHandler() [2/2]

Member Data Documentation

◆ m_binRegistry

◆ m_fileName

◆ m_registry