ForwardDetectors/ForwardTracker/ForwardTracker/IParticle.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef FORWARDTRACKER_IPARTICLE_H
#define FORWARDTRACKER_IPARTICLE_H
 
#include <string>
 
namespace ForwardTracker {
 
  class IBeamElement;
  class Point;
  class TransversePoint;
 
  class IParticle {
  
  public:
    
    virtual ~IParticle() {};
    
    virtual Point           position()           const = 0;
    virtual Point&          position()                 = 0;
    virtual Point           positionRelBeam()    const = 0;
    virtual Point           direction()          const = 0;
    virtual Point&          direction()                = 0;
    virtual TransversePoint displacement()       const = 0;
    virtual TransversePoint transversePosition() const = 0;
    virtual double          z()                  const = 0;
    virtual double&         z()                        = 0; 
    virtual double          momentum()           const = 0;
    virtual bool            charged()            const = 0;
    virtual bool            isOutOfAperture()    const = 0;
    virtual bool            debug()              const = 0;
 
    virtual void updatePositionFromDisplacement(const TransversePoint&) = 0;
    virtual void setBeamCoordinateShift        (const TransversePoint&) = 0;
    virtual void setBeamCoordinateShift        (const IBeamElement*)    = 0;
    virtual void setOutOfAperture              (bool)                   = 0;    
    virtual void setDebug                      (bool)                   = 0;
    virtual void addMsg                        (const std::string&)     = 0;
    
    virtual std::string str() const = 0;
 
    // Helper to work around cppcheck false positive.
    Point&          direction_nc() { return direction(); }
  };
  
  std::ostream& operator<<(std::ostream&, const IParticle&);
}
 
#endif