Source Code for Module bmrblib.nmr_star_dict

 1  ############################################################################# 
 2  #                                                                           # 
 3  # The BMRB library.                                                         # 
 4  #                                                                           # 
 5  # Copyright (C) 2009-2013 Edward d'Auvergne                                 # 
 6  #                                                                           # 
 7  # This program is free software: you can redistribute it and/or modify      # 
 8  # it under the terms of the GNU General Public License as published by      # 
 9  # the Free Software Foundation, either version 3 of the License, or         # 
10  # (at your option) any later version.                                       # 
11  #                                                                           # 
12  # This program is distributed in the hope that it will be useful,           # 
13  # but WITHOUT ANY WARRANTY; without even the implied warranty of            # 
14  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             # 
15  # GNU General Public License for more details.                              # 
16  #                                                                           # 
17  # You should have received a copy of the GNU General Public License         # 
18  # along with this program.  If not, see <http://www.gnu.org/licenses/>.     # 
19  #                                                                           # 
20  ############################################################################# 
21   
22  # Module docstring. 
23  """The base classes for the NMR-STAR dictionary support within relax. 
24   
25  This file is part of the U{BMRB library<https://gna.org/projects/bmrblib>}. 
26  """ 
27   
28  # relax module imports. 
29  from bmrblib.pystarlib.File import File 
30   
31   
32 -class NMR_STAR: 
33      """The base object for the NMR-STAR dictionary.""" 
34   
35      # Class extension string. 
36      ext = '' 
37   
38   
39 -    def __init__(self, title, file_path): 
40          """Initialise the NMR-STAR dictionary object. 
41   
42          @param title:       The title of the NMR-STAR data. 
43          @type title:        str 
44          @param file_path:   The full file path. 
45          @type file_path:    str 
46          """ 
47   
48          # Initialise the pystarlib File object. 
49          self.data = File(title=title, filename=file_path) 
50   
51          # Create the class objects. 
52          self.create_saveframes() 
53   
54   
55 -    def read(self): 
56          """Read the data from a BMRB NMR-STAR formatted file.""" 
57   
58          # Read the contents of the STAR formatted file. 
59          self.data.read() 
60   
61   
62 -    def write(self): 
63          """Write the data to a BMRB NMR-STAR formatted file.""" 
64   
65          # Write the contents to the STAR formatted file. 
66          self.data.write() 
67