SequencerTimerTool Class Reference

Implements the time measurement inside a sequencer. More...

#include <src/components/SequencerTimerTool.h>

Inheritance diagram for SequencerTimerTool:

Collaboration diagram for SequencerTimerTool:

Public Member Functions
	SequencerTimerTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...
StatusCode	initialize () override
	initialize method, to compute the normalization factor More...
StatusCode	finalize () override
	finalize method, to print the time summary table More...
int	addTimer (const std::string &name) override
	add a timer entry with the specified name More...
void	increaseIndent () override
	Increase the indentation of the name. More...
void	decreaseIndent () override
	Decrease the indentation of the name. More...
void	start (int index) override
	start the counter, i.e. More...
double	stop (int index) override
	stop the counter, return the elapsed time More...
double	lastTime (int index) override
	returns the last time More...
const std::string &	name (int index) override
	returns the name of the counter More...
int	indexByName (const std::string &name) override
	returns the index of the counter with that name, or -1 More...
bool	globalTiming () override
	returns the flag telling that global timing is wanted More...
void	saveHistograms () override
	prepares and saves the timing histograms More...
Public Member Functions inherited from GaudiHistoTool
	GaudiHistoTool ()=delete
	GaudiHistoTool (const GaudiHistoTool &)=delete
GaudiHistoTool &	operator= (const GaudiHistoTool &)=delete
Public Member Functions inherited from GaudiHistos< GaudiTool >
AIDA::IHistogram1D *	plot1D (const double value, const std::string &title, const double low, const double high, const unsigned long bins=100, const double weight=1.0) const
	fill the 1D histogram (book on demand) More...
AIDA::IHistogram1D *	plot1D (const double value, const Gaudi::Histo1DDef &hdef, const double weight=1.0) const
	fill the 1D histogram (book on demand) More...
AIDA::IHistogram1D *	plot1D (const double value, const HistoID &ID, const std::string &title, const double low, const double high, const unsigned long bins=100, const double weight=1.0) const
	fill the 1D histogram with forced ID assignment (book on demand) More...
AIDA::IHistogram1D *	plot1D (const double value, const HistoID &ID, const Gaudi::Histo1DDef &hdef, const double weight=1.0) const
	fill the 1D histogram with forced ID assignment (book on demand) More...
AIDA::IHistogram1D *	plot1D (const double value, const std::string &title, const HistoBinEdges &edges, const double weight=1.0) const
	Fill the 1D variable binning histogram (book on demand) More...
AIDA::IHistogram1D *	plot1D (const double value, const HistoID &ID, const std::string &title, const HistoBinEdges &edges, const double weight=1.0) const
	fill the 1D variable binning histogram with forced ID assignment (book on demand) More...
AIDA::IHistogram1D *	plot (const double value, const std::string &title, const double low, const double high, const unsigned long bins=100, const double weight=1.0) const
	fill the 1D histogram (book on demand) More...
AIDA::IHistogram1D *	plot (const double value, const Gaudi::Histo1DDef &hdef, const double weight=1.0) const
	fill the 1D histogram (book on demand) More...
AIDA::IHistogram1D *	plot (const double value, const HistoID &ID, const std::string &title, const double low, const double high, const unsigned long bins=100, const double weight=1.0) const
	fill the 1D histogram with forced ID assignment (book on demand) More...
AIDA::IHistogram1D *	plot (const double value, const HistoID &ID, const Gaudi::Histo1DDef &hdef, const double weight=1.0) const
	fill the 1D histogram (book on demand) More...
AIDA::IHistogram1D *	plot (const FUNCTION &func, OBJECT first, OBJECT last, const std::string &title, const double low, const double high, const unsigned long bins=100) const
	fill the 1D histogram with information from [first,last) sequence More...
AIDA::IHistogram1D *	plot (const FUNCTION &func, OBJECT first, OBJECT last, const HistoID &ID, const std::string &title, const double low, const double high, const unsigned long bins=100) const
	fill the 1D histogram with forced ID and information from [first,last) sequence More...
AIDA::IHistogram1D *	plot (const FUNCTION &func, OBJECT first, OBJECT last, const std::string &title, const double low, const double high, const unsigned long bins, const WEIGHT &weight) const
	book and fill the 1D histogram with information from [first,last) sequence with given weight More...
AIDA::IHistogram1D *	plot (const FUNCTION &func, OBJECT first, OBJECT last, const HistoID &ID, const std::string &title, const double low, const double high, const unsigned long bins, const WEIGHT &weight) const
	book and fill the 1D histogram with forced ID and information from [first,last) sequence with given weight More...
AIDA::IHistogram2D *	plot2D (const double valueX, const double valueY, const std::string &title, const double lowX, const double highX, const double lowY, const double highY, const unsigned long binsX=50, const unsigned long binsY=50, const double weight=1.0) const
	fill the 2D histogram (book on demand) More...
AIDA::IHistogram2D *	plot2D (const double valueX, const double valueY, const HistoID &ID, const std::string &title, const double lowX, const double highX, const double lowY, const double highY, const unsigned long binsX=50, const unsigned long binsY=50, const double weight=1.0) const
	fill the 2D histogram with forced ID assignment (book on demand) More...
AIDA::IHistogram2D *	plot2D (const double valueX, const double valueY, const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY, const double weight=1.0) const
	Fill the 2D variable binning histogram (book on demand) More...
AIDA::IHistogram2D *	plot2D (const double valueX, const double valueY, const HistoID &ID, const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY, const double weight=1.0) const
	fill the 2D variable histogram with forced ID assignment (book on demand) More...
AIDA::IHistogram3D *	plot3D (const double valueX, const double valueY, const double valueZ, const std::string &title, const double lowX, const double highX, const double lowY, const double highY, const double lowZ, const double highZ, const unsigned long binsX=10, const unsigned long binsY=10, const unsigned long binsZ=10, const double weight=1.0) const
	fill the 3D histogram (book on demand) More...
AIDA::IHistogram3D *	plot3D (const double valueX, const double valueY, const double valueZ, const HistoID &ID, const std::string &title, const double lowX, const double highX, const double lowY, const double highY, const double lowZ, const double highZ, const unsigned long binsX=10, const unsigned long binsY=10, const unsigned long binsZ=10, const double weight=1.0) const
	fill the 3D histogram with forced ID assignment (book on demand) More...
AIDA::IHistogram3D *	plot3D (const double valueX, const double valueY, const double valueZ, const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY, const HistoBinEdges &edgesZ, const double weight=1.0) const
	Fill the 3D variable binning histogram (book on demand) More...
AIDA::IHistogram3D *	plot3D (const double valueX, const double valueY, const double valueZ, const HistoID &ID, const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY, const HistoBinEdges &edgesZ, const double weight=1.0) const
	fill the 3D histogram with forced ID assignment (book on demand) More...
AIDA::IProfile1D *	profile1D (const double valueX, const double valueY, const std::string &title, const double lowX, const double highX, const unsigned long binsX=100, const std::string &opt="", const double lowY=-std::numeric_limits< double >::max(), const double highY=std::numeric_limits< double >::max(), const double weight=1.0) const
	fill the 1D profile histogram (book on demand) More...
AIDA::IProfile1D *	profile1D (const double valueX, const double valueY, const HistoID &ID, const std::string &title, const double lowX, const double highX, const unsigned long binsX=100, const std::string &opt="", const double lowY=-std::numeric_limits< double >::max(), const double highY=std::numeric_limits< double >::max(), const double weight=1.0) const
	fill the 1D profile histogram with forced ID assignment (book on demand) More...
AIDA::IProfile1D *	profile1D (const double valueX, const double valueY, const std::string &title, const HistoBinEdges &edges, const double weight=1.0) const
	fill the 1D variable binning profile histogram (book on demand) More...
AIDA::IProfile1D *	profile1D (const double valueX, const double valueY, const HistoID &ID, const std::string &title, const HistoBinEdges &edges, const double weight=1.0) const
	fill the 1D variable binning profile histogram with forced ID assignment (book on demand) More...
AIDA::IProfile1D *	profile1D (const std::string &title) const
	access the EXISTING 1D profile histogram by title return the pointer to existing 1D profile histogram or NULL More...
AIDA::IProfile1D *	profile1D (const HistoID &ID) const
	access the EXISTING 1D profile histogram by ID return the pointer to existing 1D profile histogram or NULL More...
AIDA::IProfile2D *	profile2D (const double valueX, const double valueY, const double valueZ, const std::string &title, const double lowX, const double highX, const double lowY, const double highY, const unsigned long binsX=50, const unsigned long binsY=50, const double weight=1.0) const
	fill the 2D profile histogram (book on demand) More...
AIDA::IProfile2D *	profile2D (const double valueX, const double valueY, const double valueZ, const HistoID &ID, const std::string &title, const double lowX, const double highX, const double lowY, const double highY, const unsigned long binsX=50, const unsigned long binsY=50, const double weight=1.0) const
	fill the 2D profile histogram with forced ID assignment (book on demand) More...
AIDA::IProfile2D *	profile2D (const double valueX, const double valueY, const double valueZ, const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY, const double weight=1.0) const
	fill the 2D variable binning profile histogram (book on demand) More...
AIDA::IProfile2D *	profile2D (const double valueX, const double valueY, const double valueZ, const HistoID &ID, const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY, const double weight=1.0) const
	fill the 2D variable binning profile histogram with forced ID assignment (book on demand) More...
AIDA::IProfile2D *	profile2D (const std::string &title) const
	access the EXISTING 2D profile histogram by title return the pointer to existing 2D profile histogram or NULL More...
AIDA::IProfile2D *	profile2D (const HistoID &ID) const
	access the EXISTING 2D profile histogram by ID return the pointer to existing 2D profile histogram or NULL More...
AIDA::IHistogram1D *	book1D (const std::string &title, const double low=0, const double high=100, const unsigned long bins=100) const
	book the 1D histogram More...
AIDA::IHistogram1D *	book1D (const HistoID &ID, const std::string &title, const double low=0, const double high=100, const unsigned long bins=100) const
	book the 1D histogram with forced ID More...
AIDA::IHistogram1D *	book1D (const std::string &title, const HistoBinEdges &edges) const
	book the 1D variable binning histogram More...
AIDA::IHistogram1D *	book1D (const HistoID &ID, const std::string &title, const HistoBinEdges &edges) const
	book the 1D variable binning histogram with given ID More...
AIDA::IHistogram1D *	book (const std::string &title, const double low=0, const double high=100, const unsigned long bins=100) const
	book the 1D histogram More...
AIDA::IHistogram1D *	book (const Gaudi::Histo1DDef &hdef) const
	book the 1D histogram More...
AIDA::IHistogram1D *	book (const HistoID &ID, const std::string &title, const double low=0, const double high=100, const unsigned long bins=100) const
	book the 1D histogram with forced ID More...
AIDA::IHistogram1D *	book (const HistoID &ID, const Gaudi::Histo1DDef &hdef) const
	book the 1D histogram with forced ID More...
AIDA::IHistogram2D *	book2D (const std::string &title, const double lowX=0, const double highX=100, const unsigned long binsX=50, const double lowY=0, const double highY=100, const unsigned long binsY=50) const
	book the 2D histogram More...
AIDA::IHistogram2D *	book2D (const HistoID &ID, const std::string &title, const double lowX=0, const double highX=100, const unsigned long binsX=50, const double lowY=0, const double highY=100, const unsigned long binsY=50) const
	book the 2D histogram with forced ID More...
AIDA::IHistogram2D *	book2D (const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY) const
	book the 2D variable binning histogram More...
AIDA::IHistogram2D *	book2D (const HistoID &ID, const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY) const
	book the 2D variable binning histogram with given ID More...
AIDA::IHistogram3D *	book3D (const std::string &title, const double lowX=0, const double highX=100, const unsigned long binsX=10, const double lowY=0, const double highY=100, const unsigned long binsY=10, const double lowZ=0, const double highZ=100, const unsigned long binsZ=10) const
	book the 3D histogram More...
AIDA::IHistogram3D *	book3D (const HistoID &ID, const std::string &title, const double lowX=0, const double highX=100, const unsigned long binsX=10, const double lowY=0, const double highY=100, const unsigned long binsY=10, const double lowZ=0, const double highZ=100, const unsigned long binsZ=10) const
	book the 3D histogram with forced ID More...
AIDA::IHistogram3D *	book3D (const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY, const HistoBinEdges &edgesZ) const
	book the 3D variable binning histogram More...
AIDA::IHistogram3D *	book3D (const HistoID &ID, const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY, const HistoBinEdges &edgesZ) const
	book the 3D variable binning histogram with given ID More...
AIDA::IProfile1D *	bookProfile1D (const std::string &title, const double low=0, const double high=100, const unsigned long bins=100, const std::string &opt="", const double lowY=-std::numeric_limits< double >::max(), const double highY=std::numeric_limits< double >::max()) const
	book the 1D profile histogram More...
AIDA::IProfile1D *	bookProfile1D (const HistoID &ID, const std::string &title, const double low=0, const double high=100, const unsigned long bins=100, const std::string &opt="", const double lowY=-std::numeric_limits< double >::max(), const double highY=std::numeric_limits< double >::max()) const
	book the 1D profile histogram More...
AIDA::IProfile1D *	bookProfile1D (const std::string &title, const HistoBinEdges &edges) const
	book the 1D profile histogram More...
AIDA::IProfile1D *	bookProfile1D (const HistoID &ID, const std::string &title, const HistoBinEdges &edges) const
	book the 1D profile histogram More...
AIDA::IProfile2D *	bookProfile2D (const std::string &title, const double lowX=0, const double highX=100, const unsigned long binsX=50, const double lowY=0, const double highY=100, const unsigned long binsY=50) const
	book the 2D profile histogram More...
AIDA::IProfile2D *	bookProfile2D (const HistoID &ID, const std::string &title, const double lowX=0, const double highX=100, const unsigned long binsX=50, const double lowY=0, const double highY=100, const unsigned long binsY=50) const
	book the 2D profile histogram with forced ID More...
AIDA::IProfile2D *	bookProfile2D (const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY) const
	book the 2D profile histogram More...
AIDA::IProfile2D *	bookProfile2D (const HistoID &ID, const std::string &title, const HistoBinEdges &edgesX, const HistoBinEdges &edgesY) const
	book the 2D profile histogram with forced ID More...
AIDA::IHistogram1D *	fill (AIDA::IHistogram1D *histo, const double value, const double weight, const std::string &title="") const
	fill the 1D histogram with the value and weight More...
AIDA::IHistogram2D *	fill (AIDA::IHistogram2D *histo, const double valueX, const double valueY, const double weight, const std::string &title="") const
	fill the 2D histogram with the value and weight More...
AIDA::IHistogram3D *	fill (AIDA::IHistogram3D *histo, const double valueX, const double valueY, const double valueZ, const double weight, const std::string &title="") const
	fill the 3D histogram with the value and weight More...
AIDA::IProfile1D *	fill (AIDA::IProfile1D *histo, const double valueX, const double valueY, const double weight, const std::string &title="") const
	fill the 1D profile histogram with the values and weight More...
AIDA::IProfile2D *	fill (AIDA::IProfile2D *histo, const double valueX, const double valueY, const double valueZ, const double weight, const std::string &title="") const
	fill the 2D profile histogram with the values and weight More...
AIDA::IHistogram1D *	histo1D (const std::string &title) const
	access the EXISTING 1D histogram by title return the pointer to existing 1D histogram or NULL More...
AIDA::IHistogram1D *	histo1D (const HistoID &ID) const
	access the EXISTING 1D histogram by ID return the pointer to existing 1D histogram or NULL More...
AIDA::IHistogram1D *	histo (const std::string &title) const
	access the EXISTING 1D histogram by title More...
AIDA::IHistogram1D *	histo (const HistoID &ID) const
	access the EXISTING 1D histogram by ID More...
AIDA::IHistogram2D *	histo2D (const std::string &title) const
	access the EXISTING 2D histogram by title return the pointer to existing 2D histogram or NULL More...
AIDA::IHistogram2D *	histo2D (const HistoID &ID) const
	access the EXISTING 2D histogram by ID return the pointer to existing 2D histogram or NULL More...
AIDA::IHistogram3D *	histo3D (const std::string &title) const
	access the EXISTING 3D histogram by title return the pointer to existing 3D histogram or NULL More...
AIDA::IHistogram3D *	histo3D (const HistoID &ID) const
	access the EXISTING 3D histogram by ID return the pointer to existing 3D histogram or NULL More...
bool	histoExists (const std::string &title) const
	check the existence AND validity of the histogram with given title More...
bool	histoExists (const HistoID &ID) const
	check the existence AND validity of the histogram with given title More...
unsigned int	totalNumberOfHistos () const
	Returns the total number of histograms (of all types) currently booked. More...
bool	produceHistos () const
	get the flag for histogram production (property "HistoProduce") More...
bool	fullDetail () const
	get flag to control output level of histograms More...
bool	checkForNaN () const
	get the flag for NaN checks (property "HistoCheckForNan") More...
bool	splitHistoDir () const
	get the flag for histogram path split (property "HistoSplitDir") More...
HistoID::NumericID	histoOffSet () const
	get the value for histogram offset (property "HistoOffSet") More...
const std::string &	histoTopDir () const
	get top-level histogram directory (property "HistoTopDir") More...
const std::string &	histoDir () const
	get histogram directory (property "HistoDir") More...
std::string	histoPath () const
	get the constructed histogram path More...
bool	histosPrint () const
	print histograms at finalization ? More...
bool	histoCountersPrint () const
	print histogram counters at finalization ? More...
bool	useNumericAutoIDs () const
	Use old style sequencial numerical automatically assigned IDs ? More...
int	printHistos (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of histograms More...
const Histo1DMapTitle &	histo1DMapTitle () const
	get access to the map of all 1D histograms indexed via their title More...
const Histo1DMapID &	histo1DMapID () const
	get access to the map of all 1D histograms index via ID More...
const Histo2DMapTitle &	histo2DMapTitle () const
	get access to the map of all 2D histograms indexed via their title More...
const Histo2DMapID &	histo2DMapID () const
	get access to the map of 2D histograms index via ID More...
const Histo3DMapTitle &	histo3DMapTitle () const
	get access to the map of all 3D histograms indexed via their title More...
const Histo3DMapID &	histo3DMapID () const
	get access to the map of all 3D histograms index via a ID More...
const Profile1DMapTitle &	profile1DMapTitle () const
	get access to the map of all 1D profile histograms indexed via their title More...
const Profile1DMapID &	profile1DMapID () const
	get access to the map of 1D profile histograms index via a ID More...
const Profile2DMapTitle &	profile2DMapTitle () const
	get access to the map of all 2D profile histograms indexed via their title More...
const Profile2DMapID &	profile2DMapID () const
	get access to the map of 2D profile histograms index via a ID More...
void	setProduceHistos (const bool val)
	set the flag for histogram production (property "HistoProduce") More...
void	setFullDetail (const bool val)
	set flag to control output level of histograms More...
void	setCheckForNaN (const bool val)
	set the flag for NaN checks (property "HistoCheckForNan") More...
void	setSplitHistoDir (const bool val)
	set the flag for histogram path split (property "HistoSplitDir") More...
void	setHistoOffSet (const HistoID::NumericID val)
	set a value for histogram offset (property "HistoOffSet" More...
void	setHistoTopDir (const std::string &val)
	set top-level histogram directory (property "HistoTopDir") More...
void	setHistoDir (const std::string &val)
	set histogram directory (property "HistoDir") More...
	GaudiHistos (const std::string &name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if PBASE derives from GaudiAlgorithm. More...
	GaudiHistos (const std::string &type, const std::string &name, const IInterface *parent)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from GaudiTool. More...
Public Member Functions inherited from GaudiTool
StatusCode	initialize () override
	standard initialization method More...
StatusCode	finalize () override
	standard finalization method More...
INTupleSvc *	ntupleSvc () const
	Access the standard N-Tuple. More...
INTupleSvc *	evtColSvc () const
	Access the standard event collection service. More...
IDataProviderSvc *	detSvc () const
	accessor to detector service More...
IIncidentSvc *	incSvc () const
	accessor to Incident Service More...
IChronoStatSvc *	chronoSvc () const
	accessor to Chrono & Stat Service More...
IHistogramSvc *	histoSvc () const
	acessor to the histogram service More...
IAlgContextSvc *	contextSvc () const
	acessor to the Algorithm Context Service More...
void	put (IDataProviderSvc *svc, DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...
void	put (IDataProviderSvc *svc, std::unique_ptr< DataObject > object, const std::string &address, const bool useRootInTES=true) const
const DataObject *	put (DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...
const DataObject *	put (std::unique_ptr< DataObject > object, const std::string &address, const bool useRootInTES=true) const
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	get (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data from Gaudi Event Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
template<class TYPE >
TYPE *	getDet (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
TYPE *	getDet (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
Gaudi::Utils::GetData< TYPE >::return_type	getDetIfExists (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...
template<class TYPE >
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...
template<class TYPE >
bool	exist (const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...
template<class TYPE >
bool	existDet (IDataProviderSvc *svc, const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...
template<class TYPE >
bool	existDet (const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...
StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode. More...
StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode. More...
StatusCode	Info (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...
	GaudiTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...
	~GaudiTool () override
	destructor, virtual and protected More...
Public Member Functions inherited from GaudiCommon< CounterHolder< AlgTool > >
Gaudi::Utils::GetData< TYPE >::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...
Gaudi::Utils::GetData< TYPE >::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Quicker version of the get function which bypasses the check on the retrieved data. More...
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...
Gaudi::Utils::GetData< TYPE >::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...
DataObject *	put (IDataProviderSvc *svc, std::unique_ptr< DataObject > object, const std::string &location, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...
DataObject *	put (IDataProviderSvc *svc, DataObject *object, const std::string &location, const bool useRootInTES=true) const
TOOL *	tool (const std::string &type, const std::string &name, const IInterface *parent=0, bool create=true) const
	Useful method for the easy location of tools. More...
TOOL *	tool (const std::string &type, const IInterface *parent=0, bool create=true) const
	A useful method for the easy location of tools. More...
SmartIF< SERVICE >	svc (const std::string &name, const bool create=true) const
	A useful method for the easy location of services. More...
IUpdateManagerSvc *	updMgrSvc () const
	Short-cut to locate the Update Manager Service. More...
WARN_UNUSED StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode. More...
WARN_UNUSED StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode. More...
WARN_UNUSED StatusCode	Info (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...
WARN_UNUSED StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const
	Print the message and return with the given StatusCode. More...
void	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...
void	Assert (const bool ok, const char *message, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...
void	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given GaudiException. More...
void	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given exception. More...
void	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and throw an exception with the given message. More...
StatEntity &	counter (const std::string &tag) const
	accessor to certain counter by name More...
StatEntity &	counter (const std::string &tag)
bool	typePrint () const
	Insert the actual C++ type of the algorithm/tool in the messages ? More...
bool	propsPrint () const
	Print properties at initialization ? More...
bool	statPrint () const
	Print statistical counters at finalization ? More...
bool	errorsPrint () const
	Print error counters at finalization ? More...
long	printStat (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of statistical counters More...
long	printErrors (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of error counters More...
long	printProps (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of properties More...
void	registerCondition (const std::string &condition, StatusCode(CallerClass::*mf)()=nullptr)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
void	registerCondition (const std::string &condition, CondType *&condPtrDest, StatusCode(CallerClass::*mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
void	registerCondition (char *condition, StatusCode(CallerClass::*mf)()=NULL)
	just to avoid conflicts with the version using a pointer to a template class. More...
void	registerCondition (TargetClass *condition, StatusCode(CallerClass::*mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...
StatusCode	runUpdate ()
	asks the UpdateManagerSvc to perform an update of the instance (if needed) without waiting the next BeginEvent incident. More...
	GaudiCommon (const std::string &name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if PBASE derives from Algorithm. More...
	GaudiCommon (const std::string &type, const std::string &name, const IInterface *ancestor)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool. More...
StatusCode	initialize () override
	standard initialization method More...
StatusCode	finalize () override
	standard finalization method More...
StatusCode	release (const IInterface *interface) const
	Manual forced (and 'safe') release of the active tool or service. More...
const Services &	services () const
	get the list of aquired services More...
const std::string &	context () const
	Returns the "context" string. Used to identify different processing states. More...
const std::string &	rootInTES () const
	Returns the "rootInTES" string. More...
const std::string	fullTESLocation (const std::string &location, const bool useRootInTES) const
	Returns the full correct event location given the rootInTes settings. More...
Public Member Functions inherited from CounterHolder< BASE >
void	declareCounter (const std::string &tag, Gaudi::Accumulators::PrintableCounter &r)
const Gaudi::Accumulators::PrintableCounter *	findCounter (const std::string &tag) const
template<typename Callable >
void	forEachCounter (Callable &&f) const
int	nCounters () const
void	clearCounters ()
Public Member Functions inherited from ISequencerTimerTool
	DeclareInterfaceID (ISequencerTimerTool, 3, 0)
	InterfaceID. More...
Public Member Functions inherited from IAlgTool
	DeclareInterfaceID (IAlgTool, 4, 0)
	InterfaceID. More...
virtual const std::string &	type () const =0
	The type of an AlgTool, meaning the concrete AlgTool class. More...
virtual const IInterface *	parent () const =0
	The parent of the concrete AlgTool. More...
virtual StatusCode	configure ()=0
	Configuration (from OFFLINE to CONFIGURED). More...
virtual StatusCode	start ()=0
	Start (from INITIALIZED to RUNNING). More...
virtual StatusCode	stop ()=0
	Stop (from RUNNING to INITIALIZED). More...
virtual StatusCode	terminate ()=0
	Initialization (from CONFIGURED to OFFLINE). More...
virtual StatusCode	reinitialize ()=0
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
virtual StatusCode	restart ()=0
	Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
virtual Gaudi::StateMachine::State	FSMState () const =0
	Get the current state. More...
virtual StatusCode	sysInitialize ()=0
	Initialization of the Tool. More...
virtual StatusCode	sysStart ()=0
	Initialization of the Tool. More...
virtual StatusCode	sysStop ()=0
	Initialization of the Tool. More...
virtual StatusCode	sysFinalize ()=0
	Finalization of the Tool. More...
virtual StatusCode	sysReinitialize ()=0
	Initialization of the Tool. More...
virtual StatusCode	sysRestart ()=0
	Initialization of the Tool. More...
Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...
virtual const std::string &	name () const =0
	Retrieve the name of the instance. More...
Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function More...
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces. More...
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...
virtual unsigned long	release ()=0
	Release Interface instance. More...
virtual unsigned long	refCount () const =0
	Current reference count. More...
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance. More...
virtual	~IInterface ()=default
	Virtual destructor. More...

Private Attributes
Gaudi::Property< int >	m_shots {this, "Shots", 3500000, "number of shots for CPU normalization"}
Gaudi::Property< bool >	m_normalised {this, "Normalised", false, "normalise the time to a nominal PIII"}
Gaudi::Property< bool >	m_globalTiming {this, "GlobalTiming", false}
Gaudi::Property< std::string::size_type >	m_headerSize
int	m_indent = 0
	Amount of indentation. More...
std::vector< TimerForSequencer >	m_timerList
double	m_normFactor = 0.001
	Factor to convert to standard CPU (1 GHz PIII) More...
double	m_speedRatio = 0

Additional Inherited Members
Public Types inherited from GaudiHistos< GaudiTool >
typedef GaudiAlg::HistoID	HistoID
	the actual type for histogram identifier More...
typedef GaudiAlg::Histo1DMapID	Histo1DMapID
	the actual type for (ID)->(1D histogram) mapping More...
typedef GaudiAlg::Histo1DMapTitle	Histo1DMapTitle
	the actual type for title->(1D histogram) mapping More...
typedef GaudiAlg::Histo2DMapID	Histo2DMapID
	the actual type for (ID)->(2D histogram) mapping More...
typedef GaudiAlg::Histo2DMapTitle	Histo2DMapTitle
	the actual type for title->(2D histogram) mapping More...
typedef GaudiAlg::Histo3DMapID	Histo3DMapID
	the actual type for (ID)->(3D histogram) mapping More...
typedef GaudiAlg::Histo3DMapTitle	Histo3DMapTitle
	the actual type for title->(3D histogram) mapping More...
typedef GaudiAlg::Profile1DMapID	Profile1DMapID
	the actual type for (ID)->(1D profile histogram) mapping More...
typedef GaudiAlg::Profile1DMapTitle	Profile1DMapTitle
	the actual type for title->(1D profile histogram) mapping More...
typedef GaudiAlg::Profile2DMapID	Profile2DMapID
	the actual type for (ID)->(2D profile histogram) mapping More...
typedef GaudiAlg::Profile2DMapTitle	Profile2DMapTitle
	the actual type for title->(2D profile histogram) mapping More...
typedef GaudiAlg::HistoBinEdges	HistoBinEdges
	Edges for variable binning. More...
Public Types inherited from IInterface
enum	Status : StatusCode::code_t {   Status::FAILURE = 0, Status::SUCCESS = 1, Status::NO_INTERFACE, Status::VERSMISMATCH,   Status::LAST_ERROR }
	Return status. More...
using	iid = Gaudi::InterfaceId< IInterface, 0, 0 >
	Interface ID. More...
using	ext_iids = Gaudi::interface_list< iid >
	Extra interfaces. More...
Static Public Member Functions inherited from GaudiTool
static bool	enableSummary (bool)
	enable/disable summary More...
static bool	summaryEnabled ()
	is summary enabled? More...
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...
Protected Types inherited from GaudiCommon< CounterHolder< AlgTool > >
using	base_class = CounterHolder< AlgTool >
typedef std::map< std::string, StatEntity >	StatisticsOwn
	the actual type of general counters More...
typedef std::map< std::string, std::reference_wrapper< Gaudi::Accumulators::PrintableCounter > >	Statistics
typedef std::map< std::string, unsigned int >	Counter
	the actual type error/warning counter More...
typedef std::vector< IAlgTool * >	AlgTools
	storage for active tools More...
typedef std::vector< SmartIF< IService > >	Services
	storage for active services More...
Protected Member Functions inherited from GaudiHistos< GaudiTool >
StatusCode	initialize () override
	standard initialization method More...
StatusCode	finalize () override
	standard finalization method More...
std::string	convertTitleToID (std::string title) const
	Create an ID string from a title string. More...
Protected Member Functions inherited from GaudiCommon< CounterHolder< AlgTool > >
StatusCode	releaseTool (const IAlgTool *tool) const
	manual forced (and 'safe') release of the tool More...
StatusCode	releaseSvc (const IInterface *svc) const
	manual forced (and 'safe') release of the service More...
Protected Attributes inherited from GaudiCommon< CounterHolder< AlgTool > >
SmartIF< ICounterSummarySvc >	m_counterSummarySvc
	a pointer to the CounterSummarySvc More...
Static Protected Attributes inherited from GaudiCommon< CounterHolder< AlgTool > >
static const bool	IgnoreRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...
static const bool	UseRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

Detailed Description

Implements the time measurement inside a sequencer.

The width of the timing table column printing the algorithm name is 30 by default. That can be changed via

TimingAuditor().addTool(SequencerTimerTool, name = "TIMER")
TimingAuditor().TIMER.NameSize = 50 

@author Olivier Callot
@date   2004-05-19

Definition at line 25 of file SequencerTimerTool.h.

Constructor & Destructor Documentation

SequencerTimerTool::SequencerTimerTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard constructor.

Definition at line 26 of file SequencerTimerTool.cpp.

    : GaudiHistoTool( type, name, parent ) {
  declareInterface<ISequencerTimerTool>( this );

  // Histograms are disabled by default in this tool.
  setProperty( "HistoProduce", false ).ignore();
}

Member Function Documentation

int SequencerTimerTool::addTimer ( const std::string &  name )

overridevirtual

add a timer entry with the specified name

Implements ISequencerTimerTool.

Definition at line 119 of file SequencerTimerTool.cpp.

                                                        {
  std::string myName( 2 * m_indent, ' ' );
  myName += name;
  if ( myName.size() < m_headerSize ) { myName += std::string( m_headerSize - myName.size(), ' ' ); }
  m_timerList.emplace_back( std::move( myName ), m_headerSize, m_normFactor );
  return m_timerList.size() - 1;
}

void SequencerTimerTool::decreaseIndent ( )

inlineoverridevirtual

Decrease the indentation of the name.

Implements ISequencerTimerTool.

Definition at line 49 of file SequencerTimerTool.h.

{ m_indent = std::max( m_indent - 1, 0 ); }

StatusCode SequencerTimerTool::finalize ( )

overridevirtual

finalize method, to print the time summary table

Implements IAlgTool.

Definition at line 61 of file SequencerTimerTool.cpp.

                                        {

  std::string line( m_headerSize + 68, '-' );
  info() << line << endmsg << "This machine has a speed about " << format( "%6.2f", 1000. * m_speedRatio )
         << " times the speed of a 2.8 GHz Xeon.";
  if ( m_normalised ) info() << " *** All times are renormalized ***";
  info() << endmsg << TimerForSequencer::header( m_headerSize ) << endmsg << line << endmsg;

  std::string lastName;
  for ( const auto& timr : m_timerList ) {
    if ( lastName == timr.name() ) continue; // suppress duplicate
    lastName = timr.name();
    info() << timr << endmsg;
  }
  info() << line << endmsg;

  return GaudiHistoTool::finalize();
}

bool SequencerTimerTool::globalTiming ( )

inlineoverridevirtual

returns the flag telling that global timing is wanted

Implements ISequencerTimerTool.

Definition at line 67 of file SequencerTimerTool.h.

{ return m_globalTiming; };

void SequencerTimerTool::increaseIndent ( )

inlineoverridevirtual

Increase the indentation of the name.

Implements ISequencerTimerTool.

Definition at line 46 of file SequencerTimerTool.h.

{ m_indent += 1; }

int SequencerTimerTool::indexByName ( const std::string &  name )

overridevirtual

returns the index of the counter with that name, or -1

Implements ISequencerTimerTool.

Definition at line 83 of file SequencerTimerTool.cpp.

                                                           {
  auto beg  = name.find_first_not_of( " \t" );
  auto end  = name.find_last_not_of( " \t" );
  auto temp = name.substr( beg, end - beg + 1 );
  auto i    = std::find_if( std::begin( m_timerList ), std::end( m_timerList ), [&]( const TimerForSequencer& timer ) {
    beg = timer.name().find_first_not_of( " \t" );
    end = timer.name().find_last_not_of( " \t" );
    return timer.name().compare( beg, end - beg + 1, temp ) == 0;
  } );
  return i != std::end( m_timerList ) ? std::distance( std::begin( m_timerList ), i ) : -1;
}

StatusCode SequencerTimerTool::initialize ( )

overridevirtual

initialize method, to compute the normalization factor

Implements IAlgTool.

Definition at line 36 of file SequencerTimerTool.cpp.

                                          {
  const StatusCode sc = GaudiHistoTool::initialize();
  if ( sc.isFailure() ) return sc;
  double            sum = 0;
  TimerForSequencer norm( "normalize", m_headerSize, m_normFactor );
  norm.start();
  IRndmGenSvc* rsvc = svc<IRndmGenSvc>( "RndmGenSvc", true );
  { // Use dummy loop suggested by Vanya Belyaev:
    Rndm::Numbers gauss;
    gauss.initialize( rsvc, Rndm::Gauss( 0., 1.0 ) ).ignore();
    unsigned int shots = m_shots;
    while ( 0 < --shots ) { sum += gauss() * sum; }
  }
  norm.stop();
  double time  = norm.lastCpu();
  m_speedRatio = 1. / time;
  info() << "This machine has a speed about " << format( "%6.2f", 1000. * m_speedRatio )
         << " times the speed of a 2.8 GHz Xeon." << endmsg;
  if ( m_normalised ) m_normFactor = m_speedRatio;
  return sc;
}

double SequencerTimerTool::lastTime ( int  index )

inlineoverridevirtual

returns the last time

Implements ISequencerTimerTool.

Definition at line 58 of file SequencerTimerTool.h.

{ return m_timerList[index].lastTime(); }

const std::string& SequencerTimerTool::name ( int  index )

inlineoverridevirtual

returns the name of the counter

Implements ISequencerTimerTool.

Definition at line 61 of file SequencerTimerTool.h.

{ return m_timerList[index].name(); }

void SequencerTimerTool::saveHistograms ( )

overridevirtual

prepares and saves the timing histograms

Implements ISequencerTimerTool.

Definition at line 98 of file SequencerTimerTool.cpp.

                                        {
  if ( produceHistos() ) {
    info() << "Saving Timing histograms" << endmsg;
    const size_t        bins       = m_timerList.size();
    AIDA::IHistogram1D* histoTime  = book( "ElapsedTime", 0, bins, bins );
    AIDA::IHistogram1D* histoCPU   = book( "CPUTime", 0, bins, bins );
    AIDA::IHistogram1D* histoCount = book( "Count", 0, bins, bins );
    TH1D*               tHtime     = Gaudi::Utils::Aida2ROOT::aida2root( histoTime );
    TH1D*               tHCPU      = Gaudi::Utils::Aida2ROOT::aida2root( histoCPU );
    TH1D*               tHCount    = Gaudi::Utils::Aida2ROOT::aida2root( histoCount );
    for ( const auto& tfsq : m_timerList ) {
      tHtime->Fill( tfsq.name().c_str(), tfsq.elapsedTotal() );
      tHCPU->Fill( tfsq.name().c_str(), tfsq.cpuTotal() );
      tHCount->Fill( tfsq.name().c_str(), tfsq.count() );
    }
  }
}

void SequencerTimerTool::start ( int  index )

inlineoverridevirtual

start the counter, i.e.

register the current time

Implements ISequencerTimerTool.

Definition at line 52 of file SequencerTimerTool.h.

{ m_timerList[index].start(); }

double SequencerTimerTool::stop ( int  index )

inlineoverridevirtual

stop the counter, return the elapsed time

Implements ISequencerTimerTool.

Definition at line 55 of file SequencerTimerTool.h.

{ return m_timerList[index].stop(); }

Member Data Documentation

Gaudi::Property<bool> SequencerTimerTool::m_globalTiming {this, "GlobalTiming", false}

private

Definition at line 75 of file SequencerTimerTool.h.

Gaudi::Property<std::string::size_type> SequencerTimerTool::m_headerSize

private

Initial value:

{this, "NameSize", 30,
                                                       "number of characters to be used in algorithm name column"}

Definition at line 76 of file SequencerTimerTool.h.

int SequencerTimerTool::m_indent = 0

private

Amount of indentation.

Definition at line 79 of file SequencerTimerTool.h.

Gaudi::Property<bool> SequencerTimerTool::m_normalised {this, "Normalised", false, "normalise the time to a nominal PIII"}

private

Definition at line 74 of file SequencerTimerTool.h.

double SequencerTimerTool::m_normFactor = 0.001

private

Factor to convert to standard CPU (1 GHz PIII)

Definition at line 81 of file SequencerTimerTool.h.

Gaudi::Property<int> SequencerTimerTool::m_shots {this, "Shots", 3500000, "number of shots for CPU normalization"}

private

Definition at line 73 of file SequencerTimerTool.h.

double SequencerTimerTool::m_speedRatio = 0

private

Definition at line 82 of file SequencerTimerTool.h.

std::vector<TimerForSequencer> SequencerTimerTool::m_timerList

private

Definition at line 80 of file SequencerTimerTool.h.

---

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

• GaudiAlg/src/components/SequencerTimerTool.h
• GaudiAlg/src/components/SequencerTimerTool.cpp