IPRD_AssociationTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRKAMBIGUITYPROCESSOR_IPRD_ASSOCIATIONTOOL_H
#define TRKAMBIGUITYPROCESSOR_IPRD_ASSOCIATIONTOOL_H
 
#include "GaudiKernel/IAlgTool.h"
#include "TrkEventUtils/PRDtoTrackMap.h"
#include <map>
#include <set>
 
class AtlasDetectorID;
class Identifier;
 
namespace Trk {
 
class Track;
class PrepRawData;

class IPRD_AssociationTool : virtual public IAlgTool
{
public:
  DeclareInterfaceID(IPRD_AssociationTool, 1, 0);
 
  //      typedef std::pair<const PrepRawData*, const Track*>
  //      PrepRawDataTrackMapPair;
  using PrepRawDataTrackMap = PRDtoTrackMap::PrepRawDataTrackMap;
  using PRD_MapIt = PrepRawDataTrackMap::iterator;
  using ConstPRD_MapIt = PrepRawDataTrackMap::const_iterator;
  using PrepRawDataTrackMapRange = std::pair<ConstPRD_MapIt, ConstPRD_MapIt>;
  using TrackPrepRawDataMap = PRDtoTrackMap::TrackPrepRawDataMap;

  typedef std::set<const Track*> TrackSet;

  struct Maps
  {
    // holds the tracks associated with each PRD (i.e. the PRD* is the key)
    IPRD_AssociationTool::PrepRawDataTrackMap m_prepRawDataTrackMap;
    // holds the PRDs associated with each Track (i.e. the Track* is the key)
    IPRD_AssociationTool::TrackPrepRawDataMap m_trackPrepRawDataMap;
  };

  virtual StatusCode addPRDs(Maps& maps, const Track& track) const = 0;

  virtual StatusCode addPRDs(const Track& track) = 0;

  virtual StatusCode removePRDs(Maps& maps, const Track& track) const = 0;

  virtual StatusCode removePRDs(const Track& track) = 0;

  virtual bool isUsed(const Maps& maps, const PrepRawData& prd) const = 0;

  virtual bool isUsed(const PrepRawData& prd) const = 0;

  virtual bool isShared(const Maps& maps, const PrepRawData& prd) const = 0;

  virtual bool isShared(const PrepRawData& prd) const = 0;

  virtual std::vector<const PrepRawData*> getPrdsOnTrack(
    const Track& track) const = 0;
 
  // getPrdsOnTrack with state passed explicitly.
  virtual std::vector<const PrepRawData*> getPrdsOnTrack(
    const Maps& maps,
    const Track& track) const = 0;

  virtual TrackSet findConnectedTracks(const Track& track) const = 0;
 
  // findConnectedTracks with state passed explicitly.
  virtual TrackSet findConnectedTracks(const Maps& maps,
                                       const Track& track) const = 0;

  virtual PrepRawDataTrackMapRange onTracks(const PrepRawData& prd) const = 0;
 
  // onTracks with explicit state
  virtual PrepRawDataTrackMapRange onTracks(const Maps& maps,
                                            const PrepRawData& prd) const = 0;

  virtual void reset() = 0;
};
 
} // end of ns
 
#endif