Service.h

Go to the documentation of this file.

// $Id: Service.h,v 1.23 2008/06/02 14:20:37 marcocle Exp $
// ============================================================================
#ifndef GAUDIKERNEL_SERVICE_H
#define GAUDIKERNEL_SERVICE_H
// ============================================================================
// Include files
// ============================================================================
#include "GaudiKernel/IService.h"
#include "GaudiKernel/ISvcLocator.h"
#include "GaudiKernel/IProperty.h"
#include "GaudiKernel/IStateful.h"
#include "GaudiKernel/PropertyMgr.h"
#include "GaudiKernel/Property.h"
#include "GaudiKernel/IAuditorSvc.h"
// ============================================================================
#include <vector>
// ============================================================================
// Forward delarations
// ============================================================================
class IMessageSvc;
class ISvcManager;
class ServiceManager;
// ============================================================================
class Service : public virtual IService,
                public virtual IProperty,
                public virtual IStateful {
public:
  friend class ServiceManager;
  virtual StatusCode queryInterface(const InterfaceID& riid, void** ppvUnknown);

  virtual unsigned long addRef();

  virtual unsigned long release();

  virtual const std::string& name() const;
  virtual const InterfaceID& type() const;

  // State machine implementation
  virtual StatusCode configure() { return StatusCode::SUCCESS; }
  virtual StatusCode initialize();
  virtual StatusCode start();
  virtual StatusCode stop();
  virtual StatusCode finalize();
  virtual StatusCode terminate() { return StatusCode::SUCCESS; }
  virtual Gaudi::StateMachine::State FSMState() const { return m_state; }
  virtual Gaudi::StateMachine::State targetFSMState() const { return m_targetState; }
  virtual StatusCode reinitialize();
  virtual StatusCode restart();
  
  virtual StatusCode sysInitialize();
  virtual StatusCode sysStart();
  virtual StatusCode sysStop();
  virtual StatusCode sysFinalize();
  virtual StatusCode sysReinitialize();
  virtual StatusCode sysRestart();

  // Default implementations for ISetProperty
  virtual StatusCode setProperty(const Property& p);
  virtual StatusCode setProperty( const std::string& s );
  virtual StatusCode setProperty( const std::string& n, const std::string& v);
  virtual StatusCode getProperty(Property* p) const;
  virtual const Property& getProperty( const std::string& name) const;
  virtual StatusCode getProperty( const std::string& n, std::string& v ) const;
  virtual const std::vector<Property*>& getProperties( ) const;

  template <class TYPE>
  StatusCode setProperty 
  ( const std::string& name  , 
    const TYPE&        value ) 
  { return Gaudi::Utils::setProperty ( m_propertyMgr , name , value ) ; }

  Service( const std::string& name, ISvcLocator* svcloc);
  ISvcLocator* serviceLocator() const;
  IMessageSvc* msgSvc();
  IMessageSvc* msgSvc() const;
  // Obsoleted name, kept due to the backwards compatibility
  IMessageSvc* messageService();
  IMessageSvc* messageService() const;


  StatusCode setProperties();

  template <class T>
  StatusCode service( const std::string& name, T*& psvc, bool createIf = true ) const {
    return service_i(name, createIf, T::interfaceID(), (void**)&psvc);
  }

  template <class T>
  StatusCode service( const std::string& svcType, const std::string& svcName,
                      T*& psvc) const {
    return service_i(svcType, svcName, T::interfaceID(), (void**)&psvc);
  }
  // ==========================================================================
  template <class T>
  Property* declareProperty
  ( const std::string& name              , 
    T&                 property          ,
    const std::string& doc      = "none" ) const 
  { 
    return m_propertyMgr -> declareProperty ( name , property , doc ) ;
  }
  // ==========================================================================
  Property* declareRemoteProperty
  ( const std::string& name       , 
    IProperty*         rsvc       , 
    const std::string& rname = "" ) const 
  {
        return m_propertyMgr -> declareRemoteProperty ( name , rsvc , rname ) ;
  }
  // ==========================================================================
  IAuditorSvc* auditorSvc() const;

protected:
  virtual ~Service();
  IntegerProperty m_outputLevel;
  Gaudi::StateMachine::State    m_state;
  Gaudi::StateMachine::State    m_targetState;
  mutable IMessageSvc*  m_messageSvc;

  int  outputLevel() const { return m_outputLevel.value(); }

private:
  std::string   m_name;
  unsigned long m_refCount;
  ISvcLocator*  m_svcLocator;
  ISvcManager*  m_svcManager;
  PropertyMgr*  m_propertyMgr;
  StatusCode service_i(const std::string& svcName,
                       bool createIf,
                       const InterfaceID& iid,
                       void** ppSvc) const;
  StatusCode service_i(const std::string& svcType,
                       const std::string& svcName,
                       const InterfaceID& iid,
                       void** ppSvc) const;
  void setServiceManager(ISvcManager*);

  mutable IAuditorSvc*  m_pAuditorSvc;
  BooleanProperty       m_auditInit;
  bool                  m_auditorInitialize;
  bool                  m_auditorStart;
  bool                  m_auditorStop;
  bool                  m_auditorFinalize;
  bool                  m_auditorReinitialize;
  bool                  m_auditorRestart;

  void initOutputLevel(Property& prop);
};

#endif // GAUDIKERNEL_SERVICE_H