include/EvtGenBase/EvtId.hh

0001
0002 /***********************************************************************
0003 * Copyright 1998-2020 CERN for the benefit of the EvtGen authors       *
0004 *                                                                      *
0005 * This file is part of EvtGen.                                         *
0006 *                                                                      *
0007 * EvtGen is free software: you can redistribute it and/or modify       *
0008 * it under the terms of the GNU General Public License as published by *
0009 * the Free Software Foundation, either version 3 of the License, or    *
0010 * (at your option) any later version.                                  *
0011 *                                                                      *
0012 * EvtGen is distributed in the hope that it will be useful,            *
0013 * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
0014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
0015 * GNU General Public License for more details.                         *
0016 *                                                                      *
0017 * You should have received a copy of the GNU General Public License    *
0018 * along with EvtGen.  If not, see <https://www.gnu.org/licenses/>.     *
0019 ***********************************************************************/
0020
0021 #ifndef EVTID_HH
0022 #define EVTID_HH
0023
0024 #include <iostream>
0025 #include <string>
0026
0027 class EvtId {
0028   public:
0029     //need a default constructor
0030     EvtId() : _id( -1 ), _alias( -1 ) {}
0031
0032     EvtId( int id, int alias ) : _id( id ), _alias( alias ) {}
0033
0034     friend std::ostream& operator<<( std::ostream& s, const EvtId& v );
0035
0036     int operator==( const EvtId& id ) const { return _id == id._id; }
0037     int operator!=( const EvtId& id ) const { return _id != id._id; }
0038     int operator<( const EvtId& id ) const { return _id < id._id; }
0039
0040     int isConjugate( const EvtId& id ) const;
0041
0042     int getId() const { return _id; }
0043
0044     int getAlias() const { return _alias; }
0045
0046     int isAlias() const { return _id != _alias; }
0047
0048     std::string getName() const;
0049
0050   private:
0051     //particle number 0..n. The order of particles are determined
0052     //by the order in pdt.table
0053     int _id;
0054     //if the particle is an alias to another particle alias!=id
0055     //The only place where the alias should be used is for looking
0056     //up decays in the decay table.
0057     int _alias;
0058 };
0059
0060 #endif