Source Code for Module prompt.temperature

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2008-2010 Edward d'Auvergne                                   # 
 4  #                                                                             # 
 5  # This file is part of the program relax.                                     # 
 6  #                                                                             # 
 7  # relax 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 2 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # relax 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 relax; if not, write to the Free Software                        # 
19  # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA   # 
20  #                                                                             # 
21  ############################################################################### 
22   
23  # Module docstring. 
24  """Module containing the 'temperature' user function class.""" 
25  __docformat__ = 'plaintext' 
26   
27  # relax module imports. 
28  from base_class import Basic_class 
29  import arg_check 
30  from generic_fns import temperature 
31   
32   
33 -class Temp(Basic_class): 
34      """Class containing the function for setting the experimental temperature.""" 
35   
36 -    def set(self, id=None, temp=None): 
37          """Specify the temperature of an experiment. 
38   
39          Keyword arguments 
40          ~~~~~~~~~~~~~~~~~ 
41   
42          id:  The experiment identification string. 
43   
44          temp:  The temperature of the experiment. 
45   
46   
47          Description 
48          ~~~~~~~~~~~ 
49   
50          This function allows the temperature of an experiment to be set.  In certain analyses, for 
51          example those which use pseudocontact shift data, knowledge of the temperature is essential. 
52          """ 
53   
54          # Function intro text. 
55          if self._exec_info.intro: 
56              text = self._exec_info.ps3 + "temperature(" 
57              text = text + "id=" + repr(id) 
58              text = text + ", temp=" + repr(temp) + ")" 
59              print(text) 
60   
61          # The argument checks. 
62          arg_check.is_str(id, 'experiment identification string') 
63          arg_check.is_num(temp, 'experiment temparture') 
64   
65          # Execute the functional code. 
66          temperature.set(id=id, temp=temp) 
67