Source Code for Module prompt.frq

 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 'frq' user function class for manipulating spectrometer frequencies.""" 
25  __docformat__ = 'plaintext' 
26   
27  # relax module imports. 
28  from base_class import User_fn_class 
29  import arg_check 
30  import generic_fns.frq 
31   
32   
33 -class Frq(User_fn_class): 
34      """Class for manipulating spectrometer frequencies.""" 
35   
36 -    def set(self, id=None, frq=None): 
37          """Set the spectrometer frequency of the experiment. 
38   
39          Keyword arguments 
40          ~~~~~~~~~~~~~~~~~ 
41   
42          id:  The experiment identification string. 
43   
44          frq:  The spectrometer frequency in Hertz. 
45   
46   
47          Description 
48          ~~~~~~~~~~~ 
49   
50          This user function allows the spectrometer frequency of a given experiment to be set. 
51          """ 
52   
53          # Function intro text. 
54          if self._exec_info.intro: 
55              text = self._exec_info.ps3 + "frq(" 
56              text = text + "id=" + repr(id) 
57              text = text + ", frq=" + repr(frq) + ")" 
58              print(text) 
59   
60          # The argument checks. 
61          arg_check.is_str(id, 'experiment identification string') 
62          arg_check.is_num(frq, 'spectrometer frequency') 
63   
64          # Execute the functional code. 
65          generic_fns.frq.set(id=id, frq=frq) 
66