Gaudi::Histograming::Sink::Root Struct Reference

Inheritance diagram for Gaudi::Histograming::Sink::Root:

Collaboration diagram for Gaudi::Histograming::Sink::Root:

Public Member Functions
StatusCode	initialize () override
	Base (const std::string &name, ISvcLocator *svcloc)
Public Member Functions inherited from Gaudi::Histograming::Sink::Base
	Base (const 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.
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
void	removeEntity (Hub::Entity const &ent) override
	handles removal of an entity
StatusCode	start () override
StatusCode	stop () override
	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor.
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 *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property.
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 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 &	operator= (const PropertyHolder &)=delete
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)
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 Gaudi::Monitoring::Hub::Sink
virtual	~Sink ()=default

Additional Inherited Members
Public Types inherited from Gaudi::Histograming::Sink::Base
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
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
	Typedef used to refer to this class from derived classes, as in.
Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class
Protected Member Functions inherited from Gaudi::Monitoring::BaseSink
template<typename Callable>
void	applyToAllEntities (Callable func) const
	applies a callable to all monitoring entities
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& )
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
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 override final
	Set up local caches.
MSG::Level	resetMessaging ()
	Reinitialize internal states.
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream.
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.
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.
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

Definition at line 68 of file RootHistogramSink.cpp.

Member Function Documentation

Base()

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

inline

Definition at line 43 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" );
    }

initialize()

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

inlineoverride

Definition at line 71 of file RootHistogramSink.cpp.

                                     {
      return Base::initialize().andThen( [&] {
        for ( auto& [id, func] : binRegistry ) { registerHandler( id, func ); }
        for ( auto& [id, func] : registry ) { registerHandler( id, func ); }
      } );
    }

---

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

• GaudiCommonSvc/src/HistogramPersistencySvc/RootHistogramSink.cpp