![]() |
The Gaudi Framework
v27r0
|
The useful base class for tools. More...
#include <GaudiTools/GaudiTool.h>
Public Member Functions | |
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... | |
DataObject * | 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... | |
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... | |
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... | |
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... | |
DataObject * | 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... | |
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... | |
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... | |
![]() | |
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 | 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... | |
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... | |
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... | |
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, 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 |
Register a data object or container into Gaudi Event Transient Store. More... | |
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... | |
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... | |
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... | |
IUpdateManagerSvc * | updMgrSvc () const |
Short-cut to locate the Update Manager Service. 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 | 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 | 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... | |
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... | |
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... | |
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 | 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... | |
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... | |
const Statistics & | counters () const |
accessor to all counters More... | |
const Statistics & | counters () const |
accessor to all counters More... | |
StatEntity & | counter (const std::string &tag) const |
accessor to certain counter by name More... | |
StatEntity & | counter (const std::string &tag) const |
accessor to certain counter by name More... | |
void | resetMsgStream () const |
void | resetMsgStream () const |
bool | typePrint () const |
Insert the actual C++ type of the algorithm/tool in the messages ? More... | |
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 | propsPrint () const |
Print properties at initialization ? More... | |
bool | statPrint () const |
Print statistical counters at finalization ? More... | |
bool | statPrint () const |
Print statistical counters at finalization ? More... | |
bool | errorsPrint () const |
Print error 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 | 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 | 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... | |
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... | |
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... | |
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. More... | |
GaudiCommon (const std::string &type, const std::string &name, const IInterface *parent) | |
Tool constructor. More... | |
GaudiCommon (const std::string &name, ISvcLocator *pSvcLocator) | |
Algorithm constructor. More... | |
GaudiCommon (const std::string &type, const std::string &name, const IInterface *parent) | |
Tool constructor. More... | |
StatusCode | initialize () override |
standard initialization method More... | |
StatusCode | initialize () override |
standard initialization method More... | |
StatusCode | finalize () override |
standard finalization 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... | |
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 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 & | 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 & | rootInTES () const |
Returns the "rootInTES" string. More... | |
double | globalTimeOffset () const |
Returns the "globalTimeOffset" double. More... | |
double | globalTimeOffset () const |
Returns the "globalTimeOffset" double. More... | |
const std::string | fullTESLocation (const std::string &location, const bool useRootInTES) const |
Returns the full correct event location given the rootInTes settings. More... | |
const std::string | fullTESLocation (const std::string &location, const bool useRootInTES) const |
Returns the full correct event location given the rootInTes settings. More... | |
![]() | |
~CommonMessaging () override=default | |
Virtual destructor. More... | |
SmartIF< IMessageSvc > & | msgSvc () const |
The standard message service. More... | |
MsgStream & | msgStream () const |
Return an uninitialized MsgStream. More... | |
MsgStream & | msgStream (const MSG::Level level) const |
Predefined configurable message stream for the efficient printouts. More... | |
MsgStream & | always () const |
shortcut for the method msgStream(MSG::ALWAYS) More... | |
MsgStream & | fatal () const |
shortcut for the method msgStream(MSG::FATAL) More... | |
MsgStream & | err () const |
shortcut for the method msgStream(MSG::ERROR) More... | |
MsgStream & | error () const |
shortcut for the method msgStream(MSG::ERROR) More... | |
MsgStream & | warning () const |
shortcut for the method msgStream(MSG::WARNING) More... | |
MsgStream & | info () const |
shortcut for the method msgStream(MSG::INFO) More... | |
MsgStream & | debug () const |
shortcut for the method msgStream(MSG::DEBUG) More... | |
MsgStream & | verbose () const |
shortcut for the method msgStream(MSG::VERBOSE) More... | |
MsgStream & | msg () const |
shortcut for the method msgStream(MSG::INFO) More... | |
MSG::Level | msgLevel () const |
get the output level from the embedded MsgStream More... | |
bool | msgLevel (MSG::Level lvl) const |
get the output level from the embedded MsgStream More... | |
~CommonMessaging () override=default | |
Virtual destructor. More... | |
SmartIF< IMessageSvc > & | msgSvc () const |
The standard message service. More... | |
MsgStream & | msgStream () const |
Return an uninitialized MsgStream. More... | |
MsgStream & | msgStream (const MSG::Level level) const |
Predefined configurable message stream for the efficient printouts. More... | |
MsgStream & | always () const |
shortcut for the method msgStream(MSG::ALWAYS) More... | |
MsgStream & | fatal () const |
shortcut for the method msgStream(MSG::FATAL) More... | |
MsgStream & | err () const |
shortcut for the method msgStream(MSG::ERROR) More... | |
MsgStream & | error () const |
shortcut for the method msgStream(MSG::ERROR) More... | |
MsgStream & | warning () const |
shortcut for the method msgStream(MSG::WARNING) More... | |
MsgStream & | info () const |
shortcut for the method msgStream(MSG::INFO) More... | |
MsgStream & | debug () const |
shortcut for the method msgStream(MSG::DEBUG) More... | |
MsgStream & | verbose () const |
shortcut for the method msgStream(MSG::VERBOSE) More... | |
MsgStream & | msg () const |
shortcut for the method msgStream(MSG::INFO) More... | |
MSG::Level | msgLevel () const |
get the output level from the embedded MsgStream More... | |
bool | msgLevel (MSG::Level lvl) const |
get the output level from the embedded MsgStream More... | |
Static Public Member Functions | |
static bool | enableSummary (bool) |
enable/disable summary More... | |
static bool | summaryEnabled () |
is summary enabled? More... | |
static bool | enableSummary (bool) |
enable/disable summary More... | |
static bool | summaryEnabled () |
is summary enabled? More... | |
Protected Member Functions | |
GaudiTool (const std::string &type, const std::string &name, const IInterface *parent) | |
Standard constructor. More... | |
~GaudiTool () override | |
destructor, virtual and protected More... | |
GaudiTool (const std::string &type, const std::string &name, const IInterface *parent) | |
Standard constructor. More... | |
~GaudiTool () override | |
destructor, virtual and protected More... | |
![]() | |
~GaudiCommon () override=default | |
Destructor. More... | |
~GaudiCommon () override=default | |
Destructor. More... | |
StatusCode | releaseTool (const IAlgTool *tool) const |
manual forced (and 'safe') release of the tool More... | |
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... | |
StatusCode | releaseSvc (const IInterface *svc) const |
manual forced (and 'safe') release of the service More... | |
![]() | |
void | updateMsgStreamOutputLevel (int level) |
Update the output level of the cached MsgStream. More... | |
void | updateMsgStreamOutputLevel (int level) |
Update the output level of the cached MsgStream. More... | |
Private Member Functions | |
GaudiTool ()=delete | |
no default/copy constructor, no assignment More... | |
GaudiTool (const GaudiTool &)=delete | |
GaudiTool & | operator= (const GaudiTool &)=delete |
bool | isPublic () const |
Determines if this tool is public or not (i.e. owned by the ToolSvc). More... | |
std::string | getCurrentAlgName () const |
Returns the current active algorithm name via the context service. More... | |
GaudiTool ()=delete | |
no default/copy constructor, no assignment More... | |
GaudiTool (const GaudiTool &)=delete | |
GaudiTool & | operator= (const GaudiTool &)=delete |
bool | isPublic () const |
Determines if this tool is public or not (i.e. owned by the ToolSvc). More... | |
std::string | getCurrentAlgName () const |
Returns the current active algorithm name via the context service. More... | |
Private Attributes | |
INTupleSvc * | m_ntupleSvc = nullptr |
pointer to the N-Tuple service More... | |
INTupleSvc * | m_evtColSvc = nullptr |
pointer to the event tag collection service More... | |
IDataProviderSvc * | m_detSvc = nullptr |
pointer to Detector Data Service More... | |
IChronoStatSvc * | m_chronoSvc = nullptr |
pointer to Chrono & Stat Service More... | |
IIncidentSvc * | m_incSvc = nullptr |
pointer to Incident Service More... | |
IHistogramSvc * | m_histoSvc = nullptr |
pointer for histogram service More... | |
IAlgContextSvc * | m_contextSvc = nullptr |
Algorithm Context Service. More... | |
std::string | m_contextSvcName = "AlgContextSvc" |
Algorithm Context Service. More... | |
bool | m_isPublic = false |
Flag to say if the tool is a public or private tool. More... | |
const std::string | m_local |
full tool name "type/name" More... | |
Static Private Attributes | |
static bool | s_enableSummary = true |
enable printout of summary? More... | |
Additional Inherited Members | |
![]() | |
using | base_class = CommonMessaging |
using | base_class = CommonMessaging |
![]() | |
typedef std::map< std::string, StatEntity > | Statistics |
the actual type of general counters More... | |
typedef std::map< std::string, StatEntity > | Statistics |
the actual type of general counters More... | |
typedef std::map< std::string, unsigned int > | Counter |
the actual type error/warning counter More... | |
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< IAlgTool * > | AlgTools |
storage for active tools More... | |
typedef std::vector< SmartIF< IService > > | Services |
storage for active services More... | |
typedef std::vector< SmartIF< IService > > | Services |
storage for active services More... | |
![]() | |
SmartIF< ICounterSummarySvc > | m_counterSummarySvc |
a pointer to the CounterSummarySvc More... | |
std::vector< std::string > | m_counterList |
list of counters to declare. Set by property CounterList. This can be a regular expression. More... | |
std::vector< std::string > | m_statEntityList |
![]() | |
SmartIF< IMessageSvc > | m_msgsvc |
Pointer to the message service;. More... | |
std::unique_ptr< MsgStream > | m_msgStream |
The predefined message stream. More... | |
bool | m_streamWithService = false |
Flag to create a new MsgStream if it was created without the message service. More... | |
![]() | |
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... | |
The useful base class for tools.
Small extension of ordinary the AlgTool base class.
This base class allows "easy"(=="1 line") access to tools and services. This access is safe in the sense that there is no need to worry about the reference counts for tools and services.
The base class allows "easy" (=="1 line") access to data in Gaudi Transient Stores. The functionality includes the checking of the presence of the data at the given location, checking the validity of the data, retrieval of valid data and "forced" retrieve of valid data (create if there is no data).
The base class allows to perform an easy error, warning and exception treatments, including the accumulated statistics of exceptions, errors and warnings.
The base class also includes utilities for general statistical counters.
It has been reported that usage of this base class results in significant reduction of existing code lines.
Definition at line 97 of file GaudiTool.h.
|
protected |
Standard constructor.
type | tool type (useless) |
name | tool name |
parent | pointer to parent object (service, algorithm or tool) |
Definition at line 138 of file GaudiTool.cpp.
|
overrideprotected |
destructor, virtual and protected
Definition at line 154 of file GaudiTool.cpp.
|
privatedelete |
no default/copy constructor, no assignment
|
privatedelete |
|
protected |
Standard constructor.
type | tool type (useless) |
name | tool name |
parent | pointer to parent object (service, algorithm or tool) |
|
overrideprotected |
destructor, virtual and protected
|
privatedelete |
no default/copy constructor, no assignment
|
privatedelete |
IChronoStatSvc * GaudiTool::chronoSvc | ( | ) | const |
accessor to Chrono & Stat Service
Definition at line 267 of file GaudiTool.cpp.
IChronoStatSvc* GaudiTool::chronoSvc | ( | ) | const |
IAlgContextSvc * GaudiTool::contextSvc | ( | ) | const |
acessor to the Algorithm Context Service
Definition at line 290 of file GaudiTool.cpp.
IAlgContextSvc* GaudiTool::contextSvc | ( | ) | const |
IDataProviderSvc* GaudiTool::detSvc | ( | ) | const |
accessor to detector service
IDataProviderSvc * GaudiTool::detSvc | ( | ) | const |
accessor to detector service
Definition at line 221 of file GaudiTool.cpp.
|
static |
enable/disable summary
Definition at line 125 of file GaudiTool.cpp.
|
static |
enable/disable summary
|
inline |
Print the error message and return with the given StatusCode.
Also performs statistical analysis of the error messages and suppression after the defined number of error instances.
msg | Error message |
st | StatusCode to return |
mx | Maximum number of printouts for this message |
Definition at line 688 of file GaudiTool.h.
|
inline |
Print the error message and return with the given StatusCode.
Also performs statistical analysis of the error messages and suppression after the defined number of error instances.
msg | Error message |
st | StatusCode to return |
mx | Maximum number of printouts for this message |
Definition at line 688 of file GaudiTool.h.
INTupleSvc * GaudiTool::evtColSvc | ( | ) | const |
Access the standard event collection service.
Definition at line 244 of file GaudiTool.cpp.
INTupleSvc* GaudiTool::evtColSvc | ( | ) | const |
Access the standard event collection service.
|
inline |
Check the existence of a data object or container in the Gaudi Transient Event Store.
svc | Pointer to data service (data provider) |
location | Address in Gaudi Transient Event Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
true | Data object or container exists and implements a proper interface |
true | Failed to locate the data object or container |
Definition at line 514 of file GaudiTool.h.
|
inline |
Check the existence of a data object or container in the Gaudi Transient Event Store.
svc | Pointer to data service (data provider) |
location | Address in Gaudi Transient Event Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
true | Data object or container exists and implements a proper interface |
true | Failed to locate the data object or container |
Definition at line 514 of file GaudiTool.h.
|
inline |
Check the existence of a data object or container in the Gaudi Transient Event Store.
true | Data object or container exists and implements a proper interface |
true | Failed to locate the data object or container |
Definition at line 544 of file GaudiTool.h.
|
inline |
Check the existence of a data object or container in the Gaudi Transient Event Store.
true | Data object or container exists and implements a proper interface |
true | Failed to locate the data object or container |
Definition at line 544 of file GaudiTool.h.
|
inline |
Check the existence of detector objects in the Gaudi Transient Detector Store.
svc | Pointer to data service (data provider) |
location | Address in Gaudi Transient Detector Store |
true | Detector object exists and implements a proper interface |
false | Failed to locate the data object |
Definition at line 567 of file GaudiTool.h.
|
inline |
Check the existence of detector objects in the Gaudi Transient Detector Store.
svc | Pointer to data service (data provider) |
location | Address in Gaudi Transient Detector Store |
true | Detector object exists and implements a proper interface |
false | Failed to locate the data object |
Definition at line 567 of file GaudiTool.h.
|
inline |
Check the existence of detector objects in the Gaudi Transient Detector Store.
location | Address in Gaudi Transient Detector Store |
true | Detector object exists and implements a proper interface |
false | Failed to locate the data object |
Definition at line 589 of file GaudiTool.h.
|
inline |
Check the existence of detector objects in the Gaudi Transient Detector Store.
location | Address in Gaudi Transient Detector Store |
true | Detector object exists and implements a proper interface |
false | Failed to locate the data object |
Definition at line 589 of file GaudiTool.h.
|
override |
|
override |
standard finalization method
Definition at line 179 of file GaudiTool.cpp.
|
inline |
Templated access to the data in Gaudi Transient Store.
Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data
GaudiException | for Invalid Data Provider Service |
GaudiException | for invalid/unavailable data |
svc | Pointer to data service (data provider) |
location | data location/address in Gaudi Transient Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
Definition at line 260 of file GaudiTool.h.
|
inline |
Templated access to the data in Gaudi Transient Store.
Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data
GaudiException | for Invalid Data Provider Service |
GaudiException | for invalid/unavailable data |
svc | Pointer to data service (data provider) |
location | data location/address in Gaudi Transient Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
Definition at line 260 of file GaudiTool.h.
|
inline |
Templated access to the data from Gaudi Event Transient Store.
Quick and safe access to the data in Gaudi transient store.
The method located the data at the given address and perform the debug printout about located data.
location | Data location/address in Gaudi Transient Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
Definition at line 336 of file GaudiTool.h.
|
inline |
Templated access to the data from Gaudi Event Transient Store.
Quick and safe access to the data in Gaudi transient store.
The method located the data at the given address and perform the debug printout about located data.
location | Data location/address in Gaudi Transient Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
Definition at line 336 of file GaudiTool.h.
|
inlineprivate |
Returns the current active algorithm name via the context service.
Definition at line 787 of file GaudiTool.h.
|
inlineprivate |
Returns the current active algorithm name via the context service.
Definition at line 787 of file GaudiTool.h.
|
inline |
Templated access to the detector data from the Gaudi Detector Transient Store.
Quick and safe access to the detector data in Gaudi transient store.
The method located the detector at the given address and perform the debug printout about located detector.
svc | Pointer to data service (data provider) |
location | Detector location/address in Gaudi Transient Store |
Definition at line 401 of file GaudiTool.h.
|
inline |
Templated access to the detector data from the Gaudi Detector Transient Store.
Quick and safe access to the detector data in Gaudi transient store.
The method located the detector at the given address and perform the debug printout about located detector.
svc | Pointer to data service (data provider) |
location | Detector location/address in Gaudi Transient Store |
Definition at line 401 of file GaudiTool.h.
|
inline |
Templated access to the detector data from the Gaudi Detector Transient Store.
Quick and safe access to the detector data in Gaudi transient store.
The method located the detector at the given address and perform the debug printout about located detector.
location | Detector location/address in Gaudi Transient Store |
Definition at line 455 of file GaudiTool.h.
|
inline |
Templated access to the detector data from the Gaudi Detector Transient Store.
Quick and safe access to the detector data in Gaudi transient store.
The method located the detector at the given address and perform the debug printout about located detector.
location | Detector location/address in Gaudi Transient Store |
Definition at line 455 of file GaudiTool.h.
|
inline |
Templated access to the detector data from the Gaudi Detector Transient Store.
Quick and safe access to the detector data in Gaudi transient store.
The method located the detector at the given address and perform the debug printout about located detector.
Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.
svc | Pointer to data service (data provider) |
location | Detector location/address in Gaudi Transient Store |
NULL | If the detector object does not exist. |
Definition at line 431 of file GaudiTool.h.
|
inline |
Templated access to the detector data from the Gaudi Detector Transient Store.
Quick and safe access to the detector data in Gaudi transient store.
The method located the detector at the given address and perform the debug printout about located detector.
Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.
svc | Pointer to data service (data provider) |
location | Detector location/address in Gaudi Transient Store |
NULL | If the detector object does not exist. |
Definition at line 431 of file GaudiTool.h.
|
inline |
Templated access to the detector data from the Gaudi Detector Transient Store.
Quick and safe access to the detector data in Gaudi transient store.
The method located the detector at the given address and perform the debug printout about located detector.
Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.
location | Detector location/address in Gaudi Transient Store |
NULL | If the detector object does not exist. |
Definition at line 483 of file GaudiTool.h.
|
inline |
Templated access to the detector data from the Gaudi Detector Transient Store.
Quick and safe access to the detector data in Gaudi transient store.
The method located the detector at the given address and perform the debug printout about located detector.
Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.
location | Detector location/address in Gaudi Transient Store |
NULL | If the detector object does not exist. |
Definition at line 483 of file GaudiTool.h.
|
inline |
Templated access to the data in Gaudi Transient Store.
Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data.
Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.
svc | Pointer to data service (data provider) |
location | data location/address in Gaudi Transient Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
NULL | If data does not exist. |
Definition at line 302 of file GaudiTool.h.
|
inline |
Templated access to the data in Gaudi Transient Store.
Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data.
Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.
svc | Pointer to data service (data provider) |
location | data location/address in Gaudi Transient Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
NULL | If data does not exist. |
Definition at line 302 of file GaudiTool.h.
|
inline |
Templated access to the data in Gaudi Transient Store.
Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data.
Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.
location | data location/address in Gaudi Transient Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
NULL | If data does not exist. |
Definition at line 376 of file GaudiTool.h.
|
inline |
Templated access to the data in Gaudi Transient Store.
Quick and safe access to the data in Gaudi transient store. The method located the data at given address and perform the debug printout about located data.
Skips the check on the data as performed by 'get'. No exception is thrown if the data is missing.
location | data location/address in Gaudi Transient Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
NULL | If data does not exist. |
Definition at line 376 of file GaudiTool.h.
|
inline |
Get the existing data object from Gaudi Event Transient store.
Alternatively, create new object and register it in TES and return if object does not exist.
GaudiException | for Invalid Data Provider Service |
GaudiException | for invalid/unavailable data |
svc | Pointer to data service (data provider) |
location | Location in Gaudi Transient Event Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
Definition at line 622 of file GaudiTool.h.
|
inline |
Get the existing data object from Gaudi Event Transient store.
Alternatively, create new object and register it in TES and return if object does not exist.
GaudiException | for Invalid Data Provider Service |
GaudiException | for invalid/unavailable data |
svc | Pointer to data service (data provider) |
location | Location in Gaudi Transient Event Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
Definition at line 622 of file GaudiTool.h.
|
inline |
Get the existing data object from Gaudi Event Transient store.
Alternatively, create new object and register it in TES and return if object does not exist.
GaudiException | for Invalid Data Provider Service |
GaudiException | for invalid/unavailable data |
location | Location in Gaudi Transient Event Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
Definition at line 656 of file GaudiTool.h.
|
inline |
Get the existing data object from Gaudi Event Transient store.
Alternatively, create new object and register it in TES and return if object does not exist.
GaudiException | for Invalid Data Provider Service |
GaudiException | for invalid/unavailable data |
location | Location in Gaudi Transient Event Store |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
Definition at line 656 of file GaudiTool.h.
IHistogramSvc * GaudiTool::histoSvc | ( | ) | const |
acessor to the histogram service
Definition at line 279 of file GaudiTool.cpp.
IHistogramSvc* GaudiTool::histoSvc | ( | ) | const |
acessor to the histogram service
IIncidentSvc* GaudiTool::incSvc | ( | ) | const |
IIncidentSvc * GaudiTool::incSvc | ( | ) | const |
Definition at line 255 of file GaudiTool.cpp.
|
inline |
Print the info message and return with the given StatusCode.
Also performs statistical analysis of the info messages and suppression after the defined number of instances.
msg | Info message |
st | StatusCode to return |
mx | Maximum number of printouts for this message |
Definition at line 744 of file GaudiTool.h.
|
inline |
Print the info message and return with the given StatusCode.
Also performs statistical analysis of the info messages and suppression after the defined number of instances.
msg | Info message |
st | StatusCode to return |
mx | Maximum number of printouts for this message |
Definition at line 744 of file GaudiTool.h.
|
override |
|
override |
standard initialization method
Definition at line 161 of file GaudiTool.cpp.
|
private |
Determines if this tool is public or not (i.e. owned by the ToolSvc).
Definition at line 203 of file GaudiTool.cpp.
|
private |
Determines if this tool is public or not (i.e. owned by the ToolSvc).
INTupleSvc* GaudiTool::ntupleSvc | ( | ) | const |
Access the standard N-Tuple.
INTupleSvc * GaudiTool::ntupleSvc | ( | ) | const |
Access the standard N-Tuple.
Definition at line 233 of file GaudiTool.cpp.
|
inline |
Register a data object or container into Gaudi Event Transient Store.
svc | Pointer to data provider service |
object | Data object or container to be registered |
address | Address in Gaudi Event Transient Store ("/Event" could be omitted ) |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
GaudiException | for invalid event data service |
GaudiException | for invalid object |
GaudiException | for error result from event data service |
StatusCode::SUCCESS | Data was successfully placed in the TES. |
StatusCode::FAILURE | Failed to store data in the TES. |
Definition at line 184 of file GaudiTool.h.
|
inline |
Register a data object or container into Gaudi Event Transient Store.
svc | Pointer to data provider service |
object | Data object or container to be registered |
address | Address in Gaudi Event Transient Store ("/Event" could be omitted ) |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
GaudiException | for invalid event data service |
GaudiException | for invalid object |
GaudiException | for error result from event data service |
StatusCode::SUCCESS | Data was successfully placed in the TES. |
StatusCode::FAILURE | Failed to store data in the TES. |
Definition at line 184 of file GaudiTool.h.
|
inline |
Register a data object or container into Gaudi Event Transient Store.
object | Data object or container to be registered |
address | Address in Gaudi Event Transient Store ("/Event" could be omitted ) |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
GaudiException | for invalid event data service |
GaudiException | for invalid object |
GaudiException | for error result from event data service |
StatusCode::SUCCESS | Data was successfully placed in the TES. |
StatusCode::FAILURE | Failed to store data in the TES. |
Definition at line 220 of file GaudiTool.h.
|
inline |
Register a data object or container into Gaudi Event Transient Store.
object | Data object or container to be registered |
address | Address in Gaudi Event Transient Store ("/Event" could be omitted ) |
useRootInTES | Flag to turn on(TRUE) off(FALSE) the use of the RootInTES location property |
GaudiException | for invalid event data service |
GaudiException | for invalid object |
GaudiException | for error result from event data service |
StatusCode::SUCCESS | Data was successfully placed in the TES. |
StatusCode::FAILURE | Failed to store data in the TES. |
Definition at line 220 of file GaudiTool.h.
|
static |
is summary enabled?
|
static |
is summary enabled?
Definition at line 133 of file GaudiTool.cpp.
|
inline |
Print the warning message and return with the given StatusCode.
Also performs statistical analysis of the warning messages and suppression after the defined number of error instances.
msg | Warning message |
st | StatusCode to return |
mx | Maximum number of printouts for this message |
Definition at line 720 of file GaudiTool.h.
|
inline |
Print the warning message and return with the given StatusCode.
Also performs statistical analysis of the warning messages and suppression after the defined number of error instances.
msg | Warning message |
st | StatusCode to return |
mx | Maximum number of printouts for this message |
Definition at line 720 of file GaudiTool.h.
|
mutableprivate |
pointer to Chrono & Stat Service
Definition at line 803 of file GaudiTool.h.
|
mutableprivate |
Definition at line 809 of file GaudiTool.h.
|
private |
Definition at line 811 of file GaudiTool.h.
|
mutableprivate |
pointer to Detector Data Service
Definition at line 801 of file GaudiTool.h.
|
mutableprivate |
pointer to the event tag collection service
Definition at line 799 of file GaudiTool.h.
|
mutableprivate |
pointer for histogram service
Definition at line 807 of file GaudiTool.h.
|
mutableprivate |
Definition at line 805 of file GaudiTool.h.
|
private |
Flag to say if the tool is a public or private tool.
Definition at line 816 of file GaudiTool.h.
|
private |
full tool name "type/name"
Definition at line 821 of file GaudiTool.h.
|
mutableprivate |
pointer to the N-Tuple service
Definition at line 797 of file GaudiTool.h.
|
staticprivate |