ProcessInfo.h

Go to the documentation of this file.

//____________________________________________________________________________
/*!

\class    genie::ProcessInfo

\brief    A class encapsulating an enumeration of interaction types (EM,
          Weak-CC, Weak-NC) and scattering types (Elastic, Quasi Elastic,
          Deep Inelastic, Resonant Single Pion Production, Coherent Pion
          Production).

\author   Costas Andreopoulos <c.andreopoulos \at cern.ch>
          University of Liverpool

         Changes required to implement the GENIE Boosted Dark Matter module
          were installed by Josh Berger (Univ. of Wisconsin)

          Changes required to implement the GENIE Dark Neutrino module
          were installed by Iker de Icaza (Univ. of Sussex)

\created  May 04, 2004

\cpright  Copyright (c) 2003-2024, The GENIE Collaboration
          For the full text of the license visit http://copyright.genie-mc.org
*/
//____________________________________________________________________________

#ifndef _PROCESS_INFO_H_
#define _PROCESS_INFO_H_

#include <iostream>
#include <string>

#include <TObject.h>

#include "Framework/Interaction/InteractionType.h"
#include "Framework/Interaction/ScatteringType.h"

using std::ostream;
using std::string;

namespace genie {

class ProcessInfo;
ostream & operator << (ostream& stream, const ProcessInfo & proc);

class ProcessInfo : public TObject {

public:
  using TObject::Print; // suppress clang 'hides overloaded virtual function [-Woverloaded-virtual]' warnings
  using TObject::Copy;
  using TObject::Compare;

  ProcessInfo();
  ProcessInfo(ScatteringType_t sc_type, InteractionType_t  int_type);
  ProcessInfo(const ProcessInfo & proc);
 ~ProcessInfo();

  // Set process information
  void Set(ScatteringType_t sc_type, InteractionType_t  int_type);

  // Query for process information
  bool IsQuasiElastic            (void) const;
  bool IsDarkMatterElastic       (void) const;
  bool IsDeepInelastic           (void) const;
  bool IsDarkMatterDeepInelastic (void) const;
  bool IsResonant                (void) const;
  bool IsCoherentProduction      (void) const;
  bool IsCoherentElastic         (void) const;
  bool IsSinglePion              (void) const;
  bool IsSingleKaon              (void) const;
  bool IsElectronScattering      (void) const;
  bool IsNuElectronElastic       (void) const;
  bool IsInverseMuDecay          (void) const;
  bool IsIMDAnnihilation         (void) const;
  bool IsNorm                    (void) const;
  bool IsDarkMatterElectronElastic (void) const;
  bool IsInverseBetaDecay        (void) const;
  bool IsGlashowResonance        (void) const;
  bool IsPhotonResonance         (void) const;
  bool IsPhotonCoherent          (void) const;
  bool IsAMNuGamma               (void) const;
  bool IsMEC                     (void) const;
  bool IsDiffractive             (void) const;
  bool IsEM                      (void) const;
  bool IsWeak                    (void) const;
  bool IsWeakCC                  (void) const;
  bool IsWeakNC                  (void) const;
  bool IsWeakMix                 (void) const;
  bool IsDarkMatter              (void) const;
  bool IsDarkNeutralCurrent      (void) const;
  bool IsHNLDecay                (void) const;
  bool IsKnown                   (void) const;

  // Get scattering and interaction type enumerations
  ScatteringType_t  ScatteringTypeId  (void) const;
  InteractionType_t InteractionTypeId (void) const;

  // Get scattering and interaction types as strings
  string ScatteringTypeAsString  (void) const;
  string InteractionTypeAsString (void) const;

  // Copy, reset, compare, print itself and build string code
  void   Reset    (void);
  void   Copy     (const ProcessInfo & proc);
  bool   Compare  (const ProcessInfo & proc) const;
  string AsString (void) const;
  void   Print    (ostream & stream) const;

  bool             operator == (const ProcessInfo & proc) const;
  ProcessInfo &    operator =  (const ProcessInfo & proc);
  friend ostream & operator << (ostream& stream, const ProcessInfo & proc);

private:

  ScatteringType_t  fScatteringType;  ///< scattering type  (QEL, RES, DIS, ...)
  InteractionType_t fInteractionType; ///< interaction type (Weak CC/NC, E/M, ...)

ClassDef(ProcessInfo,1)
};

}        // genie namespace

#endif   // _PROCESS_INFO_H_