Source Code for Module bmrblib.experimental_details.sample_conditions_v3_1

  1  ############################################################################# 
  2  #                                                                           # 
  3  # The BMRB library.                                                         # 
  4  #                                                                           # 
  5  # Copyright (C) 2009-2011 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  For example, see http://www.bmrb.wisc.edu/dictionary/3.1html_frame/frame_SaveFramePage.html#order_parameters 
 26  """ 
 27   
 28  # relax module imports. 
 29  from bmrblib.experimental_details.sample_conditions import SampleConditionsSaveframe, SampleConditionList, SampleConditionCitation, SampleConditionVariable 
 30   
 31   
 32 -class SampleConditionsSaveframe_v3_1(SampleConditionsSaveframe): 
 33      """The v3.1 sample conditions saveframe class.""" 
 34   
 35 -    def add_tag_categories(self): 
 36          """Create the v3.1 tag categories.""" 
 37   
 38          # The tag category objects. 
 39          self.tag_categories.append(SampleConditionList_v3_1(self)) 
 40          self.tag_categories.append(SampleConditionCitation_v3_1(self)) 
 41          self.tag_categories.append(SampleConditionVariable_v3_1(self)) 
 42   
 43   
 44 -class SampleConditionList_v3_1(SampleConditionList): 
 45      """The v3.1 SampleConditionList tag category.""" 
 46   
 47 -    def __init__(self, sf): 
 48          """Setup the SampleConditionList tag category. 
 49   
 50          @param sf:  The saveframe object. 
 51          @type sf:   saveframe instance 
 52          """ 
 53   
 54          # Initialise the baseclass. 
 55          super(SampleConditionList_v3_1, self).__init__(sf) 
 56   
 57          # The category name. 
 58          self.tag_category_label = 'Sample_condition_list' 
 59   
 60          # Change tag names. 
 61          self['SfCategory'].tag_name =               'Sf_category' 
 62          self['SfFramecode'].tag_name =              'Sf_framecode' 
 63          self['SampleConditionListID'].tag_name =    'ID' 
 64          self['Details'].tag_name =                  'Details' 
 65   
 66   
 67   
 68 -class SampleConditionCitation_v3_1(SampleConditionCitation): 
 69      """The v3.1 SampleConditionCitation tag category.""" 
 70   
 71 -    def __init__(self, sf): 
 72          """Setup the SampleConditionCitation tag category. 
 73   
 74          @param sf:  The saveframe object. 
 75          @type sf:   saveframe instance 
 76          """ 
 77   
 78          # Initialise the baseclass. 
 79          super(SampleConditionCitation_v3_1, self).__init__(sf) 
 80   
 81          # The category name. 
 82          self.tag_category_label = 'Sample_condition_list' 
 83   
 84          # Change tag names. 
 85          self['CitationID'].tag_name =               'Citation_ID' 
 86          self['CitationLabel'].tag_name =            'Citation_label' 
 87          self['SampleConditionListID'].tag_name =    'Sample_condition_list_ID' 
 88   
 89   
 90   
 91 -class SampleConditionVariable_v3_1(SampleConditionVariable): 
 92      """The v3.1 SampleConditionVariable tag category.""" 
 93   
 94 -    def __init__(self, sf): 
 95          """Setup the SampleConditionVariable tag category. 
 96   
 97          @param sf:  The saveframe object. 
 98          @type sf:   saveframe instance 
 99          """ 
100   
101          # Initialise the baseclass. 
102          super(SampleConditionVariable_v3_1, self).__init__(sf) 
103   
104          # The category name. 
105          self.tag_category_label = 'Sample_condition_variable' 
106   
107          # Change tag names. 
108          self['Type'].tag_name =                     'Type' 
109          self['Val'].tag_name =                      'Val' 
110          self['ValErr'].tag_name =                   'Val_err' 
111          self['ValUnits'].tag_name =                 'Val_units' 
112          self['SampleConditionListID'].tag_name =    'Sample_condition_list_ID' 
113