Source Code for Module bmrblib.experimental_details.sample_conditions_v2_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://gna.org/projects/bmrblib>}. 
26   
27  For example, see http://www.bmrb.wisc.edu/dictionary/htmldocs/nmr_star/dictionary_files/complete_form_v21.txt 
28  """ 
29   
30  # relax module imports. 
31  from bmrblib.experimental_details.sample_conditions import SampleConditionsSaveframe, SampleConditionList, SampleConditionCitation, SampleConditionVariable 
32   
33   
34 -class SampleConditionsSaveframe_v2_1(SampleConditionsSaveframe): 
35      """The v2.1 sample conditions saveframe class.""" 
36   
37 -    def add_tag_categories(self): 
38          """Create the v2.1 tag categories.""" 
39   
40          # The tag category objects. 
41          self.tag_categories.append(SampleConditionList_v2_1(self)) 
42          self.tag_categories.append(SampleConditionVariable_v2_1(self)) 
43   
44   
45   
46 -class SampleConditionList_v2_1(SampleConditionList): 
47      """The v2.1 SampleConditionList tag category.""" 
48   
49 -    def __init__(self, sf): 
50          """Setup the SampleConditionList tag category. 
51   
52          @param sf:  The saveframe object. 
53          @type sf:   saveframe instance 
54          """ 
55   
56          # Initialise the baseclass. 
57          super(SampleConditionList_v2_1, self).__init__(sf) 
58   
59          # Change tag names. 
60          self['SfCategory'].tag_name = 'Saveframe_category' 
61   
62   
63   
64 -class SampleConditionVariable_v2_1(SampleConditionVariable): 
65      """The v2.1 SampleConditionVariable tag category.""" 
66   
67 -    def __init__(self, sf): 
68          """Setup the SampleConditionVariable tag category. 
69   
70          @param sf:  The saveframe object. 
71          @type sf:   saveframe instance 
72          """ 
73   
74          # Initialise the baseclass. 
75          super(SampleConditionVariable_v2_1, self).__init__(sf) 
76   
77          # Change tag names. 
78          self['Type'].tag_name =     'Variable_type' 
79          self['Val'].tag_name =      'Variable_value' 
80          self['ValErr'].tag_name =   'Variable_value_error' 
81          self['ValUnits'].tag_name = 'Variable_value_units' 
82