Gaudi::Utils::AlgContext Class Reference

Helper "sentry" class to automatize the safe register/unregister the algorithm's context. More...

#include <GaudiKernel/IAlgContextSvc.h>

Collaboration diagram for Gaudi::Utils::AlgContext:

Public Member Functions
	AlgContext (IAlgContextSvc *svc, IAlgorithm *alg)
	constructor from the service and the algorithm Internally invokes IAlgContextSvc::setCurrentAlg More...
	AlgContext (IAlgorithm *alg, IAlgContextSvc *svc)
	constructor from the algorithm and the service Internally invokes IAlgContextSvc::setCurrentAlg More...
	~AlgContext ()
	destructor Internally invokes IAlgContextSvc::unSetCurrentAlg More...

Private Member Functions
	AlgContext ()=delete
	AlgContext (const AlgContext &right)=delete
AlgContext &	operator= (const AlgContext &right)=delete

Private Attributes
SmartIF< IAlgContextSvc >	m_svc
SmartIF< IAlgorithm >	m_alg

Detailed Description

Helper "sentry" class to automatize the safe register/unregister the algorithm's context.

Typical explicit usage:

StatusCode MyAlg::execute()
 {
    IAlgContextSvc* acs = ... ;
    // define the context
    Gaudi::Utils::AlgContext sentry ( this , acs ) ;

    ...

    return StatusCode::SUCCESS ;
 }

Note: for the regular job the context is properly defined with the help of corresponding auditor AlgContextAuditor. This helper class is needed only if one needs to ensure that the algorithm must register its context independently on job/auditor configuration

See also

AlgContextAuditor

Author

Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.phys..nosp@m.syr..nosp@m.edu

Date

2007-03-07

Definition at line 77 of file IAlgContextSvc.h.

Constructor & Destructor Documentation

Gaudi::Utils::AlgContext::AlgContext	(	IAlgContextSvc *	svc,
		IAlgorithm *	alg
	)

constructor from the service and the algorithm Internally invokes IAlgContextSvc::setCurrentAlg

See also

IAlgorithm

IAlgContextSvc

Parameters

svc	pointer to algorithm context service
alg	pointer to the current algorithm

Definition at line 23 of file AlgContext.cpp.

                                                                       : m_svc( svc ), m_alg( alg )
{
  if ( m_svc && m_alg ) {
    m_svc->setCurrentAlg( m_alg.get() ).ignore();
  }
}

Gaudi::Utils::AlgContext::AlgContext	(	IAlgorithm *	alg,
		IAlgContextSvc *	svc
	)

constructor from the algorithm and the service Internally invokes IAlgContextSvc::setCurrentAlg

See also

IAlgorithm

IAlgContextSvc

Parameters

alg	pointer to the current algorithm
svc	pointer to algorithm context service

Definition at line 38 of file AlgContext.cpp.

                                                                       : m_svc( svc ), m_alg( alg )
{
  if ( m_svc && m_alg ) {
    m_svc->setCurrentAlg( m_alg.get() ).ignore();
  }
}

Gaudi::Utils::AlgContext::~AlgContext

(

)

destructor Internally invokes IAlgContextSvc::unSetCurrentAlg

See also

IAlgorithm

IAlgContextSvc

Definition at line 51 of file AlgContext.cpp.

{
  if ( m_svc && m_alg ) {
    m_svc->unSetCurrentAlg( m_alg.get() ).ignore();
  }
}

Gaudi::Utils::AlgContext::AlgContext ( )

privatedelete

Gaudi::Utils::AlgContext::AlgContext ( const AlgContext &  right )

privatedelete

Member Function Documentation

AlgContext& Gaudi::Utils::AlgContext::operator= ( const AlgContext &  right )

privatedelete

Member Data Documentation

SmartIF<IAlgorithm> Gaudi::Utils::AlgContext::m_alg

private

Definition at line 113 of file IAlgContextSvc.h.

SmartIF<IAlgContextSvc> Gaudi::Utils::AlgContext::m_svc

private

Definition at line 112 of file IAlgContextSvc.h.

---

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

• GaudiKernel/GaudiKernel/IAlgContextSvc.h
• GaudiKernel/src/Lib/AlgContext.cpp