← Back to branch summary

~ubuntu-branches/ubuntu/maverick/cdk/maverick

« back to all changes in this revision

Viewing changes to src/org/openscience/cdk/interfaces/IPDBAtom.java

  • Committer: Bazaar Package Importer
  • Author(s): Paul Cager
  • Date: 2008-04-09 21:17:53 UTC
  • Revision ID: james.westby@ubuntu.com-20080409211753-46lmjw5z8mx5pd8d
Tags: upstream-1.0.2
Import upstream version 1.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/org/openscience/cdk/interfaces/IPDBAtom.java
 
1
/* $RCSfile$
 
2
 * $Author: egonw $
 
3
 * $Date: 2006-08-14 21:51:36 +0200 (Mon, 14 Aug 2006) $
 
4
 * $Revision: 6785 $
 
5
 *
 
6
 *  Copyright (C) 2006-2007  Miguel Rojas <miguel.rojas@uni-koeln.de>
 
7
 *
 
8
 * Contact: cdk-devel@lists.sourceforge.net
 
9
 *
 
10
 * This program is free software; you can redistribute it and/or
 
11
 * modify it under the terms of the GNU Lesser General Public License
 
12
 * as published by the Free Software Foundation; either version 2.1
 
13
 * of the License, or (at your option) any later version.
 
14
 *
 
15
 * This program is distributed in the hope that it will be useful,
 
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
18
 * GNU Lesser General Public License for more details.
 
19
 *
 
20
 * You should have received a copy of the GNU Lesser General Public License
 
21
 * along with this program; if not, write to the Free Software
 
22
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 
23
 */
 
24
package org.openscience.cdk.interfaces;
 
25
 
 
26
/**
 
27
 * A PDBAtom is a subclass of a Atom which is supposed to store
 
28
 * additional informations about the Atom
 
29
 *
 
30
 * @cdk.module  interfaces
 
31
 *
 
32
 * @author      Miguel Rojas <miguel.rojas@uni-koeln.de>
 
33
 * @cdk.created 2006-11-20 
 
34
 *
 
35
 * @cdk.keyword pdbpolymer
 
36
 */
 
37
public interface IPDBAtom extends IAtom {
 
38
    /**
 
39
     * get one entire line from the PDB entry file which describe the IPDBAtom. 
 
40
     * It consists of 80 columns. 
 
41
     * 
 
42
     * @return a String with all information
 
43
     */
 
44
        public String getRecord();
 
45
    
 
46
        /**
 
47
     * set one entire line from the PDB entry file which describe the IPDBAtom. 
 
48
     * It consists of 80 columns. 
 
49
         * 
 
50
         * @param newRecord A String with all information
 
51
         */
 
52
    public void setRecord(String newRecord);
 
53
    /**
 
54
     * get the Temperature factor of this atom.
 
55
     * 
 
56
     * @return the Temperature factor of this atom
 
57
     */
 
58
    public double getTempFactor();
 
59
    /**
 
60
     * set the Temperature factor of this atom.
 
61
     * 
 
62
     * @param newTempFactor  the Temperature factor of this atom
 
63
     */
 
64
    public void setTempFactor(double newTempFactor);
 
65
    /**
 
66
     * get the Residue name of this atom.
 
67
     * 
 
68
     * @return the Residue name of this atom
 
69
     */
 
70
    public String getResName();
 
71
    /**
 
72
     * set the Residue name of this atom.
 
73
     * 
 
74
     * @param newResName  the Residue name of this atom
 
75
     */
 
76
    public void setResName(String newResName);
 
77
    
 
78
    /**
 
79
     * get Code for insertion of residues of this atom.
 
80
     * 
 
81
     * @return the Code for insertion of residues of this atom
 
82
     */
 
83
    public String getICode();
 
84
    
 
85
    /**
 
86
     * set the Code for insertion of residues of this atom.
 
87
     * 
 
88
     * @param newICode  the Code for insertion of residues of this atom
 
89
     */
 
90
    public void setICode(String newICode);
 
91
    
 
92
    /**
 
93
     * get the Atom name of this atom.
 
94
     * 
 
95
     * @return the Atom name of this atom
 
96
     */
 
97
    public String getName();
 
98
    /**
 
99
     * set the Atom name of this atom.
 
100
     * 
 
101
     * @param newName  the Atom name of this atom
 
102
     */
 
103
    public void setName(String newName);
 
104
    
 
105
    /**
 
106
     * get the Chain identifier of this atom.
 
107
     * 
 
108
     * @return the Chain identifier of this atom
 
109
     */
 
110
    public String getChainID();
 
111
    /**
 
112
     * set the Chain identifier of this atom.
 
113
     * 
 
114
     * @param newChainID  the Chain identifier of this atom
 
115
     */
 
116
    public void setChainID(String newChainID);
 
117
    
 
118
    /**
 
119
     * get the Alternate location indicator of this atom.
 
120
     * 
 
121
     * @return the Alternate location indicator of this atom
 
122
     */
 
123
    public String getAltLoc();
 
124
    /**
 
125
     * set the Alternate location indicator of this atom.
 
126
     * 
 
127
     * @param newAltLoc  the Alternate location indicator of this atom
 
128
     */
 
129
    public void setAltLoc(String newAltLoc);
 
130
    
 
131
    /**
 
132
     * get the Segment identifier, left-justified of this atom.
 
133
     * 
 
134
     * @return the Segment identifier, left-justified of this atom
 
135
     */
 
136
    public String getSegID();
 
137
    /**
 
138
     * set the Segment identifier, left-justified of this atom.
 
139
     * 
 
140
     * @param newSegID  the Segment identifier, left-justified of this atom
 
141
     */
 
142
    public void setSegID(String newSegID);
 
143
    
 
144
    /**
 
145
     * get the Atom serial number of this atom.
 
146
     * 
 
147
     * @return the Atom serial number of this atom
 
148
     */
 
149
    public int getSerial();
 
150
    /**
 
151
     * set the Atom serial number of this atom.
 
152
     * 
 
153
     * @param newSerial  the Atom serial number of this atom
 
154
     */
 
155
    public void setSerial(int newSerial);
 
156
    
 
157
    /**
 
158
     * get the Residue sequence number of this atom.
 
159
     * 
 
160
     * @return the Residue sequence number of this atom
 
161
     */
 
162
    public String getResSeq();
 
163
    /**
 
164
     * set the Residue sequence number of this atom.
 
165
     * 
 
166
     * @param newResSeq  the Residue sequence number of this atom
 
167
     */
 
168
    public void setResSeq(String newResSeq);
 
169
    
 
170
    
 
171
    public boolean getOxt();
 
172
    public void setOxt(boolean newOxt);
 
173
    
 
174
 
 
175
    public boolean getHetAtom();
 
176
    public void setHetAtom(boolean newHetAtom);
 
177
    
 
178
    /**
 
179
     * get the Occupancy of this atom.
 
180
     * 
 
181
     * @return the Occupancy of this atom
 
182
     */
 
183
    public double getOccupancy();
 
184
    /**
 
185
     * set the Occupancy of this atom.
 
186
     * 
 
187
     * @param newOccupancy  the Occupancy of this atom
 
188
     */
 
189
    public void setOccupancy(double newOccupancy);
 
190
    
 
191
        
 
192
}
 
193
 
 
194
 
 
195
 
 
196
 
 
197