The Gaudi Framework  master (29688f1e)
Loading...
Searching...
No Matches
IAlgContextSvc Class Referenceabstract

An abstract interface for Algorithm Context Service. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/IAlgContextSvc.h>

Inheritance diagram for IAlgContextSvc:
Collaboration diagram for IAlgContextSvc:

Public Types

typedef std::vector< IAlgorithm * > Algorithms
 the actual type of algorithm' stack
Public Types inherited from IInterface
enum class  Status : StatusCode::code_t {
  FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH ,
  LAST_ERROR
}
 Return status. More...
using iid = Gaudi::InterfaceId<IInterface, 0, 0>
 Interface ID.
using ext_iids = Gaudi::interface_list<iid>
 Extra interfaces.

Public Member Functions

 DeclareInterfaceID (IAlgContextSvc, 4, 0)
 InterfaceID.
virtual StatusCode setCurrentAlg (IAlgorithm *a, const EventContext &context)=0
 set the currently executing algorithm ("push_back")
virtual StatusCode unSetCurrentAlg (IAlgorithm *a, const EventContext &context)=0
 remove the algorithm ("pop_back")
virtual IAlgorithmcurrentAlg () const =0
 accessor to current algorithm:
virtual const Algorithmsalgorithms () const =0
 get the stack of executed algorithms
Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET * cast ()
template<Gaudi::IsInterface TARGET>
TARGET const * cast () const
template<typename TARGET>
TARGET * cast ()
template<typename TARGET>
TARGET const * cast () const
virtual std::vector< std::string > getInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces.
virtual unsigned long addRef () const =0
 Increment the reference count of Interface instance.
virtual unsigned long release () const =0
 Release Interface instance.
virtual unsigned long refCount () const =0
 Current reference count.
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance.
virtual ~IInterface ()=default
 Virtual destructor.
virtual void const * i_cast (const InterfaceID &) const =0
void * i_cast (const InterfaceID &iid)

Additional Inherited Members

Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface.
Protected Member Functions inherited from IInterface
virtual unsigned long decRef () const =0
 Decrement reference count and return the new reference count.

Detailed Description

An abstract interface for Algorithm Context Service.

Author
ATLAS Collaboration
Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u
Date
2007-03-07 (modified)

Definition at line 25 of file IAlgContextSvc.h.

Member Typedef Documentation

◆ Algorithms

typedef std::vector<IAlgorithm*> IAlgContextSvc::Algorithms

the actual type of algorithm' stack

Definition at line 30 of file IAlgContextSvc.h.

Member Function Documentation

◆ algorithms()

virtual const Algorithms & IAlgContextSvc::algorithms ( ) const
pure virtual

get the stack of executed algorithms

◆ currentAlg()

virtual IAlgorithm * IAlgContextSvc::currentAlg ( ) const
pure virtual

accessor to current algorithm:

◆ DeclareInterfaceID()

IAlgContextSvc::DeclareInterfaceID ( IAlgContextSvc ,
4 ,
0  )

◆ setCurrentAlg()

virtual StatusCode IAlgContextSvc::setCurrentAlg ( IAlgorithm * a,
const EventContext & context )
pure virtual

set the currently executing algorithm ("push_back")

◆ unSetCurrentAlg()

virtual StatusCode IAlgContextSvc::unSetCurrentAlg ( IAlgorithm * a,
const EventContext & context )
pure virtual

remove the algorithm ("pop_back")


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