Special service that issue a failure in one of the transitions (for testing). More...

Inheritance diagram for GaudiTesting::FailingSvc:

[legend]

Collaboration diagram for GaudiTesting::FailingSvc:

[legend]

Public Member Functions
StatusCode	initialize () override

StatusCode	start () override

StatusCode	stop () override

StatusCode	finalize () override

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor. 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...

	Service (std::string name, ISvcLocator *svcloc)
	Standard Constructor More...

SmartIF< ISvcLocator > &	serviceLocator () const override
	Retrieve pointer to service locator More...

template<typename IFace = IService>
SmartIF< IFace >	service (const std::string &name, bool createIf=true) const

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandle< T > &hndl, const std::string &doc="none")

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, bool createIf=true)

template<class T >
StatusCode	declareTool (ToolHandle< T > &handle, const std::string &toolTypeAndName, bool createIf=true)
	Declare used tool. More...

template<class T >
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, ToolHandleArray< T > &hndlArr, const std::string &doc="none")

template<class T >
void	addToolsArray (ToolHandleArray< T > &hndlArr)

const std::vector< IAlgTool * > &	tools () const

SmartIF< IAuditorSvc > &	auditorSvc () const
	The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...

Public Member Functions inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	PropertyHolder ()=default

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Details::PropertyBase &prop)
	Declare a property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, Gaudi::Property< TYPE, VERIFIER, HANDLERS > &prop, const std::string &doc="none")
	Declare a PropertyBase instance setting name and documentation. More...

	requires (!Gaudi::Details::is_gaudi_property_v< TYPE >) Gaudi
	Helper to wrap a regular data member and use it as a regular property. More...

Gaudi::Details::PropertyBase *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="")
	Declare a remote property. More...

StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p) override
	set the property from another property with a different name More...

StatusCode	setProperty (const std::string &s) override
	set the property from the formatted string More...

StatusCode	setProperty (const Gaudi::Details::PropertyBase &p)
	Set the property from a property. More...

virtual StatusCode	setProperty (const std::string &name, const Gaudi::Details::PropertyBase &p)=0
	Set the property from a property with a different name. More...

virtual StatusCode	setProperty (const std::string &s)=0
	Set the property by string. More...

StatusCode	setProperty (const std::string &name, const char *v)
	Special case for string literals. More...

StatusCode	setProperty (const std::string &name, const std::string &v)
	Special case for std::string. More...

StatusCode	setPropertyRepr (const std::string &n, const std::string &r) override
	set the property from name and value string representation More...

StatusCode	getProperty (Gaudi::Details::PropertyBase *p) const override
	get the property More...

const Gaudi::Details::PropertyBase &	getProperty (std::string_view name) const override
	get the property by name More...

StatusCode	getProperty (std::string_view n, std::string &v) const override
	convert the property to the string More...

const std::vector< Gaudi::Details::PropertyBase * > &	getProperties () const override
	get all properties More...

bool	hasProperty (std::string_view name) const override
	Return true if we have a property with the given name. More...

Gaudi::Details::PropertyBase *	property (std::string_view name) const
	\fixme property and bindPropertiesTo should be protected More...

void	bindPropertiesTo (Gaudi::Interfaces::IOptionsSvc &optsSvc)

	PropertyHolder (const PropertyHolder &)=delete

PropertyHolder &	operator= (const PropertyHolder &)=delete

Public Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...

bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Private Member Functions
StatusCode	handle (const std::string &transition)

Private Attributes
Gaudi::Property< std::string >	m_transition

Gaudi::Property< std::string >	m_mode { this, "Mode", "failure", "Type of failure ['failure', 'exception']" }

Additional Inherited Members
Public Types inherited from Service
using	Factory = Gaudi::PluginService::Factory< IService (const std::string &, ISvcLocator )>

Public Types inherited from PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
using	PropertyHolderImpl = PropertyHolder< CommonMessaging< implements< IService, IProperty, IStateful > > >
	Typedef used to refer to this class from derived classes, as in. More...

Public Types inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
using	base_class = CommonMessaging

Protected Member Functions inherited from Service
std::vector< IAlgTool * > &	tools ()

	~Service () override

int	outputLevel () const
	get the `Service's` output level More...

Protected Member Functions inherited from CommonMessaging< implements< IService, IProperty, IStateful > >
MSG::Level	setUpMessaging () const
	Set up local caches. More...

MSG::Level	resetMessaging ()
	Reinitialize internal states. More...

void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Protected Attributes inherited from Service
Gaudi::StateMachine::State	m_state = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::StateMachine::State	m_targetState = Gaudi::StateMachine::OFFLINE
	Service state More...

Gaudi::Property< int >	m_outputLevel { this, "OutputLevel", MSG::NIL, "output level" }
	flag indicating whether ToolHandle tools have been added to m_tools More...

Gaudi::Property< bool >	m_auditorInitialize { this, "AuditInitialize", false, "trigger auditor on initialize()" }

Gaudi::Property< bool >	m_auditorStart { this, "AuditStart", false, "trigger auditor on start()" }

Gaudi::Property< bool >	m_auditorStop { this, "AuditStop", false, "trigger auditor on stop()" }

Gaudi::Property< bool >	m_auditorFinalize { this, "AuditFinalize", false, "trigger auditor on finalize()" }

Gaudi::Property< bool >	m_auditorReinitialize { this, "AuditReinitialize", false, "trigger auditor on reinitialize()" }

Gaudi::Property< bool >	m_auditorRestart { this, "AuditRestart", false, "trigger auditor on restart()" }

Gaudi::Property< bool >	m_autoRetrieveTools

Gaudi::Property< bool >	m_checkToolDeps

SmartIF< IAuditorSvc >	m_pAuditorSvc
	Auditor Service More...

Detailed Description

Special service that issue a failure in one of the transitions (for testing).

Definition at line 17 of file TestingSvcs.cpp.

Member Function Documentation

◆ finalize()

StatusCode GaudiTesting::FailingSvc::finalize ( )

inlineoverride

Definition at line 43 of file TestingSvcs.cpp.

                                    {
       StatusCode sc = handle( "finalize" );
       if ( sc.isFailure() ) return sc;
       return Service::finalize();
     }

◆ handle()

StatusCode GaudiTesting::FailingSvc::handle ( const std::string & transition )

inlineprivate

Definition at line 54 of file TestingSvcs.cpp.

                                                             {
       if ( m_transition == transition ) {
         if ( m_mode == "exception" ) {
           throw GaudiException( "forced failure in " + transition, name(), StatusCode::FAILURE );
         } else if ( m_mode == "failure" ) {
           return StatusCode::FAILURE;
         } else {
           warning() << "Unknown type of failure '" << m_mode << "', use 'failure' or 'exception'" << endmsg;
         }
       }
       return StatusCode::SUCCESS;
     }

◆ initialize()

StatusCode GaudiTesting::FailingSvc::initialize ( )

inlineoverride

Definition at line 22 of file TestingSvcs.cpp.

                                      {
       StatusCode sc = Service::initialize();
       if ( sc.isFailure() ) {
         error() << "failed to initialize base class" << endmsg;
         return sc;
       }
       return handle( "initialize" );
     }

◆ Service()

Service::Service

Standard Constructor.

Definition at line 74 of file Service.cpp.

                                                       : m_name( std::move( name ) ), m_svcLocator( svcloc ) {
   if ( m_name != "MessageSvc" ) { // the MessageSvc should not notify itself
     m_outputLevel.declareUpdateHandler(
         [this]( Gaudi::Details::PropertyBase& ) { this->updateMsgStreamOutputLevel( this->m_outputLevel ); } );
   }
  
   // Initialize the default value from ApplicationMgr AuditAlgorithms
   Gaudi::Property<bool> audit( "AuditServices", false );
   if ( auto appMgr = serviceLocator()->service<IProperty>( "ApplicationMgr" ) ) {
     appMgr->getProperty( &audit ).ignore();
   }
  
   m_auditorInitialize   = audit;
   m_auditorStart        = audit;
   m_auditorStop         = audit;
   m_auditorFinalize     = audit;
   m_auditorReinitialize = audit;
   m_auditorRestart      = audit;
 }

◆ start()

StatusCode GaudiTesting::FailingSvc::start ( )

inlineoverride

Definition at line 30 of file TestingSvcs.cpp.

                                 {
       StatusCode sc = Service::start();
       if ( sc.isFailure() ) {
         error() << "failed to start base class" << endmsg;
         return sc;
       }
       return handle( "start" );
     }

◆ stop()

StatusCode GaudiTesting::FailingSvc::stop ( )

inlineoverride

Definition at line 38 of file TestingSvcs.cpp.

                                {
       StatusCode sc = handle( "stop" );
       if ( sc.isFailure() ) return sc;
       return Service::stop();
     }

Member Data Documentation

◆ m_mode

Gaudi::Property<std::string> GaudiTesting::FailingSvc::m_mode { this, "Mode", "failure", "Type of failure ['failure', 'exception']" }

private

Definition at line 52 of file TestingSvcs.cpp.

◆ m_transition

Gaudi::Property<std::string> GaudiTesting::FailingSvc::m_transition

private

Initial value:

{

this, "Transition", "", "In which transition to fail ['initialize', 'start', 'stop', 'finalize']" }

Definition at line 50 of file TestingSvcs.cpp.

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

GaudiTestSuite/src/testing/TestingSvcs.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ finalize()

◆ handle()

◆ initialize()

◆ Service()

◆ start()

◆ stop()

Member Data Documentation

◆ m_mode

◆ m_transition