AuditorSvc Class Reference

#include <src/AuditorSvc.h>

Inheritance diagram for AuditorSvc:

Collaboration diagram for AuditorSvc:

Public Member Functions
StatusCode	initialize () override
StatusCode	finalize () override
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 *ini) override
void	afterInitialize (INamedInterface *ini) override
void	beforeReinitialize (INamedInterface *ini) override
void	afterReinitialize (INamedInterface *ini) override
void	beforeExecute (INamedInterface *ini) override
void	afterExecute (INamedInterface *ini, const StatusCode &) override
void	beforeBeginRun (INamedInterface *ini) override
void	afterBeginRun (INamedInterface *ini) override
void	beforeEndRun (INamedInterface *ini) override
void	afterEndRun (INamedInterface *ini) override
void	beforeFinalize (INamedInterface *ini) override
void	afterFinalize (INamedInterface *ini) override
bool	isEnabled () const override
StatusCode	sysInitialize () override
StatusCode	sysFinalize () override
IAuditor *	getAuditor (const std::string &name) override
	AuditorSvc (const std::string &name, ISvcLocator *svc)
	~AuditorSvc () override=default
Public Member Functions inherited from extends< Service, IAuditorSvc >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from Service
const std::string &	name () const override
	Retrieve name of the service. More...
StatusCode	configure () override
StatusCode	initialize () override
StatusCode	start () override
StatusCode	stop () override
StatusCode	finalize () override
StatusCode	terminate () override
Gaudi::StateMachine::State	FSMState () const override
Gaudi::StateMachine::State	targetFSMState () const override
StatusCode	reinitialize () override
StatusCode	restart () override
StatusCode	sysInitialize () override
	Initialize Service. More...
StatusCode	sysStart () override
	Initialize Service. More...
StatusCode	sysStop () override
	Initialize Service. More...
StatusCode	sysFinalize () override
	Finalize Service. More...
StatusCode	sysReinitialize () override
	Re-initialize the Service. More...
StatusCode	sysRestart () override
	Re-initialize the Service. More...
StatusCode	setProperty (const Property &p) override
StatusCode	setProperty (const std::string &s) override
StatusCode	setProperty (const std::string &n, const std::string &v) override
StatusCode	getProperty (Property *p) const override
const Property &	getProperty (const std::string &name) const override
StatusCode	getProperty (const std::string &n, std::string &v) const override
const std::vector< Property * > &	getProperties () const override
bool	hasProperty (const std::string &name) const override
template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...
	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. More...
SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator. More...
StatusCode	setProperties ()
	Method for setting declared properties to the values specified for the job. More...
template<class T >
StatusCode	service (const std::string &name, const T *&psvc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const
template<class T >
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
	Access a service by name and type, creating it if it doesn't already exist. More...
template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...
Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...
template<class T >
StatusCode	declarePrivateTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Private tool. More...
template<class T >
StatusCode	declarePublicTool (ToolHandle< T > &handle, std::string toolTypeAndName="", bool createIf=true)
	Declare used Public tool. More...
SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. 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...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
SmartIF< IAuditor >	newAuditor_ (MsgStream &, const std::string &)
SmartIF< IAuditor >	findAuditor_ (const std::string &)
StatusCode	syncAuditors_ ()

Private Attributes
std::vector< std::string >	m_audNameList
std::vector< SmartIF< IAuditor > >	m_pAudList
bool	m_isEnabled = true

Additional Inherited Members
Public Types inherited from extends< Service, IAuditorSvc >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
Public Types inherited from Service
typedef Gaudi::PluginService::Factory< IService *, const std::string &, ISvcLocator * >	Factory
Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging
Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
Protected Member Functions inherited from Service
	~Service () override
	Standard Destructor. More...
int	outputLevel () const
	get the Service's output level More...
Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...
Protected Attributes inherited from Service
IntegerProperty	m_outputLevel = MSG::NIL
	Service output level. More...
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state. More...
Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state. More...

Detailed Description

Definition at line 18 of file AuditorSvc.h.

Constructor & Destructor Documentation

AuditorSvc::AuditorSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

Definition at line 81 of file AuditorSvc.cpp.

: base_class(name, svc) {
  declareProperty("Auditors", m_audNameList );
  declareProperty("Enable", m_isEnabled = true);
}

AuditorSvc::~AuditorSvc ( )

overridedefault

Member Function Documentation

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

override

Definition at line 143 of file AuditorSvc.cpp.

                                                                                        {
  if (!isEnabled()) return;
  for (auto& it : m_pAudList ) {
    if(it->isEnabled()) it->after(evt,obj,sc);
  }
}

void AuditorSvc::after ( StandardEventType  evt, const std::string &  name, const StatusCode &  sc  )

override

Definition at line 150 of file AuditorSvc.cpp.

                                                                                         {
  if (!isEnabled()) return;
  for (auto& it : m_pAudList ) {
    if(it->isEnabled()) it->after(evt,name,sc);
  }
}

void AuditorSvc::after ( CustomEventTypeRef  evt, INamedInterface *  obj, const StatusCode &  sc  )

override

Definition at line 157 of file AuditorSvc.cpp.

                                                                                         {
  if (!isEnabled()) return;
  for (auto& it : m_pAudList ) {
    if(it->isEnabled()) it->after(evt,obj,sc);
  }
}

void AuditorSvc::after ( CustomEventTypeRef  evt, const std::string &  name, const StatusCode &  sc  )

override

Definition at line 164 of file AuditorSvc.cpp.

                                                                                          {
  if (!isEnabled()) return;
  for (auto& it : m_pAudList) {
    if(it->isEnabled()) it->after(evt,name,sc);
  }
}

void AuditorSvc::afterBeginRun ( INamedInterface *  ini )

override

void AuditorSvc::afterEndRun ( INamedInterface *  ini )

override

void AuditorSvc::afterExecute ( INamedInterface *  ini, const StatusCode &    )

override

Definition at line 185 of file AuditorSvc.cpp.

                                                                {
  throw GaudiException("The method afterExecute is obsolete do not call it.",
                       "AuditorSvc::afterExecute" , StatusCode::FAILURE);
}

void AuditorSvc::afterFinalize ( INamedInterface *  ini )

override

void AuditorSvc::afterInitialize ( INamedInterface *  ini )

override

void AuditorSvc::afterReinitialize ( INamedInterface *  ini )

override

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

override

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

Definition at line 114 of file AuditorSvc.cpp.

                                                                   {
  if (!isEnabled()) return;
  for (auto& it : m_pAudList ) {
    if(it->isEnabled()) it->before(evt,obj);
  }
}

void AuditorSvc::before ( StandardEventType  evt, const std::string &  name  )

override

Definition at line 121 of file AuditorSvc.cpp.

                                                                    {
  if (!isEnabled()) return;
  for (auto& it : m_pAudList ) {
    if(it->isEnabled()) it->before(evt,name);
  }
}

void AuditorSvc::before ( CustomEventTypeRef  evt, INamedInterface *  obj  )

override

Definition at line 128 of file AuditorSvc.cpp.

                                                                    {
  if (!isEnabled()) return;
  for (auto& it : m_pAudList) {
    if(it->isEnabled()) it->before(evt,obj);
  }
}

void AuditorSvc::before ( CustomEventTypeRef  evt, const std::string &  name  )

override

Definition at line 135 of file AuditorSvc.cpp.

                                                                     {
  if (!isEnabled()) return;
  for (auto& it : m_pAudList ) {
    if(it->isEnabled()) it->before(evt,name);
  }
}

void AuditorSvc::beforeBeginRun ( INamedInterface *  ini )

override

void AuditorSvc::beforeEndRun ( INamedInterface *  ini )

override

void AuditorSvc::beforeExecute ( INamedInterface *  ini )

override

void AuditorSvc::beforeFinalize ( INamedInterface *  ini )

override

void AuditorSvc::beforeInitialize ( INamedInterface *  ini )

override

void AuditorSvc::beforeReinitialize ( INamedInterface *  ini )

override

StatusCode AuditorSvc::finalize ( )

override

Definition at line 102 of file AuditorSvc.cpp.

                                {

  for (auto& it : m_pAudList ) {
    if(it->isEnabled()) it->sysFinalize().ignore();
  }
  m_pAudList.clear();

  // Finalize this specific service
  return Service::finalize();
}

SmartIF< IAuditor > AuditorSvc::findAuditor_ ( const std::string &  name )

private

Definition at line 41 of file AuditorSvc.cpp.

                                                                  {
  // find an auditor by name, return 0 on error
  const std::string item_name = Gaudi::Utils::TypeNameString(name).name();
  auto it = std::find_if( std::begin(m_pAudList), std::end(m_pAudList),
                          [&](const IAuditor* i) { return i->name() == item_name; });
  return SmartIF<IAuditor>{ it != std::end(m_pAudList) ? *it : nullptr };
}

IAuditor * AuditorSvc::getAuditor ( const std::string &  name )

override

Definition at line 212 of file AuditorSvc.cpp.

                                                        {
  // by interactively setting properties, auditors might be out of sync
  if ( !syncAuditors_().isSuccess() ) {
    // as we didn't manage to sync auditors, the safest bet is to assume the
    // worse...
    // So don't let clients play with an AuditorSvc in an inconsistent state
    return nullptr;
  }

  // search available auditors, returns 0 on error
  return findAuditor_( name );
}

StatusCode AuditorSvc::initialize ( )

override

Definition at line 90 of file AuditorSvc.cpp.

                                  {
  StatusCode sc = Service::initialize();
  if ( sc.isFailure() )
    return sc;

  // create auditor objects for all named auditors
  sc = syncAuditors_();

  return sc;
}

bool AuditorSvc::isEnabled ( ) const

override

Definition at line 200 of file AuditorSvc.cpp.

                                  {
  return m_isEnabled;
}

SmartIF< IAuditor > AuditorSvc::newAuditor_ ( MsgStream &  log, const std::string &  name  )

private

Definition at line 22 of file AuditorSvc.cpp.

                                                                                 {
  // locate the auditor factory, instantiate a new auditor, initialize it
  StatusCode sc;
  Gaudi::Utils::TypeNameString item(name) ;
  SmartIF<IAuditor> aud{  Auditor::Factory::create( item.type(), item.name(), serviceLocator().get() ) };
  if ( aud ) {
    if ( m_targetState >= Gaudi::StateMachine::INITIALIZED ) {
      sc = aud->sysInitialize();
      if ( sc.isFailure() ) {
        log << MSG::WARNING << "Failed to initialize Auditor " << name << endmsg;
        aud.reset();
      }
    }
  } else {
    log << MSG::WARNING << "Unable to retrieve factory for Auditor " << name << endmsg;
  }
  return aud;
}

StatusCode AuditorSvc::syncAuditors_ ( )

private

Definition at line 49 of file AuditorSvc.cpp.

                                     {
  if ( m_audNameList.size() == m_pAudList.size() )
    return StatusCode::SUCCESS;

  StatusCode sc;

//   if ( sc.isFailure() ) {
//     error() << "Unable to locate ObjectManager Service" << endmsg;
//     return sc;
//   }

  // create all declared Auditors that do not yet exist
  for ( auto& it : m_audNameList ) {

    // this is clumsy, but the PropertyMgr won't tell us when my property changes right
    // under my nose, so I'll have to figure this out the hard way
    if ( !findAuditor_( it ) ) { // if auditor does not yet exist
      auto aud = newAuditor_( msgStream(), it );
      if ( aud ) {
        m_pAudList.push_back( std::move(aud) );
      } else {
        error() << "Error constructing Auditor " << it << endmsg;
        sc = StatusCode::FAILURE;
      }
    }
  }
  return sc;
}

StatusCode AuditorSvc::sysFinalize ( )

override

Definition at line 207 of file AuditorSvc.cpp.

                                  {
  return Service::sysFinalize();
}

StatusCode AuditorSvc::sysInitialize ( )

override

Definition at line 204 of file AuditorSvc.cpp.

                                    {
  return Service::sysInitialize();
}

Member Data Documentation

std::vector<std::string> AuditorSvc::m_audNameList

private

Definition at line 100 of file AuditorSvc.h.

bool AuditorSvc::m_isEnabled = true

private

Definition at line 106 of file AuditorSvc.h.

std::vector<SmartIF<IAuditor> > AuditorSvc::m_pAudList

private

Definition at line 103 of file AuditorSvc.h.

---

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

• GaudiCommonSvc/src/AuditorSvc.h
• GaudiCommonSvc/src/AuditorSvc.cpp