Source Code for Module bmrblib.experimental_details.experiment_v3_1

 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 model_free saveframe category (used to be called order_parameters). 
24   
25  This file is part of the U{BMRB library<https://sourceforge.net/projects/bmrblib>}. 
26   
27  For example, see http://www.bmrb.wisc.edu/dictionary/3.1html_frame/frame_SaveFramePage.html#order_parameters 
28  """ 
29   
30  # relax module imports. 
31  from bmrblib.experimental_details.experiment import ExperimentSaveframe, ExperimentList, Experiment 
32   
33   
34 -class ExperimentSaveframe_v3_1(ExperimentSaveframe): 
35      """The v3.1 experiment saveframe class.""" 
36   
37 -    def add_tag_categories(self): 
38          """Create the v3.1 tag categories.""" 
39   
40          # The tag category objects. 
41          self.tag_categories.append(ExperimentList_v3_1(self)) 
42          self.tag_categories.append(Experiment_v3_1(self)) 
43   
44   
45 -class ExperimentList_v3_1(ExperimentList): 
46      """The v3.1 ExperimentList tag category.""" 
47   
48 -    def __init__(self, sf): 
49          """Setup the ExperimentList tag category. 
50   
51          @param sf:  The saveframe object. 
52          @type sf:   saveframe instance 
53          """ 
54   
55          # Initialise the baseclass. 
56          super(ExperimentList_v3_1, self).__init__(sf) 
57   
58          # The category name. 
59          self.tag_category_label = 'Experiment_list' 
60   
61          # Change tag names. 
62          self['SfCategory'].tag_name = 'Sf_category' 
63          self['SfFramecode'].tag_name = 'Sf_framecode' 
64   
65   
66   
67 -class Experiment_v3_1(Experiment): 
68      """The v3.1 Experiment tag category.""" 
69   
70 -    def __init__(self, sf): 
71          """Setup the Experiment tag category. 
72   
73          @param sf:  The saveframe object. 
74          @type sf:   saveframe instance 
75          """ 
76   
77          # Initialise the baseclass. 
78          super(Experiment_v3_1, self).__init__(sf) 
79   
80          # The category name. 
81          self.tag_category_label = 'Experiment' 
82