| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

Gaudi::Utils::AlgContext Class Reference

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

#include <IAlgContextSvc.h>

Collaboration diagram for Gaudi::Utils::AlgContext:

[legend]
List of all members.

Public Member Functions

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

Private Member Functions

 AlgContext ()
 no default constructor!
 AlgContext (const AlgContext &right)
 no copy!
AlgContextoperator= (const AlgContext &right)
 no assignement!

Private Attributes

IAlgContextSvcm_svc
IAlgorithmm_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 ibelyaev@phys.syr.edu
Date:
2007-03-07

Definition at line 84 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

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

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

destructor Internally invokes IAlgContextSvc::unSetCurrentAlg

See also:
IAlgorithm

IAlgContextSvc

Gaudi::Utils::AlgContext::AlgContext (  )  [private]

no default constructor!

Gaudi::Utils::AlgContext::AlgContext ( const AlgContext right  )  [private]

no copy!


Member Function Documentation

AlgContext& Gaudi::Utils::AlgContext::operator= ( const AlgContext right  )  [private]

no assignement!


Member Data Documentation

IAlgContextSvc* Gaudi::Utils::AlgContext::m_svc [private]

Definition at line 121 of file IAlgContextSvc.h.

IAlgorithm* Gaudi::Utils::AlgContext::m_alg [private]

Definition at line 122 of file IAlgContextSvc.h.


The documentation for this class was generated from the following file:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Mon Apr 11 19:57:17 2011 for GaudiKernel by doxygen 1.4.7