src/jalview/structure/AtomSpec.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
   3  * Copyright (C) 2015 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   // TODO clarify do we want pdbFile here, or pdbId?
  33   // compare highlightAtom in 2.8.2 for JalviewJmolBinding and
  34   // javascript.MouseOverStructureListener
  35   private String pdbFile;
  36
  37   private String chain;
  38
  39   private int pdbResNum;
  40
  41   private int atomIndex;
  42
  43   /**
  44    * Constructor
  45    *
  46    * @param pdbFile
  47    * @param chain
  48    * @param resNo
  49    * @param atomNo
  50    */
  51   public AtomSpec(String pdbFile, String chain, int resNo, int atomNo)
  52   {
  53     this.pdbFile = pdbFile;
  54     this.chain = chain;
  55     this.pdbResNum = resNo;
  56     this.atomIndex = atomNo;
  57   }
  58
  59   public String getPdbFile()
  60   {
  61     return pdbFile;
  62   }
  63
  64   public String getChain()
  65   {
  66     return chain;
  67   }
  68
  69   public int getPdbResNum()
  70   {
  71     return pdbResNum;
  72   }
  73
  74   public int getAtomIndex()
  75   {
  76     return atomIndex;
  77   }
  78
  79   @Override
  80   public String toString()
  81   {
  82     return "pdbFile: " + pdbFile + ", chain: " + chain + ", res: "
  83             + pdbResNum + ", atom: " + atomIndex;
  84   }
  85 }