The Gaudi Framework  master (594c33fa)
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 (std::string name, ISvcLocator *svcloc)
 
- Public Member Functions inherited from Gaudi::Histograming::Sink::Base
 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::stringname () 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::PropertyBasedeclareProperty (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::PropertyBasedeclareProperty (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::PropertyBasedeclareProperty (Gaudi::Details::PropertyBase &prop)
 Declare a property. More...
 
Gaudi::Details::PropertyBasedeclareProperty (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::PropertyBasedeclareProperty (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::PropertyBasedeclareRemoteProperty (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::PropertyBasegetProperty (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::PropertyBaseproperty (std::string_view name) const
 \fixme property and bindPropertiesTo should be protected More...
 
void bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)
 
 PropertyHolder (const PropertyHolder &)=delete
 
PropertyHolderoperator= (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
 

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 = 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
 
- 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, EntityOrderm_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< IAuditorSvcm_pAuditorSvc
 Auditor Service
More...
 

Detailed Description

Definition at line 67 of file RootHistogramSink.cpp.

Member Function Documentation

◆ Base()

Gaudi::Histograming::Sink::Base::Base
inline

Definition at line 39 of file Base.h.

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

◆ initialize()

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

Definition at line 70 of file RootHistogramSink.cpp.

70  {
71  return Base::initialize().andThen( [&] {
72  for ( auto& [id, func] : binRegistry ) { registerHandler( id, func ); }
73  for ( auto& [id, func] : registry ) { registerHandler( id, func ); }
74  } );
75  }

The documentation for this struct was generated from the following file:
StatusCode::andThen
StatusCode andThen(F &&f, ARGS &&... args) const
Chain code blocks making the execution conditional a success result.
Definition: StatusCode.h:163
std::vector< std::string >
PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >::setProperty
StatusCode setProperty(const Gaudi::Details::PropertyBase &p)
Set the property from a property.
Definition: IProperty.h:39
Gaudi::Histograming::Sink::Base::initialize
StatusCode initialize() override
Definition: Base.h:45
GaudiPluginService.cpluginsvc.registry
def registry()
Definition: cpluginsvc.py:83
Service::name
const std::string & name() const override
Retrieve name of the service
Definition: Service.cpp:332
Gaudi::Histograming::Sink::Base::registerHandler
void registerHandler(HistoBinIdentification const &id, HistoBinHandler const &func)
Definition: Base.h:83
GaudiPluginService.cpluginsvc.func
func
Definition: cpluginsvc.py:235