GaudiTool Class Reference

The useful base class for tools. More...

#include <GaudiTools/GaudiTool.h>

Inheritance diagram for GaudiTool:
Collaboration diagram for GaudiTool:

Public Member Functions

StatusCode initialize () override
 standard initialization method More...
 
StatusCode finalize () override
 standard finalization method More...
 
INTupleSvcntupleSvc () const
 Access the standard N-Tuple. More...
 
INTupleSvcevtColSvc () const
 Access the standard event collection service. More...
 
IDataProviderSvcdetSvc () const
 accessor to detector service More...
 
IIncidentSvcincSvc () const
 accessor to Incident Service More...
 
IChronoStatSvcchronoSvc () const
 accessor to Chrono & Stat Service More...
 
IHistogramSvchistoSvc () const
 acessor to the histogram service More...
 
IAlgContextSvccontextSvc () const
 acessor to the Algorithm Context Service More...
 
DataObjectput (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...
 
DataObjectput (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...
 
INTupleSvcntupleSvc () const
 Access the standard N-Tuple. More...
 
INTupleSvcevtColSvc () const
 Access the standard event collection service. More...
 
IDataProviderSvcdetSvc () const
 accessor to detector service More...
 
IIncidentSvcincSvc () const
 accessor to Incident Service More...
 
IChronoStatSvcchronoSvc () const
 accessor to Chrono & Stat Service More...
 
IHistogramSvchistoSvc () const
 acessor to the histogram service More...
 
IAlgContextSvccontextSvc () const
 acessor to the Algorithm Context Service More...
 
DataObjectput (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...
 
DataObjectput (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...
 
- Public Member Functions inherited from GaudiCommon< 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 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...
 
DataObjectput (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...
 
DataObjectput (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...
 
IUpdateManagerSvcupdMgrSvc () const
 Short-cut to locate the Update Manager Service. More...
 
IUpdateManagerSvcupdMgrSvc () 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 Statisticscounters () const
 accessor to all counters More...
 
const Statisticscounters () const
 accessor to all counters More...
 
StatEntitycounter (const std::string &tag) const
 accessor to certain counter by name More...
 
StatEntitycounter (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 Servicesservices () const
 get the list of aquired services More...
 
const Servicesservices () 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...
 
- Public Member Functions inherited from CommonMessaging< BASE >
 ~CommonMessaging () override=default
 Virtual destructor. More...
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () 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...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () 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...
 
- Protected Member Functions inherited from GaudiCommon< AlgTool >
 ~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...
 
- Protected Member Functions inherited from CommonMessaging< BASE >
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
 
GaudiTooloperator= (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
 
GaudiTooloperator= (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

INTupleSvcm_ntupleSvc = nullptr
 pointer to the N-Tuple service More...
 
INTupleSvcm_evtColSvc = nullptr
 pointer to the event tag collection service More...
 
IDataProviderSvcm_detSvc = nullptr
 pointer to Detector Data Service More...
 
IChronoStatSvcm_chronoSvc = nullptr
 pointer to Chrono & Stat Service More...
 
IIncidentSvcm_incSvc = nullptr
 pointer to Incident Service More...
 
IHistogramSvcm_histoSvc = nullptr
 pointer for histogram service More...
 
IAlgContextSvcm_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

- Public Types inherited from CommonMessaging< BASE >
using base_class = CommonMessaging
 
using base_class = CommonMessaging
 
- Protected Types inherited from GaudiCommon< AlgTool >
typedef std::map< std::string, StatEntityStatistics
 the actual type of general counters More...
 
typedef std::map< std::string, StatEntityStatistics
 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...
 
- Protected Attributes inherited from GaudiCommon< AlgTool >
SmartIF< ICounterSummarySvcm_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
 
- Protected Attributes inherited from CommonMessaging< BASE >
SmartIF< IMessageSvcm_msgsvc
 Pointer to the message service;. More...
 
std::unique_ptr< MsgStreamm_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 Protected Attributes inherited from GaudiCommon< 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

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.

Attention
See the class GaudiCommon, which implements some of the common functionality between GaudiTool and GaudiAlgorithm
Author
Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru
Chris Jones Chris.nosp@m.toph.nosp@m.er.Ro.nosp@m.b.Jo.nosp@m.nes@c.nosp@m.ern..nosp@m.ch
Date
2003-07-07

Definition at line 97 of file GaudiTool.h.

Constructor & Destructor Documentation

GaudiTool::GaudiTool ( const std::string &  type,
const std::string &  name,
const IInterface parent 
)
protected

Standard constructor.

See also
AlgTool
Parameters
typetool type (useless)
nametool name
parentpointer to parent object (service, algorithm or tool)

Definition at line 138 of file GaudiTool.cpp.

141  : GaudiCommon<AlgTool> ( this_type , this_name , parent )
142  , m_local ( this_type + "/" + this_name )
143 {
144  declareProperty
145  ( "ContextService" ,
147  "The name of Algorithm Context Service" ) ;
148  // make instance counts
149  GaudiToolLocal::s_InstanceCounter.increment ( m_local ) ;
150 }
std::string m_contextSvcName
Algorithm Context Service.
Definition: GaudiTool.h:811
long increment(const std::string &object)
make the increment
Definition: GaudiTool.cpp:74
const std::string m_local
full tool name "type/name"
Definition: GaudiTool.h:821
GaudiTool::~GaudiTool ( )
overrideprotected

destructor, virtual and protected

Definition at line 154 of file GaudiTool.cpp.

155 {
156  GaudiToolLocal::s_InstanceCounter.decrement ( m_local ) ;
157 }
const std::string m_local
full tool name "type/name"
Definition: GaudiTool.h:821
long decrement(const std::string &object)
make the decrement
Definition: GaudiTool.cpp:76
GaudiTool::GaudiTool ( )
privatedelete

no default/copy constructor, no assignment

GaudiTool::GaudiTool ( const GaudiTool )
privatedelete
GaudiTool::GaudiTool ( const std::string &  type,
const std::string &  name,
const IInterface parent 
)
protected

Standard constructor.

See also
AlgTool
Parameters
typetool type (useless)
nametool name
parentpointer to parent object (service, algorithm or tool)
GaudiTool::~GaudiTool ( )
overrideprotected

destructor, virtual and protected

GaudiTool::GaudiTool ( )
privatedelete

no default/copy constructor, no assignment

GaudiTool::GaudiTool ( const GaudiTool )
privatedelete

Member Function Documentation

IChronoStatSvc * GaudiTool::chronoSvc ( ) const

accessor to Chrono & Stat Service

Returns
pointer to the Chrono & Stat Service

Definition at line 267 of file GaudiTool.cpp.

268 {
269  if ( !m_chronoSvc )
270  {
271  m_chronoSvc =
272  svc<IChronoStatSvc> ( GaudiToolServices::s_ChronoStatSvc , true ) ;
273  }
274  return m_chronoSvc ;
275 }
const std::string s_ChronoStatSvc
the default name for Chrono & Stat Service
Definition: GaudiTool.cpp:47
IChronoStatSvc * m_chronoSvc
pointer to Chrono & Stat Service
Definition: GaudiTool.h:803
IChronoStatSvc* GaudiTool::chronoSvc ( ) const

accessor to Chrono & Stat Service

Returns
pointer to the Chrono & Stat Service
IAlgContextSvc * GaudiTool::contextSvc ( ) const

acessor to the Algorithm Context Service

Returns
pointer to the Algorithm Context Service

Definition at line 290 of file GaudiTool.cpp.

291 {
292  if ( !m_contextSvc )
293  {
294  m_contextSvc = svc<IAlgContextSvc> ( m_contextSvcName , true ) ;
295  }
296  return m_contextSvc;
297 }
std::string m_contextSvcName
Algorithm Context Service.
Definition: GaudiTool.h:811
IAlgContextSvc * m_contextSvc
Algorithm Context Service.
Definition: GaudiTool.h:809
IAlgContextSvc* GaudiTool::contextSvc ( ) const

acessor to the Algorithm Context Service

Returns
pointer to the Algorithm Context Service
IDataProviderSvc* GaudiTool::detSvc ( ) const

accessor to detector service

Returns
pointer to detector service
IDataProviderSvc * GaudiTool::detSvc ( ) const

accessor to detector service

Returns
pointer to detector service

Definition at line 221 of file GaudiTool.cpp.

222 {
223  if ( !m_detSvc )
224  {
225  m_detSvc =
226  svc<IDataProviderSvc>( GaudiToolServices::s_DetectorDataSvc , true ) ;
227  }
228  return m_detSvc ;
229 }
IDataProviderSvc * m_detSvc
pointer to Detector Data Service
Definition: GaudiTool.h:801
const std::string s_DetectorDataSvc
the default name for Detector Data Service
Definition: GaudiTool.cpp:45
bool GaudiTool::enableSummary ( bool  value)
static

enable/disable summary

Definition at line 125 of file GaudiTool.cpp.

126 {
128  return summaryEnabled () ;
129 }
static bool s_enableSummary
enable printout of summary?
Definition: GaudiTool.h:826
static bool summaryEnabled()
is summary enabled?
Definition: GaudiTool.cpp:133
static bool GaudiTool::enableSummary ( bool  )
static

enable/disable summary

StatusCode GaudiTool::Error ( const std::string &  msg,
const StatusCode  st = StatusCode::FAILURE,
const size_t  mx = 10 
) const
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.

if( a < 0 ) { return Error("a is negative!") ;}
if( b < 0 ) { return Error("b is illegal!" , StatusCode(25) );
if( c < 0 )
{ return Error("c is negative" , StatusCode(35) , 50 );
See also
MsgStream
IMessageSvc
StatusCode
Parameters
msgError message
stStatusCode to return
mxMaximum number of printouts for this message
Returns
StatusCode

Definition at line 688 of file GaudiTool.h.

691  {
693  msg + getCurrentAlgName() : msg,
694  st, mx );
695  }
bool m_isPublic
Flag to say if the tool is a public or private tool.
Definition: GaudiTool.h:816
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.
std::string getCurrentAlgName() const
Returns the current active algorithm name via the context service.
Definition: GaudiTool.h:787
MsgStream & msg() const
shortcut for the method msgStream(MSG::INFO)
StatusCode GaudiTool::Error ( const std::string &  msg,
const StatusCode  st = StatusCode::FAILURE,
const size_t  mx = 10 
) const
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.

if( a < 0 ) { return Error("a is negative!") ;}
if( b < 0 ) { return Error("b is illegal!" , StatusCode(25) );
if( c < 0 )
{ return Error("c is negative" , StatusCode(35) , 50 );
See also
MsgStream
IMessageSvc
StatusCode
Parameters
msgError message
stStatusCode to return
mxMaximum number of printouts for this message
Returns
StatusCode

Definition at line 688 of file GaudiTool.h.

691  {
693  msg + getCurrentAlgName() : msg,
694  st, mx );
695  }
bool m_isPublic
Flag to say if the tool is a public or private tool.
Definition: GaudiTool.h:816
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.
std::string getCurrentAlgName() const
Returns the current active algorithm name via the context service.
Definition: GaudiTool.h:787
MsgStream & msg() const
shortcut for the method msgStream(MSG::INFO)
INTupleSvc * GaudiTool::evtColSvc ( ) const

Access the standard event collection service.

Returns
pointer to the event collection service

Definition at line 244 of file GaudiTool.cpp.

245 {
246  if ( !m_evtColSvc )
247  {
248  m_evtColSvc = svc< INTupleSvc > ( "EvtTupleSvc" , true ) ;
249  }
250  return m_evtColSvc ;
251 }
INTupleSvc * m_evtColSvc
pointer to the event tag collection service
Definition: GaudiTool.h:799
INTupleSvc* GaudiTool::evtColSvc ( ) const

Access the standard event collection service.

Returns
pointer to the event collection service
template<class TYPE >
bool GaudiTool::exist ( IDataProviderSvc svc,
const std::string &  location,
const bool  useRootInTES = true 
) const
inline

Check the existence of a data object or container in the Gaudi Transient Event Store.

bool a1 = exist<DataObject>( evtSvc(), "/Event/MyObject" ) ;
bool a2 = exist<MyHits> ( evtSvc(), "/Event/MyHits" ) ;
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Parameters
svcPointer to data service (data provider)
locationAddress in Gaudi Transient Event Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
Boolean indicating status of the request
Return values
trueData object or container exists and implements a proper interface
trueFailed to locate the data object or container

Definition at line 514 of file GaudiTool.h.

517  {
518  return GaudiCommon<AlgTool>::exist<TYPE> ( svc , location , useRootInTES ) ;
519  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
bool GaudiTool::exist ( IDataProviderSvc svc,
const std::string &  location,
const bool  useRootInTES = true 
) const
inline

Check the existence of a data object or container in the Gaudi Transient Event Store.

bool a1 = exist<DataObject>( evtSvc(), "/Event/MyObject" ) ;
bool a2 = exist<MyHits> ( evtSvc(), "/Event/MyHits" ) ;
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Parameters
svcPointer to data service (data provider)
locationAddress in Gaudi Transient Event Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
Boolean indicating status of the request
Return values
trueData object or container exists and implements a proper interface
trueFailed to locate the data object or container

Definition at line 514 of file GaudiTool.h.

517  {
518  return GaudiCommon<AlgTool>::exist<TYPE> ( svc , location , useRootInTES ) ;
519  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
bool GaudiTool::exist ( const std::string &  location,
const bool  useRootInTES = true 
) const
inline

Check the existence of a data object or container in the Gaudi Transient Event Store.

bool a1 = exist<DataObject>( "/Event/MyObject" ) ;
bool a2 = exist<MyHits> ( "/Event/MyHits" ) ;
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Parameters
locationAddress in Gaudi Transient Event Store
Returns
Boolean indicating status of the request
Return values
trueData object or container exists and implements a proper interface
trueFailed to locate the data object or container

Definition at line 544 of file GaudiTool.h.

546  {
547  return GaudiCommon<AlgTool>::exist<TYPE> ( evtSvc() , location , useRootInTES ) ;
548  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
template<class TYPE >
bool GaudiTool::exist ( const std::string &  location,
const bool  useRootInTES = true 
) const
inline

Check the existence of a data object or container in the Gaudi Transient Event Store.

bool a1 = exist<DataObject>( "/Event/MyObject" ) ;
bool a2 = exist<MyHits> ( "/Event/MyHits" ) ;
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Parameters
locationAddress in Gaudi Transient Event Store
Returns
Boolean indicating status of the request
Return values
trueData object or container exists and implements a proper interface
trueFailed to locate the data object or container

Definition at line 544 of file GaudiTool.h.

546  {
547  return GaudiCommon<AlgTool>::exist<TYPE> ( evtSvc() , location , useRootInTES ) ;
548  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
template<class TYPE >
bool GaudiTool::existDet ( IDataProviderSvc svc,
const std::string &  location 
) const
inline

Check the existence of detector objects in the Gaudi Transient Detector Store.

bool a1 = existDet<DataObject> ( detSvc(), "/dd/Structure/MyObject" ) ;
bool a2 = existDet<Material> ( detSvc(), "/dd/Structure/Material/Air" ) ;
Parameters
svcPointer to data service (data provider)
locationAddress in Gaudi Transient Detector Store
Returns
Boolean indicating status of the request
Return values
trueDetector object exists and implements a proper interface
falseFailed to locate the data object

Definition at line 567 of file GaudiTool.h.

569  {
570  return GaudiCommon<AlgTool>::exist<TYPE> ( svc , location , false ) ;
571  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
bool GaudiTool::existDet ( IDataProviderSvc svc,
const std::string &  location 
) const
inline

Check the existence of detector objects in the Gaudi Transient Detector Store.

bool a1 = existDet<DataObject> ( detSvc(), "/dd/Structure/MyObject" ) ;
bool a2 = existDet<Material> ( detSvc(), "/dd/Structure/Material/Air" ) ;
Parameters
svcPointer to data service (data provider)
locationAddress in Gaudi Transient Detector Store
Returns
Boolean indicating status of the request
Return values
trueDetector object exists and implements a proper interface
falseFailed to locate the data object

Definition at line 567 of file GaudiTool.h.

569  {
570  return GaudiCommon<AlgTool>::exist<TYPE> ( svc , location , false ) ;
571  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
bool GaudiTool::existDet ( const std::string &  location) const
inline

Check the existence of detector objects in the Gaudi Transient Detector Store.

bool a1 = existDet<DataObject> ( "/dd/Structure/MyObject" ) ;
bool a2 = existDet<Material> ( "/dd/Structure/Material/Air" ) ;
Parameters
locationAddress in Gaudi Transient Detector Store
Returns
Boolean indicating status of the request
Return values
trueDetector object exists and implements a proper interface
falseFailed to locate the data object

Definition at line 589 of file GaudiTool.h.

590  {
591  return GaudiCommon<AlgTool>::exist<TYPE> ( detSvc() , location , false ) ;
592  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
IDataProviderSvc * detSvc() const
accessor to detector service
Definition: GaudiTool.cpp:221
template<class TYPE >
bool GaudiTool::existDet ( const std::string &  location) const
inline

Check the existence of detector objects in the Gaudi Transient Detector Store.

bool a1 = existDet<DataObject> ( "/dd/Structure/MyObject" ) ;
bool a2 = existDet<Material> ( "/dd/Structure/Material/Air" ) ;
Parameters
locationAddress in Gaudi Transient Detector Store
Returns
Boolean indicating status of the request
Return values
trueDetector object exists and implements a proper interface
falseFailed to locate the data object

Definition at line 589 of file GaudiTool.h.

590  {
591  return GaudiCommon<AlgTool>::exist<TYPE> ( detSvc() , location , false ) ;
592  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
IDataProviderSvc * detSvc() const
accessor to detector service
Definition: GaudiTool.cpp:221
StatusCode GaudiTool::finalize ( )
override

standard finalization method

See also
AlgTool
IAlgTool
Returns
status code
StatusCode GaudiTool::finalize ( )
override

standard finalization method

See also
AlgTool
IAlgTool
Returns
status code

Definition at line 179 of file GaudiTool.cpp.

180 {
181  if ( msgLevel(MSG::DEBUG) )
182  debug() << " ==> Finalize the base class GaudiTool " << endmsg;
183 
184  // clear "explicit services"
185  m_detSvc = nullptr ;
186  m_chronoSvc = nullptr ;
187  m_incSvc = nullptr ;
188  m_histoSvc = nullptr ;
189 
190  // finalize the base class
192  if ( sc.isFailure() ) { return sc; }
193 
194  // Decrement the counter
195  GaudiToolLocal::s_FinalizeCounter.decrement( m_local ) ;
196 
197  // return
198  return sc;
199 }
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:244
StatusCode finalize() override
standard finalization method
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:86
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
IDataProviderSvc * m_detSvc
pointer to Detector Data Service
Definition: GaudiTool.h:801
IIncidentSvc * m_incSvc
pointer to Incident Service
Definition: GaudiTool.h:805
IChronoStatSvc * m_chronoSvc
pointer to Chrono & Stat Service
Definition: GaudiTool.h:803
const std::string m_local
full tool name "type/name"
Definition: GaudiTool.h:821
long decrement(const std::string &object)
make the decrement
Definition: GaudiTool.cpp:76
MSG::Level msgLevel() const
get the output level from the embedded MsgStream
IHistogramSvc * m_histoSvc
pointer for histogram service
Definition: GaudiTool.h:807
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::get ( IDataProviderSvc svc,
const std::string &  location,
const bool  useRootInTES = true 
) const
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

MCHits* hits = get<MCHits>( evtSvc() , "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
See also
IDataProviderSvc
SmartDataPtr
Exceptions
GaudiExceptionfor Invalid Data Provider Service
GaudiExceptionfor invalid/unavailable data
Parameters
svcPointer to data service (data provider)
locationdata location/address in Gaudi Transient Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
pointer to the data object

Definition at line 260 of file GaudiTool.h.

263  {
264  return GaudiCommon<AlgTool>::get<TYPE> ( svc , location , useRootInTES ) ;
265  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::get ( IDataProviderSvc svc,
const std::string &  location,
const bool  useRootInTES = true 
) const
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

MCHits* hits = get<MCHits>( evtSvc() , "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
See also
IDataProviderSvc
SmartDataPtr
Exceptions
GaudiExceptionfor Invalid Data Provider Service
GaudiExceptionfor invalid/unavailable data
Parameters
svcPointer to data service (data provider)
locationdata location/address in Gaudi Transient Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
pointer to the data object

Definition at line 260 of file GaudiTool.h.

263  {
264  return GaudiCommon<AlgTool>::get<TYPE> ( svc , location , useRootInTES ) ;
265  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::get ( const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MCParticles* mcps = get<MCParticles>( MCParticleLocation::Default );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Parameters
locationData location/address in Gaudi Transient Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
Pointer to the data object

Definition at line 336 of file GaudiTool.h.

338  {
339  return GaudiCommon<AlgTool>::get<TYPE> ( evtSvc() , location , useRootInTES ) ;
340  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::get ( const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MCParticles* mcps = get<MCParticles>( MCParticleLocation::Default );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Parameters
locationData location/address in Gaudi Transient Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
Pointer to the data object

Definition at line 336 of file GaudiTool.h.

338  {
339  return GaudiCommon<AlgTool>::get<TYPE> ( evtSvc() , location , useRootInTES ) ;
340  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
std::string GaudiTool::getCurrentAlgName ( ) const
inlineprivate

Returns the current active algorithm name via the context service.

Definition at line 787 of file GaudiTool.h.

788  {
789  const IAlgContextSvc * asvc = this->contextSvc();
790  const IAlgorithm * current = ( asvc ? asvc->currentAlg() : NULL );
791  return ( current ? " [" + current->name() + "]" : "" );
792  }
IAlgContextSvc * contextSvc() const
acessor to the Algorithm Context Service
Definition: GaudiTool.cpp:290
The IAlgorithm is the interface implemented by the Algorithm base class.
Definition: IAlgorithm.h:23
An abstract interface for Algorithm Context Service.
virtual IAlgorithm * currentAlg() const =0
accessor to current algorithm:
std::string GaudiTool::getCurrentAlgName ( ) const
inlineprivate

Returns the current active algorithm name via the context service.

Definition at line 787 of file GaudiTool.h.

788  {
789  const IAlgContextSvc * asvc = this->contextSvc();
790  const IAlgorithm * current = ( asvc ? asvc->currentAlg() : NULL );
791  return ( current ? " [" + current->name() + "]" : "" );
792  }
IAlgContextSvc * contextSvc() const
acessor to the Algorithm Context Service
Definition: GaudiTool.cpp:290
The IAlgorithm is the interface implemented by the Algorithm base class.
Definition: IAlgorithm.h:23
An abstract interface for Algorithm Context Service.
virtual IAlgorithm * currentAlg() const =0
accessor to current algorithm:
template<class TYPE >
TYPE* GaudiTool::getDet ( IDataProviderSvc svc,
const std::string &  location 
) const
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.

MyDet* mdet = getDet<MyDet>( detSvc() , "/dd/Structure/LHCb/MyDet" );
Parameters
svcPointer to data service (data provider)
locationDetector location/address in Gaudi Transient Store
Returns
Pointer to the detector object

Definition at line 401 of file GaudiTool.h.

403  {
404  return GaudiCommon<AlgTool>::get<TYPE> ( svc , location , false ) ;
405  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
TYPE* GaudiTool::getDet ( IDataProviderSvc svc,
const std::string &  location 
) const
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.

MyDet* mdet = getDet<MyDet>( detSvc() , "/dd/Structure/LHCb/MyDet" );
Parameters
svcPointer to data service (data provider)
locationDetector location/address in Gaudi Transient Store
Returns
Pointer to the detector object

Definition at line 401 of file GaudiTool.h.

403  {
404  return GaudiCommon<AlgTool>::get<TYPE> ( svc , location , false ) ;
405  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
TYPE* GaudiTool::getDet ( const std::string &  location) const
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.

MyDet* mdet = getDet<MyDet>( "/dd/Structure/LHCb/MyDet" );
Parameters
locationDetector location/address in Gaudi Transient Store
Returns
Pointer to the detector object

Definition at line 455 of file GaudiTool.h.

456  {
457  return GaudiCommon<AlgTool>::get<TYPE> ( detSvc() , location , false ) ;
458  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
IDataProviderSvc * detSvc() const
accessor to detector service
Definition: GaudiTool.cpp:221
template<class TYPE >
TYPE* GaudiTool::getDet ( const std::string &  location) const
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.

MyDet* mdet = getDet<MyDet>( "/dd/Structure/LHCb/MyDet" );
Parameters
locationDetector location/address in Gaudi Transient Store
Returns
Pointer to the detector object

Definition at line 455 of file GaudiTool.h.

456  {
457  return GaudiCommon<AlgTool>::get<TYPE> ( detSvc() , location , false ) ;
458  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
IDataProviderSvc * detSvc() const
accessor to detector service
Definition: GaudiTool.cpp:221
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getDetIfExists ( IDataProviderSvc svc,
const std::string &  location 
) const
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.

MyDet* mdet = getDetIfExists<MyDet>( detSvc() , "/dd/Structure/LHCb/MyDet" );
Parameters
svcPointer to data service (data provider)
locationDetector location/address in Gaudi Transient Store
Returns
Pointer to the detector object
Return values
NULLIf the detector object does not exist.

Definition at line 431 of file GaudiTool.h.

433  {
434  return GaudiCommon<AlgTool>::getIfExists<TYPE> ( svc , location , false ) ;
435  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getDetIfExists ( IDataProviderSvc svc,
const std::string &  location 
) const
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.

MyDet* mdet = getDetIfExists<MyDet>( detSvc() , "/dd/Structure/LHCb/MyDet" );
Parameters
svcPointer to data service (data provider)
locationDetector location/address in Gaudi Transient Store
Returns
Pointer to the detector object
Return values
NULLIf the detector object does not exist.

Definition at line 431 of file GaudiTool.h.

433  {
434  return GaudiCommon<AlgTool>::getIfExists<TYPE> ( svc , location , false ) ;
435  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getDetIfExists ( const std::string &  location) const
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.

MyDet* mdet = getDetIfExists<MyDet>( "/dd/Structure/LHCb/MyDet" );
Parameters
locationDetector location/address in Gaudi Transient Store
Returns
Pointer to the detector object
Return values
NULLIf the detector object does not exist.

Definition at line 483 of file GaudiTool.h.

484  {
485  return GaudiCommon<AlgTool>::getIfExists<TYPE> ( detSvc() , location , false ) ;
486  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
IDataProviderSvc * detSvc() const
accessor to detector service
Definition: GaudiTool.cpp:221
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getDetIfExists ( const std::string &  location) const
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.

MyDet* mdet = getDetIfExists<MyDet>( "/dd/Structure/LHCb/MyDet" );
Parameters
locationDetector location/address in Gaudi Transient Store
Returns
Pointer to the detector object
Return values
NULLIf the detector object does not exist.

Definition at line 483 of file GaudiTool.h.

484  {
485  return GaudiCommon<AlgTool>::getIfExists<TYPE> ( detSvc() , location , false ) ;
486  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
IDataProviderSvc * detSvc() const
accessor to detector service
Definition: GaudiTool.cpp:221
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getIfExists ( IDataProviderSvc svc,
const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MCHits* hits = getIfExists<MCHits>( evtSvc() , "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
See also
IDataProviderSvc
SmartDataPtr
Parameters
svcPointer to data service (data provider)
locationdata location/address in Gaudi Transient Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
pointer to the data object.
Return values
NULLIf data does not exist.

Definition at line 302 of file GaudiTool.h.

305  {
306  return GaudiCommon<AlgTool>::getIfExists<TYPE> ( svc , location , useRootInTES ) ;
307  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getIfExists ( IDataProviderSvc svc,
const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MCHits* hits = getIfExists<MCHits>( evtSvc() , "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
See also
IDataProviderSvc
SmartDataPtr
Parameters
svcPointer to data service (data provider)
locationdata location/address in Gaudi Transient Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
pointer to the data object.
Return values
NULLIf data does not exist.

Definition at line 302 of file GaudiTool.h.

305  {
306  return GaudiCommon<AlgTool>::getIfExists<TYPE> ( svc , location , useRootInTES ) ;
307  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getIfExists ( const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MCHits* hits = getIfExists<MCHits>( "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
See also
IDataProviderSvc
SmartDataPtr
Parameters
locationdata location/address in Gaudi Transient Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
pointer to the data object.
Return values
NULLIf data does not exist.

Definition at line 376 of file GaudiTool.h.

378  {
379  return GaudiCommon<AlgTool>::getIfExists<TYPE> ( evtSvc() , location , useRootInTES ) ;
380  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
template<class TYPE >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getIfExists ( const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MCHits* hits = getIfExists<MCHits>( "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
See also
IDataProviderSvc
SmartDataPtr
Parameters
locationdata location/address in Gaudi Transient Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
pointer to the data object.
Return values
NULLIf data does not exist.

Definition at line 376 of file GaudiTool.h.

378  {
379  return GaudiCommon<AlgTool>::getIfExists<TYPE> ( evtSvc() , location , useRootInTES ) ;
380  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getOrCreate ( IDataProviderSvc svc,
const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MyHits* hits = getOrCreate<MyHits,MyHits>( evtSvc() , "/Event/MyHits" ) ;
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Exceptions
GaudiExceptionfor Invalid Data Provider Service
GaudiExceptionfor invalid/unavailable data
Parameters
svcPointer to data service (data provider)
locationLocation in Gaudi Transient Event Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
A valid pointer to the object

Definition at line 622 of file GaudiTool.h.

625  {
626  return GaudiCommon<AlgTool>::getOrCreate<TYPE,TYPE2> ( svc , location , useRootInTES ) ;
627  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getOrCreate ( IDataProviderSvc svc,
const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MyHits* hits = getOrCreate<MyHits,MyHits>( evtSvc() , "/Event/MyHits" ) ;
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Exceptions
GaudiExceptionfor Invalid Data Provider Service
GaudiExceptionfor invalid/unavailable data
Parameters
svcPointer to data service (data provider)
locationLocation in Gaudi Transient Event Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
A valid pointer to the object

Definition at line 622 of file GaudiTool.h.

625  {
626  return GaudiCommon<AlgTool>::getOrCreate<TYPE,TYPE2> ( svc , location , useRootInTES ) ;
627  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
SmartIF< SERVICE > svc(const std::string &name, const bool create=true) const
A useful method for the easy location of services.
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getOrCreate ( const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MyHits* hits = getOrCreate<MyHits,MyHits>( "/Event/MyHits" ) ;
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Exceptions
GaudiExceptionfor Invalid Data Provider Service
GaudiExceptionfor invalid/unavailable data
Parameters
locationLocation in Gaudi Transient Event Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
A valid pointer to the object

Definition at line 656 of file GaudiTool.h.

658  {
659  return GaudiCommon<AlgTool>::getOrCreate<TYPE,TYPE2> ( evtSvc() , location , useRootInTES ) ;
660  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData<TYPE>::return_type GaudiTool::getOrCreate ( const std::string &  location,
const bool  useRootInTES = true 
) const
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.

MyHits* hits = getOrCreate<MyHits,MyHits>( "/Event/MyHits" ) ;
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Exceptions
GaudiExceptionfor Invalid Data Provider Service
GaudiExceptionfor invalid/unavailable data
Parameters
locationLocation in Gaudi Transient Event Store
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Returns
A valid pointer to the object

Definition at line 656 of file GaudiTool.h.

658  {
659  return GaudiCommon<AlgTool>::getOrCreate<TYPE,TYPE2> ( evtSvc() , location , useRootInTES ) ;
660  }
Implements the common functionality between GaudiTools and GaudiAlgorithms.
Definition: GaudiCommon.h:74
IHistogramSvc * GaudiTool::histoSvc ( ) const

acessor to the histogram service

Returns
pointer to the histogram service

Definition at line 279 of file GaudiTool.cpp.

280 {
281  if ( !m_histoSvc )
282  {
283  m_histoSvc = svc<IHistogramSvc> ( GaudiToolServices::s_HistoSvc, true ) ;
284  }
285  return m_histoSvc;
286 }
const std::string s_HistoSvc
the default name for Histogram Service
Definition: GaudiTool.cpp:51
IHistogramSvc * m_histoSvc
pointer for histogram service
Definition: GaudiTool.h:807
IHistogramSvc* GaudiTool::histoSvc ( ) const

acessor to the histogram service

Returns
pointer to the histogram service
IIncidentSvc* GaudiTool::incSvc ( ) const

accessor to Incident Service

Returns
pointer to the Incident Service
IIncidentSvc * GaudiTool::incSvc ( ) const

accessor to Incident Service

Returns
pointer to the Incident Service

Definition at line 255 of file GaudiTool.cpp.

256 {
257  if ( !m_incSvc )
258  {
259  m_incSvc =
260  svc<IIncidentSvc> ( GaudiToolServices::s_IncidentSvc , true ) ;
261  }
262  return m_incSvc ;
263 }
const std::string s_IncidentSvc
the default name for Incident Service
Definition: GaudiTool.cpp:49
IIncidentSvc * m_incSvc
pointer to Incident Service
Definition: GaudiTool.h:805
StatusCode GaudiTool::Info ( const std::string &  msg,
const StatusCode  st = StatusCode::SUCCESS,
const size_t  mx = 10 
) const
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.

See also
MsgStream
IMessageSvc
StatusCode
GaudiCommon::Warning
Parameters
msgInfo message
stStatusCode to return
mxMaximum number of printouts for this message
Returns
The given StatusCode

Definition at line 744 of file GaudiTool.h.

747  {
749  msg + getCurrentAlgName() : msg,
750  st, mx );
751  }
bool m_isPublic
Flag to say if the tool is a public or private tool.
Definition: GaudiTool.h:816
std::string getCurrentAlgName() const
Returns the current active algorithm name via the context service.
Definition: GaudiTool.h:787
MsgStream & msg() const
shortcut for the method msgStream(MSG::INFO)
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.
StatusCode GaudiTool::Info ( const std::string &  msg,
const StatusCode  st = StatusCode::SUCCESS,
const size_t  mx = 10 
) const
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.

See also
MsgStream
IMessageSvc
StatusCode
GaudiCommon::Warning
Parameters
msgInfo message
stStatusCode to return
mxMaximum number of printouts for this message
Returns
The given StatusCode

Definition at line 744 of file GaudiTool.h.

747  {
749  msg + getCurrentAlgName() : msg,
750  st, mx );
751  }
bool m_isPublic
Flag to say if the tool is a public or private tool.
Definition: GaudiTool.h:816
std::string getCurrentAlgName() const
Returns the current active algorithm name via the context service.
Definition: GaudiTool.h:787
MsgStream & msg() const
shortcut for the method msgStream(MSG::INFO)
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.
StatusCode GaudiTool::initialize ( )
override

standard initialization method

See also
AlgTool
IAlgTool
Returns
status code
StatusCode GaudiTool::initialize ( )
override

standard initialization method

See also
AlgTool
IAlgTool
Returns
status code

Definition at line 161 of file GaudiTool.cpp.

162 {
163  // initialize the base class
165  if ( sc.isFailure() ) { return sc; }
166 
167  // increment the counter
168  GaudiToolLocal::s_FinalizeCounter.increment( m_local ) ;
169 
170  // are we a public tool ?
171  m_isPublic = isPublic();
172 
173  // return
174  return sc;
175 }
bool m_isPublic
Flag to say if the tool is a public or private tool.
Definition: GaudiTool.h:816
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:86
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
bool isPublic() const
Determines if this tool is public or not (i.e. owned by the ToolSvc).
Definition: GaudiTool.cpp:203
long increment(const std::string &object)
make the increment
Definition: GaudiTool.cpp:74
StatusCode initialize() override
standard initialization method
const std::string m_local
full tool name "type/name"
Definition: GaudiTool.h:821
bool GaudiTool::isPublic ( ) const
private

Determines if this tool is public or not (i.e. owned by the ToolSvc).

Definition at line 203 of file GaudiTool.cpp.

204 {
205  const IAlgTool * tool = this;
206  // Recurse down the ownership tree, to see with we ever end up at the ToolSvc
207  bool ownedByToolSvc = false;
208  unsigned int sanityCheck(0);
209  while ( tool && ++sanityCheck < 99999 )
210  {
211  ownedByToolSvc = ( nullptr != dynamic_cast<const IToolSvc*>(tool->parent()) );
212  if ( ownedByToolSvc ) { break; }
213  // if parent is also a tool, try again
214  tool = dynamic_cast<const IAlgTool*>(tool->parent());
215  }
216  return ownedByToolSvc;
217 }
The interface implemented by the IToolSvc base class.
Definition: IToolSvc.h:18
virtual const IInterface * parent() const =0
The parent of the concrete AlgTool.
The interface implemented by the AlgTool base class.
Definition: IAlgTool.h:23
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.
bool GaudiTool::isPublic ( ) const
private

Determines if this tool is public or not (i.e. owned by the ToolSvc).

INTupleSvc* GaudiTool::ntupleSvc ( ) const

Access the standard N-Tuple.

Returns
pointer to N-Tuple service .
INTupleSvc * GaudiTool::ntupleSvc ( ) const

Access the standard N-Tuple.

Returns
pointer to N-Tuple service .

Definition at line 233 of file GaudiTool.cpp.

234 {
235  if ( !m_ntupleSvc )
236  {
237  m_ntupleSvc = svc<INTupleSvc>( "NTupleSvc" , true ) ;
238  }
239  return m_ntupleSvc ;
240 }
INTupleSvc * m_ntupleSvc
pointer to the N-Tuple service
Definition: GaudiTool.h:797
GaudiTool& GaudiTool::operator= ( const GaudiTool )
privatedelete
GaudiTool& GaudiTool::operator= ( const GaudiTool )
privatedelete
DataObject* GaudiTool::put ( IDataProviderSvc svc,
DataObject object,
const std::string &  address,
const bool  useRootInTES = true 
) const
inline

Register a data object or container into Gaudi Event Transient Store.

MCHits * hits = new MCHits();
put( evtSvc(), hits, "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
See also
IDataProviderSvc
Parameters
svcPointer to data provider service
objectData object or container to be registered
addressAddress in Gaudi Event Transient Store ("/Event" could be omitted )
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Exceptions
GaudiExceptionfor invalid event data service
GaudiExceptionfor invalid object
GaudiExceptionfor error result from event data service
Returns
StatusCode
Return values
StatusCode::SUCCESSData was successfully placed in the TES.
StatusCode::FAILUREFailed to store data in the TES.

Definition at line 184 of file GaudiTool.h.

188  {
189  return GaudiCommon<AlgTool>::put ( svc , object , address , useRootInTES ) ;
190  }
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.
DataObject* GaudiTool::put ( IDataProviderSvc svc,
DataObject object,
const std::string &  address,
const bool  useRootInTES = true 
) const
inline

Register a data object or container into Gaudi Event Transient Store.

MCHits * hits = new MCHits();
put( evtSvc(), hits, "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
See also
IDataProviderSvc
Parameters
svcPointer to data provider service
objectData object or container to be registered
addressAddress in Gaudi Event Transient Store ("/Event" could be omitted )
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Exceptions
GaudiExceptionfor invalid event data service
GaudiExceptionfor invalid object
GaudiExceptionfor error result from event data service
Returns
StatusCode
Return values
StatusCode::SUCCESSData was successfully placed in the TES.
StatusCode::FAILUREFailed to store data in the TES.

Definition at line 184 of file GaudiTool.h.

188  {
189  return GaudiCommon<AlgTool>::put ( svc , object , address , useRootInTES ) ;
190  }
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.
DataObject* GaudiTool::put ( DataObject object,
const std::string &  address,
const bool  useRootInTES = true 
) const
inline

Register a data object or container into Gaudi Event Transient Store.

See also
IDataProviderSvc
MCHits * hits = put( new MCHits(), "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Parameters
objectData object or container to be registered
addressAddress in Gaudi Event Transient Store ("/Event" could be omitted )
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Exceptions
GaudiExceptionfor invalid event data service
GaudiExceptionfor invalid object
GaudiExceptionfor error result from event data service
Returns
StatusCode
Return values
StatusCode::SUCCESSData was successfully placed in the TES.
StatusCode::FAILUREFailed to store data in the TES.

Definition at line 220 of file GaudiTool.h.

223  {
224  return GaudiCommon<AlgTool>::put ( evtSvc() , object , address , useRootInTES ) ;
225  }
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.
DataObject* GaudiTool::put ( DataObject object,
const std::string &  address,
const bool  useRootInTES = true 
) const
inline

Register a data object or container into Gaudi Event Transient Store.

See also
IDataProviderSvc
MCHits * hits = put( new MCHits(), "/Event/MC/Hits" );
Attention
The method respects the setting of the job option RootInTES by prepending the value of this to the data location that is passed. The default setting for RootInTES is "" so has no effect. This behavior can be suppressed by passing the argument useRootInTES = false
Parameters
objectData object or container to be registered
addressAddress in Gaudi Event Transient Store ("/Event" could be omitted )
useRootInTESFlag to turn on(TRUE) off(FALSE) the use of the RootInTES location property
Exceptions
GaudiExceptionfor invalid event data service
GaudiExceptionfor invalid object
GaudiExceptionfor error result from event data service
Returns
StatusCode
Return values
StatusCode::SUCCESSData was successfully placed in the TES.
StatusCode::FAILUREFailed to store data in the TES.

Definition at line 220 of file GaudiTool.h.

223  {
224  return GaudiCommon<AlgTool>::put ( evtSvc() , object , address , useRootInTES ) ;
225  }
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.
static bool GaudiTool::summaryEnabled ( )
static

is summary enabled?

bool GaudiTool::summaryEnabled ( )
static

is summary enabled?

Definition at line 133 of file GaudiTool.cpp.

134 { return s_enableSummary ; }
static bool s_enableSummary
enable printout of summary?
Definition: GaudiTool.h:826
StatusCode GaudiTool::Warning ( const std::string &  msg,
const StatusCode  st = StatusCode::FAILURE,
const size_t  mx = 10 
) const
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.

if( a < 0 ) { return Warning("a is negative!") ;}
if( b < 0 ) { return Warning("b is illegal!" , StatusCode(25) );
if( c < 0 )
{ return Warning("c is negative" , StatusCode(35) , 50 );
See also
MsgStream
IMessageSvc
StatusCode
Parameters
msgWarning message
stStatusCode to return
mxMaximum number of printouts for this message
Returns
The given StatusCode

Definition at line 720 of file GaudiTool.h.

723  {
725  msg + getCurrentAlgName() : msg,
726  st, mx );
727  }
bool m_isPublic
Flag to say if the tool is a public or private tool.
Definition: GaudiTool.h:816
std::string getCurrentAlgName() const
Returns the current active algorithm name via the context service.
Definition: GaudiTool.h:787
MsgStream & msg() const
shortcut for the method msgStream(MSG::INFO)
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.
StatusCode GaudiTool::Warning ( const std::string &  msg,
const StatusCode  st = StatusCode::FAILURE,
const size_t  mx = 10 
) const
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.

if( a < 0 ) { return Warning("a is negative!") ;}
if( b < 0 ) { return Warning("b is illegal!" , StatusCode(25) );
if( c < 0 )
{ return Warning("c is negative" , StatusCode(35) , 50 );
See also
MsgStream
IMessageSvc
StatusCode
Parameters
msgWarning message
stStatusCode to return
mxMaximum number of printouts for this message
Returns
The given StatusCode

Definition at line 720 of file GaudiTool.h.

723  {
725  msg + getCurrentAlgName() : msg,
726  st, mx );
727  }
bool m_isPublic
Flag to say if the tool is a public or private tool.
Definition: GaudiTool.h:816
std::string getCurrentAlgName() const
Returns the current active algorithm name via the context service.
Definition: GaudiTool.h:787
MsgStream & msg() const
shortcut for the method msgStream(MSG::INFO)
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.

Member Data Documentation

IChronoStatSvc * GaudiTool::m_chronoSvc = nullptr
mutableprivate

pointer to Chrono & Stat Service

Definition at line 803 of file GaudiTool.h.

IAlgContextSvc * GaudiTool::m_contextSvc = nullptr
mutableprivate

Algorithm Context Service.

Definition at line 809 of file GaudiTool.h.

std::string GaudiTool::m_contextSvcName = "AlgContextSvc"
private

Algorithm Context Service.

Definition at line 811 of file GaudiTool.h.

IDataProviderSvc * GaudiTool::m_detSvc = nullptr
mutableprivate

pointer to Detector Data Service

Definition at line 801 of file GaudiTool.h.

INTupleSvc * GaudiTool::m_evtColSvc = nullptr
mutableprivate

pointer to the event tag collection service

Definition at line 799 of file GaudiTool.h.

IHistogramSvc * GaudiTool::m_histoSvc = nullptr
mutableprivate

pointer for histogram service

Definition at line 807 of file GaudiTool.h.

IIncidentSvc * GaudiTool::m_incSvc = nullptr
mutableprivate

pointer to Incident Service

Definition at line 805 of file GaudiTool.h.

bool GaudiTool::m_isPublic = false
private

Flag to say if the tool is a public or private tool.

Definition at line 816 of file GaudiTool.h.

const std::string GaudiTool::m_local
private

full tool name "type/name"

Definition at line 821 of file GaudiTool.h.

INTupleSvc * GaudiTool::m_ntupleSvc = nullptr
mutableprivate

pointer to the N-Tuple service

Definition at line 797 of file GaudiTool.h.

static bool GaudiTool::s_enableSummary = true
staticprivate

enable printout of summary?

summary is enabled

Definition at line 826 of file GaudiTool.h.


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