Source Code for Module bmrblib.experimental_details.method_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 method saveframe category. 
 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/3.1html_frame/frame_SaveFramePage.html#method 
 28  """ 
 29   
 30  # relax module imports. 
 31  from bmrblib.experimental_details.method import MethodSaveframe, Method, MethodCitation, MethodFile, MethodParam 
 32   
 33   
 34 -class MethodSaveframe_v3_1(MethodSaveframe): 
 35      """The method saveframe class.""" 
 36   
 37      # Class variables. 
 38      sf_label = 'method' 
 39   
 40 -    def add_tag_categories(self): 
 41          """Create the tag categories.""" 
 42   
 43          # The tag category objects. 
 44          self.tag_categories.append(Method_v3_1(self)) 
 45          self.tag_categories.append(MethodCitation_v3_1(self)) 
 46          self.tag_categories.append(MethodFile_v3_1(self)) 
 47          self.tag_categories.append(MethodParam_v3_1(self)) 
 48   
 49   
 50   
 51 -class Method_v3_1(Method): 
 52      """Base class for the Method tag category.""" 
 53   
 54 -    def __init__(self, sf): 
 55          """Setup the Method tag category. 
 56   
 57          @param sf:  The saveframe object. 
 58          @type sf:   saveframe instance 
 59          """ 
 60   
 61          # Initialise the baseclass. 
 62          super(Method_v3_1, self).__init__(sf) 
 63   
 64          # The category name. 
 65          self.tag_category_label = 'Method' 
 66   
 67          # Change tag names. 
 68          self['SfCategory'].tag_name = 'Sf_category' 
 69          self['SfFramecode'].tag_name = 'Sf_framecode' 
 70   
 71          # Change the variable names. 
 72          self['SfFramecode'].var_name = 'name' 
 73   
 74   
 75   
 76 -class MethodCitation_v3_1(MethodCitation): 
 77      """Base class for the MethodCitation tag category.""" 
 78   
 79 -    def __init__(self, sf): 
 80          """Setup the MethodCitation tag category. 
 81   
 82          @param sf:  The saveframe object. 
 83          @type sf:   saveframe instance 
 84          """ 
 85   
 86          # Initialise the baseclass. 
 87          super(MethodCitation_v3_1, self).__init__(sf) 
 88   
 89          # The category name. 
 90          self.tag_category_label = 'Method_citation' 
 91   
 92   
 93   
 94 -class MethodFile_v3_1(MethodFile): 
 95      """Base class for the MethodFile tag category.""" 
 96   
 97 -    def __init__(self, sf): 
 98          """Setup the MethodFile tag category. 
 99   
100          @param sf:  The saveframe object. 
101          @type sf:   saveframe instance 
102          """ 
103   
104          # Initialise the baseclass. 
105          super(MethodFile_v3_1, self).__init__(sf) 
106   
107          # The category name. 
108          self.tag_category_label = 'Method_file' 
109   
110   
111   
112 -class MethodParam_v3_1(MethodParam): 
113      """Base class for the MethodParam tag category.""" 
114   
115 -    def __init__(self, sf): 
116          """Setup the MethodParam tag category. 
117   
118          @param sf:  The saveframe object. 
119          @type sf:   saveframe instance 
120          """ 
121   
122          # Initialise the baseclass. 
123          super(MethodParam_v3_1, self).__init__(sf) 
124   
125          # The category name. 
126          self.tag_category_label = 'Method_param' 
127