ITRT_TrackSegmentsMaker.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
*/

//  Header file for class ITRT_TrackSegmentsMaker
// (c) ATLAS Detector software
//
//  Base class for track candidates generation using TRT_DriftCircles information
//
//  Example implementation
//
//  segmentsmaker->newEvent();      
//
//  segmentsmaker->find();
//
//  const Trk::TrackSegment* tracksegment = 0;
//
//  while((tracksegment=segmentsmaker->next())) {
//       do some method with TRT track segment;
//  }
//
// Version 1.0 11/10/2005 I.Gavrilenko
 
#ifndef ITRT_TrackSegmentsMaker_H
#define ITRT_TrackSegmentsMaker_H
 
#include "GaudiKernel/AlgTool.h"
#include "GaudiKernel/EventContext.h"
#include "Identifier/IdentifierHash.h"
#include "TrkSegment/TrackSegment.h"
#include "VxVertex/Vertex.h"
#include "TRT_ReadoutGeometry/TRT_DetElementLink_xk.h"
 
class MsgStream;
 
namespace InDet {
 
  static const InterfaceID IID_ITRT_TrackSegmentsMaker
    ("InDet::ITRT_TrackSegmentsMaker",1,0);
 
  class ITRT_TrackSegmentsMaker : virtual public IAlgTool 
    {
      // Public methods:
      
    public:
      class IEventData {
      public:
         virtual ~IEventData() {}
      };

      // Standard tool methods
 
      static const InterfaceID& interfaceID();
      virtual StatusCode initialize ()=0;
      virtual StatusCode finalize   ()=0;

      // Methods to initialize tool for new event or region
 
      virtual std::unique_ptr<InDet::ITRT_TrackSegmentsMaker::IEventData> newEvent (const EventContext& ctx) const =0;
      virtual std::unique_ptr<InDet::ITRT_TrackSegmentsMaker::IEventData> newRegion(const EventContext& ctx, const std::vector<IdentifierHash>&) const =0;
      virtual void endEvent (InDet::ITRT_TrackSegmentsMaker::IEventData &event_data) const =0;

      // Methods of seeds production without vertex constraint
 
      virtual void find(
          const EventContext& ctx,
          InDet::ITRT_TrackSegmentsMaker::IEventData& event_data,
          InDet::TRT_DetElementLink_xk::TRT_DetElemUsedMap& used) const = 0;

      // Iterator through track segments pseudo collection produced 
      // accordingly methods find    
      
      virtual Trk::TrackSegment* next(InDet::ITRT_TrackSegmentsMaker::IEventData &event_data) const =0;
      
      // Print internal tool parameters and status
     
      virtual MsgStream&    dump(MsgStream&    out) const=0;
      virtual std::ostream& dump(std::ostream& out) const=0;
     
    };
  
  // Overload of << operator for MsgStream and  std::ostream
  
  MsgStream&    operator << (MsgStream&   ,const ITRT_TrackSegmentsMaker&);
  std::ostream& operator << (std::ostream&,const ITRT_TrackSegmentsMaker&);
  
  // Inline methods
 
  inline const InterfaceID& ITRT_TrackSegmentsMaker::interfaceID()
    {
      return IID_ITRT_TrackSegmentsMaker;
    }

  // Overload of << operator MsgStream
   
  inline MsgStream& operator    << 
    (MsgStream& sl,const ITRT_TrackSegmentsMaker& se)
    { 
      return se.dump(sl); 
    }

  // Overload of << operator std::ostream
  
  inline std::ostream& operator << 
    (std::ostream& sl,const ITRT_TrackSegmentsMaker& se)
    { 
      return se.dump(sl); 
    }   
} // end of name space
 
 
#endif // ITRT_TrackSegmentsMaker_H