Auditor Class Reference

Base class from which all concrete auditor classes should be derived. More...

#include <GaudiKernel/Auditor.h>

Inheritance diagram for Auditor:

Collaboration diagram for Auditor:

Public Types
typedef Gaudi::PluginService::Factory< IAuditor *, const std::string &, ISvcLocator * >	Factory
Public Types inherited from CommonMessaging< implements< IAuditor, IProperty > >
using	base_class = CommonMessaging

Public Member Functions
	Auditor (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...
	~Auditor () override=default
	Destructor. More...
StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...
StatusCode	sysFinalize () override
	Finalization method invoked by the framework. More...
void	before (StandardEventType, INamedInterface *) override
	The following methods are meant to be implemented by the child class... More...
void	before (StandardEventType, const std::string &) override
void	before (CustomEventTypeRef, INamedInterface *) override
void	before (CustomEventTypeRef, const std::string &) override
void	after (StandardEventType, INamedInterface *, const StatusCode &) override
void	after (StandardEventType, const std::string &, const StatusCode &) override
void	after (CustomEventTypeRef, INamedInterface *, const StatusCode &) override
void	after (CustomEventTypeRef, const std::string &, const StatusCode &) override
void	beforeInitialize (INamedInterface *) override
void	afterInitialize (INamedInterface *) override
void	beforeReinitialize (INamedInterface *) override
void	afterReinitialize (INamedInterface *) override
void	beforeExecute (INamedInterface *) override
void	afterExecute (INamedInterface *, const StatusCode &) override
void	beforeFinalize (INamedInterface *) override
void	afterFinalize (INamedInterface *) override
void	beforeBeginRun (INamedInterface *) override
void	afterBeginRun (INamedInterface *) override
void	beforeEndRun (INamedInterface *) override
void	afterEndRun (INamedInterface *) override
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
const std::string &	name () const override
bool	isEnabled () const override
SmartIF< ISvcLocator > &	serviceLocator () const
	The standard service locator. More...
template<class T >
StatusCode	service (const std::string &name, T *&svc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T = IService>
SmartIF< T >	service (const std::string &name, bool createIf=false) const
StatusCode	setProperty (const Property &p) override
	Set a value of a property of an auditor. More...
StatusCode	setProperty (const std::string &s) override
	Implementation of IProperty::setProperty. More...
StatusCode	setProperty (const std::string &n, const std::string &v) override
	Implementation of IProperty::setProperty. More...
StatusCode	getProperty (Property *p) const override
	Get the value of a property. More...
const Property &	getProperty (const std::string &name) const override
	Get the property by name. More...
StatusCode	getProperty (const std::string &n, std::string &v) const override
	Implementation of IProperty::getProperty. More...
const std::vector< Property * > &	getProperties () const override
	Get all properties. More...
bool	hasProperty (const std::string &name) const override
	Implementation of IProperty::hasProperty. More...
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
StatusCode	setProperties ()
	Set the auditor's properties. More...
template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=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...
MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Private Member Functions
	Auditor (const Auditor &a)
Auditor &	operator= (const Auditor &rhs)

Private Attributes
std::string	m_name
	Auditor's name for identification. More...
SmartIF< ISvcLocator >	m_pSvcLocator
	Pointer to service locator service. More...
SmartIF< PropertyMgr >	m_PropertyMgr
	For management of properties. More...
int	m_outputLevel
	Auditor output level. More...
bool	m_isEnabled
	Auditor is enabled flag. More...
bool	m_isInitialized
	Auditor has been initialized flag. More...
bool	m_isFinalized
	Auditor has been finalized flag. More...

Additional Inherited Members
Protected Member Functions inherited from CommonMessaging< implements< IAuditor, IProperty > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Detailed Description

Base class from which all concrete auditor classes should be derived.

The only base class functionality which may be used in the constructor of a concrete auditor is the declaration of member variables as properties. All other functionality, i.e. the use of services, may be used only in initialize() and afterwards.

Author

David Quarrie

Date

2000

Author

Marco Clemencic

Date

2008-03

Definition at line 35 of file Auditor.h.

Member Typedef Documentation

typedef Gaudi::PluginService::Factory<IAuditor*, const std::string&, ISvcLocator*> Auditor::Factory

Definition at line 41 of file Auditor.h.

Constructor & Destructor Documentation

Auditor::Auditor	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Constructor.

Parameters

name	The algorithm object's name
svcloc	A pointer to a service location service

Definition at line 12 of file Auditor.cpp.

: m_name(name),
  m_pSvcLocator(pSvcLocator),
  m_PropertyMgr{ new PropertyMgr() },
  m_isEnabled(true),
  m_isInitialized(false),
  m_isFinalized(false)
{

  // Declare common Auditor properties with their defaults
  declareProperty( "OutputLevel", m_outputLevel = MSG::NIL)->declareUpdateHandler([this](Property&) { this->updateMsgStreamOutputLevel(this->m_outputLevel); } );
  declareProperty( "Enable", m_isEnabled = true);
}

Auditor::~Auditor ( )

overridedefault

Destructor.

Auditor::Auditor ( const Auditor &  a )

private

Member Function Documentation

void Auditor::after ( StandardEventType  evt, INamedInterface *  obj, const StatusCode &  sc  )

override

Definition at line 107 of file Auditor.cpp.

                                                                                    {
  switch (evt) {
  case Initialize:   afterInitialize(obj);   break;
  case ReInitialize: afterReinitialize(obj); break;
  case Execute:      afterExecute(obj, sc);  break;
  case BeginRun:     afterBeginRun(obj);     break;
  case EndRun:       afterEndRun(obj);       break;
  case Finalize:     afterFinalize(obj);     break;
  case Start:        break;
  case Stop:         break;
  case ReStart:      break;
  default: break ;// do nothing
  }
}

void Auditor::after ( StandardEventType  , const std::string &  , const StatusCode &    )

override

Definition at line 121 of file Auditor.cpp.

{}

void Auditor::after ( CustomEventTypeRef  , INamedInterface *  , const StatusCode &    )

override

Definition at line 123 of file Auditor.cpp.

{}

void Auditor::after ( CustomEventTypeRef  , const std::string &  , const StatusCode &    )

override

Definition at line 124 of file Auditor.cpp.

{}

void Auditor::afterBeginRun ( INamedInterface *  )

override

Definition at line 140 of file Auditor.cpp.

{}

void Auditor::afterEndRun ( INamedInterface *  )

override

Definition at line 144 of file Auditor.cpp.

{}

void Auditor::afterExecute ( INamedInterface *  , const StatusCode &    )

override

Definition at line 136 of file Auditor.cpp.

{}

void Auditor::afterFinalize ( INamedInterface *  )

override

Definition at line 148 of file Auditor.cpp.

{}

void Auditor::afterInitialize ( INamedInterface *  )

override

Definition at line 128 of file Auditor.cpp.

{}

void Auditor::afterReinitialize ( INamedInterface *  )

override

Definition at line 132 of file Auditor.cpp.

{}

void Auditor::before ( StandardEventType  evt, INamedInterface *  obj  )

override

The following methods are meant to be implemented by the child class...

Definition at line 87 of file Auditor.cpp.

                                                               {
  switch (evt) {
  case Initialize:   beforeInitialize(obj);   break;
  case ReInitialize: beforeReinitialize(obj); break;
  case Execute:      beforeExecute(obj);      break;
  case BeginRun:     beforeBeginRun(obj);     break;
  case EndRun:       beforeEndRun(obj);       break;
  case Finalize:     beforeFinalize(obj);     break;
  case Start:        break;
  case Stop:         break;
  case ReStart:      break;
  default: break ;// do nothing
  }
}

void Auditor::before ( StandardEventType  , const std::string &    )

override

Definition at line 101 of file Auditor.cpp.

{}

void Auditor::before ( CustomEventTypeRef  , INamedInterface *    )

override

Definition at line 103 of file Auditor.cpp.

{}

void Auditor::before ( CustomEventTypeRef  , const std::string &    )

override

Definition at line 104 of file Auditor.cpp.

{}

void Auditor::beforeBeginRun ( INamedInterface *  )

override

Definition at line 138 of file Auditor.cpp.

{}

void Auditor::beforeEndRun ( INamedInterface *  )

override

Definition at line 142 of file Auditor.cpp.

{}

void Auditor::beforeExecute ( INamedInterface *  )

override

Definition at line 134 of file Auditor.cpp.

{}

void Auditor::beforeFinalize ( INamedInterface *  )

override

Definition at line 146 of file Auditor.cpp.

{}

void Auditor::beforeInitialize ( INamedInterface *  )

override

Definition at line 126 of file Auditor.cpp.

{}

void Auditor::beforeReinitialize ( INamedInterface *  )

override

Definition at line 130 of file Auditor.cpp.

{}

template<class T >

Property* Auditor::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  ) const

inline

Declare the named property.

MyAuditor( ... )
   : Auditor ( ...  )
   , m_property1   ( ... )
   , m_property2   ( ... )
 {
   // declare the property
   declareProperty( "Property1" , m_property1 , "Doc for property #1" ) ;

   // declare the property and attach the handler to it
   declareProperty( "Property2" , m_property2 , "Doc for property #2" )
      -> declareUpdateHandler( &MyAuditor::handler_2 ) ;

 }

See also

PropertyMgr

PropertyMgr::declareProperty

Parameters

name	the property name
property	the property itself,
doc	the documentation string

Returns

the actual property objects

Definition at line 232 of file Auditor.h.

                                                      {
    return m_PropertyMgr->declareProperty(name, property, doc);
  }

StatusCode Auditor::finalize ( )

virtual

Reimplemented in PerfMonAuditor, Google::AuditorBase, TimingAuditor, AlgContextAuditor, and AlgErrorAuditor.

Definition at line 198 of file Auditor.cpp.

                             {
  return StatusCode::SUCCESS;
}

const std::vector< Property * > & Auditor::getProperties ( ) const

override

Get all properties.

Definition at line 245 of file Auditor.cpp.

                                                          {
  return m_PropertyMgr->getProperties();
}

StatusCode Auditor::getProperty ( Property *  p ) const

override

Get the value of a property.

Definition at line 236 of file Auditor.cpp.

                                                 {
  return m_PropertyMgr->getProperty(p);
}

const Property & Auditor::getProperty ( const std::string &  name ) const

override

Get the property by name.

Definition at line 239 of file Auditor.cpp.

                                                                {
  return m_PropertyMgr->getProperty(name);
}

StatusCode Auditor::getProperty ( const std::string &  n, std::string &  v  ) const

override

Implementation of IProperty::getProperty.

Definition at line 242 of file Auditor.cpp.

                                                                       {
  return m_PropertyMgr->getProperty(n,v);
}

bool Auditor::hasProperty ( const std::string &  name ) const

override

Implementation of IProperty::hasProperty.

Definition at line 248 of file Auditor.cpp.

                                                     {
  return m_PropertyMgr->hasProperty(name);
}

StatusCode Auditor::initialize ( )

virtual

Reimplemented in Google::HeapChecker, PerfMonAuditor, Google::AuditorBase, TimingAuditor, AlgContextAuditor, IntelProfilerAuditor, AlgErrorAuditor, ChronoAuditor, and MemStatAuditor.

Definition at line 82 of file Auditor.cpp.

                               {
  return StatusCode::SUCCESS;
}

bool Auditor::isEnabled ( ) const

override

Definition at line 206 of file Auditor.cpp.

                               {
  return m_isEnabled;
}

const std::string & Auditor::name ( ) const

override

Definition at line 202 of file Auditor.cpp.

                                     {
  return m_name;
}

Auditor& Auditor::operator= ( const Auditor &  rhs )

private

template<class T >

StatusCode Auditor::service ( const std::string &  name, T *&  svc, bool  createIf = false  ) const

inline

Access a service by name, creating it if it doesn't already exist.

Definition at line 110 of file Auditor.h.

                                                                                    {
    auto ptr = serviceLocator()->service<T>(name, createIf);
    if (ptr) {
      svc = ptr.get();
      svc->addRef();
      return StatusCode::SUCCESS;
    }
    svc = nullptr;
    return StatusCode::FAILURE;
  }

template<class T = IService>

SmartIF<T> Auditor::service ( const std::string &  name, bool  createIf = false  ) const

inline

Definition at line 122 of file Auditor.h.

                                                                           {
    return serviceLocator()->service<T>(name, createIf);
  }

SmartIF< ISvcLocator > & Auditor::serviceLocator

(

)

const

The standard service locator.

Returns a pointer to the service locator service. This service may be used by an auditor to request any services it requires in addition to those provided by default.

Definition at line 211 of file Auditor.cpp.

                                                    {
  return m_pSvcLocator;
}

StatusCode Auditor::setProperties

(

)

Set the auditor's properties.

This method requests the job options service to set the values of any declared properties. The method is invoked from within sysInitialize() by the framework and does not need to be explicitly called by a concrete auditor.

Definition at line 216 of file Auditor.cpp.

                                  {
  if( !m_pSvcLocator ) return StatusCode::FAILURE;
  auto jos = service<IJobOptionsSvc>("JobOptionsSvc");
  if( !jos ) return StatusCode::FAILURE;
  jos->setMyProperties( name(), this ).ignore();
  updateMsgStreamOutputLevel( m_outputLevel );
  return StatusCode::SUCCESS;
}

StatusCode Auditor::setProperty ( const Property &  p )

override

Set a value of a property of an auditor.

Definition at line 227 of file Auditor.cpp.

                                                 {
  return m_PropertyMgr->setProperty(p);
}

StatusCode Auditor::setProperty ( const std::string &  s )

override

Implementation of IProperty::setProperty.

Definition at line 230 of file Auditor.cpp.

                                                  {
  return m_PropertyMgr->setProperty(s);
}

StatusCode Auditor::setProperty ( const std::string &  n, const std::string &  v  )

override

Implementation of IProperty::setProperty.

Definition at line 233 of file Auditor.cpp.

                                                                      {
  return m_PropertyMgr->setProperty(n,v);
}

template<class TYPE >

StatusCode Auditor::setProperty ( const std::string &  name, const TYPE &  value  )

inline

set the property form the value

std::vector<double> data = ... ;
setProperty( "Data" , data ) ;

std::map<std::string,double> cuts = ... ;
setProperty( "Cuts" , cuts ) ;

std::map<std::string,std::string> dict = ... ;
setProperty( "Dictionary" , dict ) ;

Note: the interface IProperty allows setting of the properties either directly from other properties or from strings only

This is very convenient in resetting of the default properties in the derived classes. E.g. without this method one needs to convert everything into strings to use IProperty::setProperty

setProperty ( "OutputLevel" , "1"    ) ;
setProperty ( "Enable"      , "True" ) ;
setProperty ( "ErrorMax"    , "10"   ) ;

For simple cases it is more or less ok, but for complicated properties it is just ugly..

Parameters

name	name of the property
value	value of the property

See also

Gaudi::Utils::setProperty

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-05-13

Definition at line 192 of file Auditor.h.

  { return Gaudi::Utils::setProperty ( m_PropertyMgr.get() , name , value ) ; }

StatusCode Auditor::sysFinalize ( )

override

Finalization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself.

RETURN !!!

catch GaudiExeption

(1) perform the printout of message

(2) print the exception itself (NB! - GaudiException is a linked list of all "previous exceptions")

catch std::exception

(1) perform the printout of message

(2) print the exception itself

catch unknown exception

(1) perform the printout

Definition at line 150 of file Auditor.cpp.

                                {
  StatusCode sc = StatusCode::SUCCESS;
  try{
    //
    // Invoke the finalize() method of the derived class if
    // it has been initialized.
    if ( m_isInitialized && ! m_isFinalized ) {
      m_isFinalized = true;
      sc = finalize();
      if( !sc.isSuccess() )  return StatusCode::FAILURE;
    }
    return sc;                                               
    //
  }
  catch( const GaudiException& Exception )                   
    {
      MsgStream log ( msgSvc() , name() + ".sysFinalize()" );
      log << MSG::FATAL
      << " Exception with tag=" << Exception.tag() << " is catched " << endmsg;
      MsgStream logEx ( msgSvc() , Exception.tag() );
      logEx << MSG::ERROR
        << Exception  << endmsg;
    }
  catch( const std::exception& Exception )                   
    {
      MsgStream log ( msgSvc() , name() + ".sysFinalize()" );
      log << MSG::FATAL
      << " Standard std::exception is caught " << endmsg;
      MsgStream logEx ( msgSvc() , name() + "*std::exception*" );
      logEx << MSG::ERROR
        << Exception.what()  << endmsg;
    }
  catch( ... )                                                
    {
      MsgStream log ( msgSvc() , name() + ".sysFinalize()" );
      log << MSG::FATAL
      << " UNKNOWN Exception is caught " << endmsg;
    }
  return StatusCode::FAILURE ;
}

StatusCode Auditor::sysInitialize ( )

override

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself.

RETURN !!!

catch Gaudi Exception

(1) perform the printout of message

(2) print the exception itself (NB! - GaudiException is a linked list of all "previous exceptions")

catch std::exception

(1) perform the printout of message

(2) print the exception itself (NB! - GaudiException is a linked list of all "previous exceptions")

(1) perform the printout

Definition at line 28 of file Auditor.cpp.

                                  {
  StatusCode sc;

  // Bypass the initialization if the auditor is disabled or
  // has already been initialized.
  if ( isEnabled( ) && ! m_isInitialized ) {

    // Setup the default service ... this should be upgraded so as to be configurable.
    if( !m_pSvcLocator )
      return StatusCode::FAILURE;

    // Set the Auditor's properties
    sc = setProperties();
    if( !sc.isSuccess() )  return StatusCode::FAILURE;

    {
      try{
    // Invoke the initialize() method of the derived class
    sc = initialize();
    if( !sc.isSuccess() )  return StatusCode::FAILURE;
        m_isInitialized = true;

        return sc;                                               
      }
      catch ( const GaudiException& Exception )                  
        {
      MsgStream log ( msgSvc() , name() + ".sysInitialize()" );
      log << MSG::FATAL << " Exception with tag=" << Exception.tag() << " is caught " << endmsg;
      MsgStream logEx ( msgSvc() , Exception.tag() );
      logEx << MSG::ERROR << Exception  << endmsg;
        }
      catch( const std::exception& Exception )                   
        {
      MsgStream log ( msgSvc() , name() + ".sysInitialize()" );
      log << MSG::FATAL << " Standard std::exception is caught " << endmsg;
      MsgStream logEx ( msgSvc() , name() + "*std::exception*" );
      logEx << MSG::ERROR << Exception.what()  << endmsg;
        }
      catch(...)
        {
      MsgStream log ( msgSvc() , name() + ".sysInitialize()" );
      log << MSG::FATAL << " UNKNOWN Exception is  caught " << endmsg;
        }
    }
  }
  return StatusCode::FAILURE;
}

Member Data Documentation

bool Auditor::m_isEnabled

private

Auditor is enabled flag.

Definition at line 244 of file Auditor.h.

bool Auditor::m_isFinalized

private

Auditor has been finalized flag.

Definition at line 246 of file Auditor.h.

bool Auditor::m_isInitialized

private

Auditor has been initialized flag.

Definition at line 245 of file Auditor.h.

std::string Auditor::m_name

private

Auditor's name for identification.

Definition at line 239 of file Auditor.h.

int Auditor::m_outputLevel

private

Auditor output level.

Definition at line 243 of file Auditor.h.

SmartIF<PropertyMgr> Auditor::m_PropertyMgr

private

For management of properties.

Definition at line 242 of file Auditor.h.

SmartIF<ISvcLocator> Auditor::m_pSvcLocator

mutableprivate

Pointer to service locator service.

Definition at line 241 of file Auditor.h.

---

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

• GaudiKernel/GaudiKernel/Auditor.h
• GaudiKernel/src/Lib/Auditor.cpp