ISimulationSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISF_INTERFACES_ISIMULATIONSVC_H
#define ISF_INTERFACES_ISIMULATIONSVC_H 1
 
// stl includes
#include <string>
 
// Framework includes
#include "GaudiKernel/IInterface.h"
#include "GaudiKernel/StatusCode.h"
 
// ISF includes
#include "ISF_Event/ISFParticleContainer.h"
#include "ISF_Event/SimSvcID.h"
 
#include "CxxUtils/checker_macros.h"
 
class McEventCollection;
 
namespace ISF {
 
  class ISFParticle;
  class IParticleBroker;

  class ATLAS_NOT_THREAD_SAFE ISimulationSvc : virtual public IInterface {

    // Public methods:
  public:
    ISimulationSvc() { };

    DeclareInterfaceID(ISimulationSvc, 1, 0);

    virtual StatusCode setParticleBroker( IParticleBroker *broker) = 0;

    virtual StatusCode simulateVector(const ISFParticleVector &particles, McEventCollection* mcEventCollection, McEventCollection *shadowTruth=nullptr) = 0;

    virtual StatusCode simulate(ISFParticle& isp, McEventCollection* mcEventCollection) = 0;

    virtual const std::string& simSvcDescriptor() = 0;

    virtual StatusCode setupEvent() = 0;

    virtual StatusCode releaseEvent() = 0;

    inline void assignSimSvcID(SimSvcID id);

    inline SimSvcID simSvcID();
 
  private:
    SimSvcID        m_ssvcID{ISF::fUndefinedSimID};
  };

  inline void ISimulationSvc::assignSimSvcID(SimSvcID id) { m_ssvcID = id; }
  inline SimSvcID ISimulationSvc::simSvcID() { return m_ssvcID; }
 
}
 
#endif //> !ISF_INTERFACES_ISIMULATIONSVC_H