Source Code for Module bmrblib.experimental_details.sample_conditions

  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.base_classes import BaseSaveframe, TagCategory, TagCategoryFree 
 32   
 33   
 34 -class SampleConditionsSaveframe(BaseSaveframe): 
 35      """The sample conditions saveframe class.""" 
 36   
 37      # Class variables. 
 38      sf_label = 'sample_conditions' 
 39   
 40 -    def add_tag_categories(self): 
 41          """Create the v3.1 tag categories.""" 
 42   
 43          # The tag category objects. 
 44          self.tag_categories.append(SampleConditionList(self)) 
 45          self.tag_categories.append(SampleConditionCitation(self)) 
 46          self.tag_categories.append(SampleConditionVariable(self)) 
 47   
 48   
 49 -class SampleConditionList(TagCategoryFree): 
 50      """Base class for the SampleConditionList tag category.""" 
 51   
 52 -    def __init__(self, sf): 
 53          """Setup the SampleConditionList tag category. 
 54   
 55          @param sf:  The saveframe object. 
 56          @type sf:   saveframe instance 
 57          """ 
 58   
 59          # Initialise the baseclass. 
 60          super(SampleConditionList, self).__init__(sf) 
 61   
 62          # Add the tag info. 
 63          self.add(key='SampleConditionListID',   var_name='count_str',   format='int') 
 64          self.add(key='Details',                 var_name='details',     format='str') 
 65   
 66   
 67   
 68 -class SampleConditionCitation(TagCategory): 
 69      """Base class for the 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, self).__init__(sf) 
 80   
 81          # Add the tag info. 
 82          self.add(key='CitationID',              var_name='data_ids',        format='int') 
 83          self.add(key='CitationLabel',           var_name='citation_label',  format='str') 
 84          self.add(key='SampleConditionListID',   var_name='count_str',       format='int') 
 85   
 86   
 87   
 88 -class SampleConditionVariable(TagCategory): 
 89      """Base class for the SampleConditionVariable tag category.""" 
 90   
 91 -    def __init__(self, sf): 
 92          """Setup the SampleConditionVariable tag category. 
 93   
 94          @param sf:  The saveframe object. 
 95          @type sf:   saveframe instance 
 96          """ 
 97   
 98          # Initialise the baseclass. 
 99          super(SampleConditionVariable, self).__init__(sf) 
100   
101          # Add the tag info. 
102          self.add(key='Type',                    var_name='type',            format='str') 
103          self.add(key='Val',                     var_name='value',           format='str') 
104          self.add(key='ValErr',                  var_name='error',           format='str') 
105          self.add(key='ValUnits',                var_name='units',           format='str') 
106          self.add(key='SampleConditionListID',   var_name='count_str',       format='int') 
107