JAL-2962 code tidying/documentation (non-functional) changes
[jalview.git] / src / jalview / datamodel / SequencePoint.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.datamodel;
22
23 /**
24  * A bean that models a point with (x, y, z) coordinates and a reference to a
25  * sequence
26  */
27 public class SequencePoint
28 {
29   /*
30    * Associated alignment sequence, or dummy sequence object
31    */
32   private final SequenceI sequence;
33
34   /*
35    * array of coordinates in embedded sequence space
36    */
37   public float[] coord;
38
39   /**
40    * Constructor
41    * 
42    * @param sequence
43    * @param coord
44    */
45   public SequencePoint(SequenceI sequence, float[] coord)
46   {
47     this.sequence = sequence;
48     this.coord = coord;
49   }
50
51   public SequenceI getSequence()
52   {
53     return sequence;
54   }
55 }