Source Code for Module bmrblib.experimental_details.sample_conditions_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.sample_conditions import SampleConditionsSaveframe, SampleConditionList, SampleConditionCitation, SampleConditionVariable 
 32   
 33   
 34 -class SampleConditionsSaveframe_v3_1(SampleConditionsSaveframe): 
 35      """The v3.1 sample conditions 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(SampleConditionList_v3_1(self)) 
 42          self.tag_categories.append(SampleConditionCitation_v3_1(self)) 
 43          self.tag_categories.append(SampleConditionVariable_v3_1(self)) 
 44   
 45   
 46 -class SampleConditionList_v3_1(SampleConditionList): 
 47      """The v3.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_v3_1, self).__init__(sf) 
 58   
 59          # The category name. 
 60          self.tag_category_label = 'Sample_condition_list' 
 61   
 62          # Change tag names. 
 63          self['SfCategory'].tag_name =               'Sf_category' 
 64          self['SfFramecode'].tag_name =              'Sf_framecode' 
 65          self['SampleConditionListID'].tag_name =    'ID' 
 66          self['Details'].tag_name =                  'Details' 
 67   
 68   
 69   
 70 -class SampleConditionCitation_v3_1(SampleConditionCitation): 
 71      """The v3.1 SampleConditionCitation tag category.""" 
 72   
 73 -    def __init__(self, sf): 
 74          """Setup the SampleConditionCitation tag category. 
 75   
 76          @param sf:  The saveframe object. 
 77          @type sf:   saveframe instance 
 78          """ 
 79   
 80          # Initialise the baseclass. 
 81          super(SampleConditionCitation_v3_1, self).__init__(sf) 
 82   
 83          # The category name. 
 84          self.tag_category_label = 'Sample_condition_list' 
 85   
 86          # Change tag names. 
 87          self['CitationID'].tag_name =               'Citation_ID' 
 88          self['CitationLabel'].tag_name =            'Citation_label' 
 89          self['SampleConditionListID'].tag_name =    'Sample_condition_list_ID' 
 90   
 91   
 92   
 93 -class SampleConditionVariable_v3_1(SampleConditionVariable): 
 94      """The v3.1 SampleConditionVariable tag category.""" 
 95   
 96 -    def __init__(self, sf): 
 97          """Setup the SampleConditionVariable tag category. 
 98   
 99          @param sf:  The saveframe object. 
100          @type sf:   saveframe instance 
101          """ 
102   
103          # Initialise the baseclass. 
104          super(SampleConditionVariable_v3_1, self).__init__(sf) 
105   
106          # The category name. 
107          self.tag_category_label = 'Sample_condition_variable' 
108   
109          # Change tag names. 
110          self['Type'].tag_name =                     'Type' 
111          self['Val'].tag_name =                      'Val' 
112          self['ValErr'].tag_name =                   'Val_err' 
113          self['ValUnits'].tag_name =                 'Val_units' 
114          self['SampleConditionListID'].tag_name =    'Sample_condition_list_ID' 
115