genie::PDGCodeList Class Reference

A list of PDG codes. More...

#include <PDGCodeList.h>

Inheritance diagram for genie::PDGCodeList:

Collaboration diagram for genie::PDGCodeList:

Public Member Functions
	PDGCodeList (bool allowdup=false)
	PDGCodeList (size_type n, bool allowdup=false)
	PDGCodeList (const PDGCodeList &list)
	~PDGCodeList ()
void	push_back (int pdg_code)
void	insert (iterator pos, size_type n, const int &x)
bool	CheckPDGCode (int pdg_code) const
	PDG code checks used by PDGCodeList.
bool	ExistsInPDGLibrary (int pdg_code) const
bool	ExistsInPDGCodeList (int pdg_code) const
void	Copy (const PDGCodeList &list)
	copy / print
void	Print (ostream &stream) const
bool	DuplEntriesAllowed (void) const
	check state
PDGCodeList &	operator= (const PDGCodeList &list)
	overloaded operators

Private Attributes
bool	fAllowDuplicateEntries
	allow duplicate entries in the list?

Friends
ostream &	operator<< (ostream &stream, const PDGCodeList &list)

Detailed Description

A list of PDG codes.

Author

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

Created:\n May 13, 2005

License:\n Copyright (c) 2003-2025, The GENIE Collaboration

For the full text of the license visit http://copyright.genie-mc.org

Definition at line 32 of file PDGCodeList.h.

Constructor & Destructor Documentation

PDGCodeList() [1/3]

PDGCodeList::PDGCodeList

(

bool

allowdup = false

)

Definition at line 35 of file PDGCodeList.cxx.

                                      :
vector<int>()
{
  fAllowDuplicateEntries = allowdup;
}

References fAllowDuplicateEntries.

Referenced by Copy(), operator<<, operator=(), and PDGCodeList().

PDGCodeList() [2/3]

PDGCodeList::PDGCodeList	(	size_type	n,
		bool	allowdup = false )

Definition at line 41 of file PDGCodeList.cxx.

                                                   :
vector<int>(n)
{
  fAllowDuplicateEntries = allowdup;
}

References fAllowDuplicateEntries.

PDGCodeList() [3/3]

PDGCodeList::PDGCodeList

(

const PDGCodeList &

list

)

Definition at line 47 of file PDGCodeList.cxx.

                                                 :
vector<int>()
{
  this->Copy(list);
}

References Copy(), and PDGCodeList().

~PDGCodeList()

PDGCodeList::~PDGCodeList

(

)

Definition at line 53 of file PDGCodeList.cxx.

{
 
}

Member Function Documentation

CheckPDGCode()

bool PDGCodeList::CheckPDGCode

(

int

pdg_code

)

const

PDG code checks used by PDGCodeList.

Definition at line 71 of file PDGCodeList.cxx.

{
// check whether the PDG code can be inserted
 
  bool exists = this->ExistsInPDGLibrary(pdg_code);
  if(!exists) {
    LOG("PDG", pERROR)
           << "Can't add non-existent particle [pdgc = " << pdg_code << "]";
    return false;
  }
 
  if(!fAllowDuplicateEntries) {
    bool added = this->ExistsInPDGCodeList(pdg_code);
    if(added) {
      LOG("PDG", pDEBUG)
                << "Particle [pdgc = " << pdg_code << "] was already added";
      return false;
    }
  }
  return true;
}

References ExistsInPDGCodeList(), ExistsInPDGLibrary(), fAllowDuplicateEntries, LOG, pDEBUG, and pERROR.

Referenced by insert(), and push_back().

Copy()

void PDGCodeList::Copy

(

const PDGCodeList &

list

)

copy / print

Definition at line 145 of file PDGCodeList.cxx.

{
  this->clear();
 
  PDGCodeList::const_iterator iter;
  for(iter = list.begin(); iter != list.end(); ++iter) {
    int code = *iter;
    this->push_back(code);
  }
 
  fAllowDuplicateEntries = list.fAllowDuplicateEntries;
}

References clear, fAllowDuplicateEntries, PDGCodeList(), and push_back().

Referenced by operator=(), and PDGCodeList().

DuplEntriesAllowed()

bool genie::PDGCodeList::DuplEntriesAllowed ( void ) const

inline

check state

Definition at line 56 of file PDGCodeList.h.

{ return fAllowDuplicateEntries; }

References fAllowDuplicateEntries.

ExistsInPDGCodeList()

bool PDGCodeList::ExistsInPDGCodeList

(

int

pdg_code

)

const

Definition at line 103 of file PDGCodeList.cxx.

{
// check whether the PDG code already exists in the list
 
  PDGCodeList::const_iterator bci = this->begin();
  PDGCodeList::const_iterator eci = this->end();
 
  if(find(bci,eci,pdg_code) != eci) return true;
 
  return false;
/*
  int n = count(this->begin(), this->end(), pdg_code);
  if(n!=0) return true;
  return false;
*/
}

Referenced by CheckDecayerConsistency(), and CheckPDGCode().

ExistsInPDGLibrary()

bool PDGCodeList::ExistsInPDGLibrary

(

int

pdg_code

)

const

Definition at line 93 of file PDGCodeList.cxx.

{
// check whether the PDG code is a valid one (exists in PDGLibrary)
 
  PDGLibrary * pdglib = PDGLibrary::Instance();
  TParticlePDG * particle = pdglib->Find(pdg_code);
  if(!particle) return false;
  return true;
}

References genie::PDGLibrary::Find(), and genie::PDGLibrary::Instance().

Referenced by CheckPDGCode().

insert()

void PDGCodeList::insert	(	iterator	pos,
		size_type	n,
		const int &	x )

Definition at line 63 of file PDGCodeList.cxx.

{
  if(this->CheckPDGCode(pdg_code)) {
     if(n>1) n = 1;
     vector<int>::insert(pos,n,pdg_code);
  }
}

References CheckPDGCode().

operator=()

PDGCodeList & PDGCodeList::operator=

(

const PDGCodeList &

list

)

overloaded operators

Definition at line 158 of file PDGCodeList.cxx.

{
  this->Copy(list);
  return (*this);
}

References Copy(), and PDGCodeList().

Print()

void PDGCodeList::Print

(

ostream &

stream

)

const

Definition at line 120 of file PDGCodeList.cxx.

{
  stream << "\n[-]" << endl;
 
  PDGLibrary * pdglib = PDGLibrary::Instance();
 
  PDGCodeList::const_iterator iter;
  size_t nc = this->size();
 
  for(iter = this->begin(); iter != this->end(); ++iter) {
    int pdg_code = *iter;
    TParticlePDG * p = pdglib->Find(pdg_code);
 
    if(!p) {
      stream << " |---o ** ERR: no particle with PDG code: " << pdg_code;
    } else {
      string name = p->GetName();
      stream << " |---o "
             << setfill(' ') << setw(15) << name
             << " (PDG code = " << pdg_code << ")";
    }
    if( (--nc) > 0) stream << endl;
  }
}

References genie::PDGLibrary::Find(), and genie::PDGLibrary::Instance().

Referenced by operator<<.

push_back()

void PDGCodeList::push_back

(

int

pdg_code

)

override the vector<int> insertion methods to explicitly check for PDG code validity and that no PDG code is listed more than once

Definition at line 58 of file PDGCodeList.cxx.

{
  if(this->CheckPDGCode(pdg_code)) vector<int>::push_back(pdg_code);
}

References CheckPDGCode().

Referenced by CheckDecayerConsistency(), Configure(), Copy(), genie::utils::nnbar_osc::DecayProductList(), genie::utils::intranuke2018::Equilibrium(), genie::utils::intranuke2025::Equilibrium(), genie::utils::intranuke::Equilibrium(), genie::hnl::Decayer::GenerateDecayProducts(), genie::AGKYLowW2019::GenerateHadronCodes(), GetNeutrinoCodes(), GetPDGCodeListFromString(), GetTargetCodes(), genie::AGCharmPythiaBaseHadro2023::Hadronize(), genie::hnl::FluxCreator::HNLEnergy(), genie::HAIntranuke2018::Inelastic(), genie::HAIntranuke2025::Inelastic(), genie::HAIntranuke::Inelastic(), main(), genie::MECGenerator::NucleonClusterConstituents(), genie::utils::intranuke2018::PreEquilibrium(), genie::utils::intranuke2025::PreEquilibrium(), genie::utils::intranuke::PreEquilibrium(), genie::flux::GJPARCNuFlux::SetDefaults(), and genie::flux::GNuMIFlux::SetDefaults().

Friends And Related Symbol Documentation

operator<<

ostream & operator<< ( ostream & stream, const PDGCodeList & list )

friend

Definition at line 28 of file PDGCodeList.cxx.

 {
   list.Print(stream);
   return stream;
 }

References PDGCodeList(), and Print().

Member Data Documentation

fAllowDuplicateEntries

bool genie::PDGCodeList::fAllowDuplicateEntries

private

allow duplicate entries in the list?

Definition at line 64 of file PDGCodeList.h.

Referenced by CheckPDGCode(), Copy(), DuplEntriesAllowed(), PDGCodeList(), and PDGCodeList().

---

The documentation for this class was generated from the following files:

• PDGCodeList.h
• PDGCodeList.cxx