src/jalview/structure/AtomSpec.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.structure;
  22
  23 /**
  24  * Java bean representing an atom in a PDB (or similar) structure model or
  25  * viewer
  26  *
  27  * @author gmcarstairs
  28  *
  29  */
  30 public class AtomSpec
  31 {
  32   private String pdbFile;
  33
  34   private String chain;
  35
  36   private int pdbResNum;
  37
  38   private int atomIndex;
  39
  40   /**
  41    * Constructor
  42    *
  43    * @param pdbFile
  44    * @param chain
  45    * @param resNo
  46    * @param atomNo
  47    */
  48   public AtomSpec(String pdbFile, String chain, int resNo, int atomNo)
  49   {
  50     this.pdbFile = pdbFile;
  51     this.chain = chain;
  52     this.pdbResNum = resNo;
  53     this.atomIndex = atomNo;
  54   }
  55
  56   public String getPdbFile()
  57   {
  58     return pdbFile;
  59   }
  60
  61   public String getChain()
  62   {
  63     return chain;
  64   }
  65
  66   public int getPdbResNum()
  67   {
  68     return pdbResNum;
  69   }
  70
  71   public int getAtomIndex()
  72   {
  73     return atomIndex;
  74   }
  75
  76   @Override
  77   public String toString()
  78   {
  79     return "pdbFile: " + pdbFile + ", chain: " + chain + ", res: "
  80             + pdbResNum + ", atom: " + atomIndex;
  81   }
  82 }