All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
AlgContextSvc Class Reference

#include <src/AlgContextSvc.h>

Inheritance diagram for AlgContextSvc:
Collaboration diagram for AlgContextSvc:

Public Member Functions

virtual StatusCode setCurrentAlg (IAlgorithm *a)
 set the currently executing algorithm ("push_back") More...
 
virtual StatusCode unSetCurrentAlg (IAlgorithm *a)
 remove the algorithm ("pop_back") More...
 
virtual IAlgorithmcurrentAlg () const
 accessor to current algorithm: More...
 
virtual const
IAlgContextSvc::Algorithms
algorithms () const
 get the stack of executed algorithms More...
 
virtual void handle (const Incident &)
 handle incident More...
 
virtual StatusCode initialize ()
 standard initialization of the service More...
 
virtual StatusCode finalize ()
 standard finalization of the service More...
 
 AlgContextSvc (const std::string &name, ISvcLocator *svc)
 Standard Constructor. More...
 
virtual ~AlgContextSvc ()
 Standard Destructor. More...
 
- Public Member Functions inherited from extends2< Service, IAlgContextSvc, IIncidentListener >
 extends2 (A1 a1, A2 a2, A3 a3)
 Templated constructor with 3 arguments. More...
 
 extends2 (A1 a1, A2 a2)
 Templated constructor with 2 arguments. More...
 
 extends2 (A1 a1)
 Templated constructor with 1 argument. More...
 
 extends2 ()
 Default constructor. More...
 
virtual void * i_cast (const InterfaceID &tid) const
 Implementation of IInterface::i_cast. More...
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)
 Implementation of IInterface::queryInterface. More...
 
virtual std::vector< std::string > getInterfaceNames () const
 Implementation of IInterface::getInterfaceNames. More...
 
virtual ~extends2 ()
 Virtual destructor. More...
 
- Public Member Functions inherited from Service
virtual unsigned long release ()
 Release Interface instance. More...
 
virtual const std::string & name () const
 Retrieve name of the service. More...
 
virtual StatusCode configure ()
 Configuration (from OFFLINE to CONFIGURED). More...
 
virtual StatusCode start ()
 Start (from INITIALIZED to RUNNING). More...
 
virtual StatusCode stop ()
 Stop (from RUNNING to INITIALIZED). More...
 
virtual StatusCode terminate ()
 Initialization (from CONFIGURED to OFFLINE). More...
 
virtual Gaudi::StateMachine::State FSMState () const
 Get the current state. More...
 
virtual Gaudi::StateMachine::State targetFSMState () const
 When we are in the middle of a transition, get the state where the transition is leading us. More...
 
virtual StatusCode reinitialize ()
 Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...
 
virtual StatusCode restart ()
 Initialization (from RUNNING to RUNNING, via INITIALIZED). More...
 
virtual StatusCode sysInitialize ()
 Initialize Service. More...
 
virtual StatusCode sysStart ()
 Initialize Service. More...
 
virtual StatusCode sysStop ()
 Initialize Service. More...
 
virtual StatusCode sysFinalize ()
 Finalize Service. More...
 
virtual StatusCode sysReinitialize ()
 Re-initialize the Service. More...
 
virtual StatusCode sysRestart ()
 Re-initialize the Service. More...
 
virtual StatusCode setProperty (const Property &p)
 Set the property by property. More...
 
virtual StatusCode setProperty (const std::string &s)
 Set the property by string. More...
 
virtual StatusCode setProperty (const std::string &n, const std::string &v)
 Set the property by std::string. More...
 
virtual StatusCode getProperty (Property *p) const
 Get the property by property. More...
 
virtual const PropertygetProperty (const std::string &name) const
 Get the property by name. More...
 
virtual StatusCode getProperty (const std::string &n, std::string &v) const
 Get the property by std::string. More...
 
virtual const std::vector
< Property * > & 
getProperties () const
 Get list of properties. More...
 
template<class TYPE >
StatusCode setProperty (const std::string &name, const TYPE &value)
 set the property form the value More...
 
 Service (const std::string &name, ISvcLocator *svcloc)
 Standard Constructor. More...
 
SmartIF< ISvcLocator > & serviceLocator () const
 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<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 >
PropertydeclareProperty (const std::string &name, T &property, const std::string &doc="none") const
 Declare the named property. More...
 
PropertydeclareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
 Declare remote named properties. More...
 
SmartIF< IAuditorSvc > & auditorSvc () const
 The standard auditor service.May not be invoked before sysInitialize() has been invoked. More...
 
- Public Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
 CommonMessaging (const A1 &a1, const A2 &a2, const A3 &a3)
 Templated constructor with 3 arguments. More...
 
 CommonMessaging (const A1 &a1, const A2 &a2)
 Templated constructor with 2 arguments. More...
 
 CommonMessaging (const A1 &a1)
 Templated constructor with 1 argument. More...
 
 CommonMessaging ()
 Default constructor. More...
 
virtual ~CommonMessaging ()
 Virtual destructor. More...
 
SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MSG::Level msgLevel () const
 get the output level from the embedded MsgStream More...
 
bool msgLevel (MSG::Level lvl) const
 get the output level from the embedded MsgStream More...
 
- Public Member Functions inherited from extend_interfaces3< IService, IProperty, IStateful >
virtual ~extend_interfaces3 ()
 Virtual destructor. More...
 
- Public Member Functions inherited from IService
 DeclareInterfaceID (IService, 3, 0)
 InterfaceID. More...
 
virtual ~IService ()
 virtual destructor More...
 
- Public Member Functions inherited from INamedInterface
 DeclareInterfaceID (INamedInterface, 1, 0)
 InterfaceID. More...
 
virtual ~INamedInterface ()
 Virtual destructor (always needed for abstract classes). More...
 
- Public Member Functions inherited from IInterface
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance. More...
 
virtual unsigned long refCount () const =0
 Current reference count. More...
 
virtual ~IInterface ()
 Virtual destructor. More...
 
- Public Member Functions inherited from IProperty
 DeclareInterfaceID (IProperty, 2, 0)
 InterfaceID. More...
 
- Public Member Functions inherited from IStateful
 DeclareInterfaceID (IStateful, 1, 0)
 InterfaceID. More...
 
virtual ~IStateful ()
 
- Public Member Functions inherited from extend_interfaces2< IAlgContextSvc, IIncidentListener >
virtual ~extend_interfaces2 ()
 Virtual destructor. More...
 
- Public Member Functions inherited from IAlgContextSvc
 DeclareInterfaceID (IAlgContextSvc, 3, 0)
 InterfaceID. More...
 
- Public Member Functions inherited from IIncidentListener
 DeclareInterfaceID (IIncidentListener, 2, 0)
 InterfaceID. More...
 

Private Member Functions

 AlgContextSvc ()
 no default constructor More...
 
 AlgContextSvc (const AlgContextSvc &)
 no copy constructor More...
 
AlgContextSvcoperator= (const AlgContextSvc &)
 no assignment More...
 

Private Attributes

IAlgContextSvc::Algorithms m_algorithms
 the stack of current algorithms More...
 
IIncidentSvcm_inc
 pointer to Incident Service More...
 
bool m_check
 

Additional Inherited Members

- Public Types inherited from extends2< Service, IAlgContextSvc, IIncidentListener >
typedef extends2 base_class
 Typedef to this class. More...
 
typedef extend_interfaces2
< IAlgContextSvc,
IIncidentListener
extend_interfaces_base
 Typedef to the base of this class. More...
 
typedef
extend_interfaces_base::ext_iids 
interfaces
 MPL set of all the implemented interfaces. More...
 
- Public Types inherited from Service
typedef
Gaudi::PluginService::Factory2
< IService *, const
std::string &, ISvcLocator * > 
Factory
 
- Public Types inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
typedef CommonMessaging base_class
 
- Public Types inherited from implements3< IService, IProperty, IStateful >
typedef implements3 base_class
 Typedef to this class. More...
 
typedef extend_interfaces3
< IService, IProperty,
IStateful
extend_interfaces_base
 Typedef to the base of this class. More...
 
typedef
extend_interfaces_base::ext_iids 
interfaces
 MPL set of all the implemented interfaces. More...
 
- Public Types inherited from extend_interfaces3< IService, IProperty, IStateful >
typedef mpl::fold< typename
IService::iid::iids::type,
typename mpl::fold< typename
IProperty::iid::iids::type,
typename
IStateful::iid::iids::type,
mpl::insert< mpl::_1, mpl::_2 >
>::type, mpl::insert< mpl::_1,
mpl::_2 > >::type 
ext_iids
 MPL set of interfaces extended by this one. More...
 
- Public Types inherited from IInterface
enum  Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
 Return status. More...
 
typedef Gaudi::InterfaceId
< IInterface, 0, 0 > 
iid
 Interface ID. More...
 
typedef mpl::set1< iidext_iids
 Extra interfaces. More...
 
- Public Types inherited from extend_interfaces2< IAlgContextSvc, IIncidentListener >
typedef mpl::fold< typename
IAlgContextSvc::iid::iids::type,
typename
IIncidentListener::iid::iids::type,
mpl::insert< mpl::_1, mpl::_2 >
>::type 
ext_iids
 MPL set of interfaces extended by this one. More...
 
- Public Types inherited from IAlgContextSvc
typedef std::vector< IAlgorithm * > Algorithms
 the actual type of algorithm' stack More...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 
- Protected Member Functions inherited from Service
virtual ~Service ()
 Standard Destructor. More...
 
int outputLevel () const
 get the Service's output level More...
 
- Protected Member Functions inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
void updateMsgStreamOutputLevel (int level)
 Update the output level of the cached MsgStream. More...
 
- Protected Member Functions inherited from IAlgContextSvc
virtual ~IAlgContextSvc ()
 virtual and protected desctructor More...
 
- Protected Attributes inherited from Service
IntegerProperty m_outputLevel
 Service output level. More...
 
Gaudi::StateMachine::State m_state
 Service state. More...
 
Gaudi::StateMachine::State m_targetState
 Service state. More...
 
- Protected Attributes inherited from CommonMessaging< implements3< IService, IProperty, IStateful > >
SmartIF< IMessageSvcm_msgsvc
 Pointer to the message service;. More...
 
std::auto_ptr< MsgStreamm_msgStream
 The predefined message stream. More...
 
bool m_streamWithService
 Flag to create a new MsgStream if it was created without the message service. More...
 

Detailed Description

Definition at line 27 of file AlgContextSvc.h.

Constructor & Destructor Documentation

AlgContextSvc::AlgContextSvc ( const std::string &  name,
ISvcLocator svc 
)

Standard Constructor.

Instantiation of a static factory class used by clients to create instances of this service.

See also
Service

Definition at line 29 of file AlgContextSvc.cpp.

31  : base_class ( name , svc )
32  , m_algorithms ( 0 )
33  , m_inc ( 0 )
34  , m_check ( true )
35 {
36  declareProperty ( "Check" , m_check , "Flag to perform more checks" );
37 }
IAlgContextSvc::Algorithms m_algorithms
the stack of current algorithms
Definition: AlgContextSvc.h:63
extends2 base_class
Typedef to this class.
Definition: extends.h:77
virtual const std::string & name() const
Retrieve name of the service.
Definition: Service.cpp:331
IIncidentSvc * m_inc
pointer to Incident Service
Definition: AlgContextSvc.h:65
Property * declareProperty(const std::string &name, T &property, const std::string &doc="none") const
Declare the named property.
Definition: Service.h:209
AlgContextSvc::~AlgContextSvc ( )
virtual

Standard Destructor.

Definition at line 41 of file AlgContextSvc.cpp.

41 {}
AlgContextSvc::AlgContextSvc ( )
private

no default constructor

AlgContextSvc::AlgContextSvc ( const AlgContextSvc )
private

no copy constructor

Member Function Documentation

virtual const IAlgContextSvc::Algorithms& AlgContextSvc::algorithms ( ) const
inlinevirtual

get the stack of executed algorithms

See also
IAlgContextSvc

Implements IAlgContextSvc.

Definition at line 37 of file AlgContextSvc.h.

38  { return m_algorithms ; }
IAlgContextSvc::Algorithms m_algorithms
the stack of current algorithms
Definition: AlgContextSvc.h:63
IAlgorithm * AlgContextSvc::currentAlg ( ) const
virtual

accessor to current algorithm:

See also
IAlgContextSvc

Implements IAlgContextSvc.

Definition at line 150 of file AlgContextSvc.cpp.

151 { return m_algorithms.empty() ? 0 : m_algorithms.back() ; }
IAlgContextSvc::Algorithms m_algorithms
the stack of current algorithms
Definition: AlgContextSvc.h:63
StatusCode AlgContextSvc::finalize ( )
virtual

standard finalization of the service

See also
IService

Reimplemented from Service.

Definition at line 88 of file AlgContextSvc.cpp.

89 {
90  if ( !m_algorithms.empty() )
91  {
92  MsgStream log ( msgSvc() , name() ) ;
93  log << MSG::WARNING
94  << "Non-empty stack of algorithms #"
95  << m_algorithms.size() << endmsg ;
96  }
97  // Incident Service
98  if ( 0 != m_inc )
99  {
100  m_inc -> removeListener ( this ) ;
101  m_inc -> release() ;
102  m_inc = 0 ;
103  }
104  // finalize the base class
105  return Service::finalize () ;
106 }
IAlgContextSvc::Algorithms m_algorithms
the stack of current algorithms
Definition: AlgContextSvc.h:63
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
virtual const std::string & name() const
Retrieve name of the service.
Definition: Service.cpp:331
IIncidentSvc * m_inc
pointer to Incident Service
Definition: AlgContextSvc.h:65
virtual unsigned long release()
Release Interface instance.
Definition: Service.cpp:24
virtual StatusCode finalize()
Finalize (from INITIALIZED to CONFIGURED).
Definition: Service.cpp:199
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:243
void AlgContextSvc::handle ( const Incident )
virtual

handle incident

See also
IIncidentListener

Implements IIncidentListener.

Definition at line 155 of file AlgContextSvc.cpp.

156 {
157  if ( !m_algorithms.empty() )
158  {
159  MsgStream log ( msgSvc() , name() ) ;
160  log << MSG::ERROR
161  << "Non-empty stack of algorithms #"
162  << m_algorithms.size() << endmsg ;
163  }
164 }
IAlgContextSvc::Algorithms m_algorithms
the stack of current algorithms
Definition: AlgContextSvc.h:63
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
virtual const std::string & name() const
Retrieve name of the service.
Definition: Service.cpp:331
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:243
StatusCode AlgContextSvc::initialize ( )
virtual

standard initialization of the service

See also
IService

Reimplemented from Service.

Definition at line 45 of file AlgContextSvc.cpp.

46 {
47  // Initialize the base class
49  if ( sc.isFailure () ) { return sc ; }
50  // Incident Service
51  if ( 0 != m_inc )
52  {
53  m_inc -> removeListener ( this ) ;
54  m_inc -> release() ;
55  m_inc = 0 ;
56  }
57  // perform more checks?
58  if ( m_check )
59  {
60  sc = Service::service ( "IncidentSvc" , m_inc , true ) ;
61  if ( sc.isFailure() )
62  {
63  MsgStream log ( msgSvc() , name() ) ;
64  log << MSG::ERROR << "Could not locate 'IncidentSvc'" << sc << endmsg ;
65  return sc ; // RETURN
66  }
67  if ( 0 == m_inc )
68  {
69  MsgStream log ( msgSvc() , name() ) ;
70  log << MSG::ERROR << "Invalid pointer to IIncindentSvc" << endmsg ;
71  return StatusCode::FAILURE ; // RETURN
72  }
73  m_inc -> addListener ( this , IncidentType::BeginEvent ) ;
74  m_inc -> addListener ( this , IncidentType::EndEvent ) ;
75  }
76  if ( !m_algorithms.empty() )
77  {
78  MsgStream log ( msgSvc() , name() ) ;
79  log << MSG::WARNING
80  << "Non-empty stack of algorithms #"
81  << m_algorithms.size() << endmsg ;
82  }
83  return StatusCode::SUCCESS ;
84 }
const std::string BeginEvent
Processing of a new event has started.
Definition: Incident.h:60
IAlgContextSvc::Algorithms m_algorithms
the stack of current algorithms
Definition: AlgContextSvc.h:63
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
bool isFailure() const
Test for a status code of FAILURE.
Definition: StatusCode.h:72
const std::string EndEvent
Processing of the last event has finished.
Definition: Incident.h:61
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:30
virtual const std::string & name() const
Retrieve name of the service.
Definition: Service.cpp:331
virtual StatusCode initialize()
Initialization (from CONFIGURED to INITIALIZED).
Definition: Service.cpp:74
IIncidentSvc * m_inc
pointer to Incident Service
Definition: AlgContextSvc.h:65
virtual unsigned long release()
Release Interface instance.
Definition: Service.cpp:24
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.
Definition: Service.h:140
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:243
AlgContextSvc& AlgContextSvc::operator= ( const AlgContextSvc )
private

no assignment

StatusCode AlgContextSvc::setCurrentAlg ( IAlgorithm a)
virtual

set the currently executing algorithm ("push_back")

See also
IAlgContextSvc

Implements IAlgContextSvc.

Definition at line 110 of file AlgContextSvc.cpp.

111 {
112  if ( 0 == a )
113  {
114  MsgStream log ( msgSvc() , name() ) ;
115  log << MSG::WARNING << "IAlgorithm* points to NULL" << endmsg ;
116  //
117  return StatusCode::RECOVERABLE ; // RETURN
118  }
119  m_algorithms.push_back ( a ) ;
120  //
121  return StatusCode::SUCCESS ; // RETURN
122 }
IAlgContextSvc::Algorithms m_algorithms
the stack of current algorithms
Definition: AlgContextSvc.h:63
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
virtual const std::string & name() const
Retrieve name of the service.
Definition: Service.cpp:331
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:243
StatusCode AlgContextSvc::unSetCurrentAlg ( IAlgorithm a)
virtual

remove the algorithm ("pop_back")

See also
IAlgContextSvc

Implements IAlgContextSvc.

Definition at line 126 of file AlgContextSvc.cpp.

127 {
128  if ( 0 == a )
129  {
130  MsgStream log ( msgSvc() , name() ) ;
131  log << MSG::WARNING << "IAlgorithm* points to NULL" << endmsg ;
132  //
133  return StatusCode::RECOVERABLE ; // RETURN
134  }
135  if ( m_algorithms.empty() || m_algorithms.back() != a )
136  {
137  MsgStream log ( msgSvc() , name() ) ;
138  log << MSG::ERROR << "Algorithm stack is invalid" << endmsg ;
139  //
140  return StatusCode::FAILURE ;
141  }
142  //
143  m_algorithms.pop_back() ; // POP_BACK
144  //
145  return StatusCode::SUCCESS ;
146 }
IAlgContextSvc::Algorithms m_algorithms
the stack of current algorithms
Definition: AlgContextSvc.h:63
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
virtual const std::string & name() const
Retrieve name of the service.
Definition: Service.cpp:331
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:243

Member Data Documentation

IAlgContextSvc::Algorithms AlgContextSvc::m_algorithms
private

the stack of current algorithms

Definition at line 63 of file AlgContextSvc.h.

bool AlgContextSvc::m_check
private

Definition at line 67 of file AlgContextSvc.h.

IIncidentSvc* AlgContextSvc::m_inc
private

pointer to Incident Service

Definition at line 65 of file AlgContextSvc.h.


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