source: MML/trunk/machine/SOLEIL/doc_html/machine/Soleil/StorageRing/getrmn.html @ 4

Last change on this file since 4 was 4, checked in by zhangj, 10 years ago

Initial import--MML version from SOLEIL@2013
File size: 4.9 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2                "http://www.w3.org/TR/REC-html40/loose.dtd">
3<html>
4<head>
5  <title>Description of getrmn</title>
6  <meta name="keywords" content="getrmn">
7  <meta name="description" content="GETDCCT - returns the beam current">
8  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9  <meta name="generator" content="m2html &copy; 2003 Guillaume Flandin">
10  <meta name="robots" content="index, follow">
11  <link type="text/css" rel="stylesheet" href="../../../m2html.css">
12</head>
13<body>
14<a name="_top"></a>
15<div><a href="../../../index.html">Home</a> &gt;  <a href="#">machine</a> &gt; <a href="#">Soleil</a> &gt; <a href="index.html">StorageRing</a> &gt; getrmn.m</div>
16
17<!--<table width="100%"><tr><td align="left"><a href="../../../index.html"><img alt="<" border="0" src="../../../left.png">&nbsp;Master index</a></td>
18<td align="right"><a href="index.html">Index for machine/Soleil/StorageRing&nbsp;<img alt=">" border="0" src="../../../right.png"></a></td></tr></table>-->
19
20<h1>getrmn
21</h1>
22
23<h2><a name="_name"></a>PURPOSE <a href="#_top"><img alt="^" border="0" src="../../../up.png"></a></h2>
24<div class="box"><strong>GETDCCT - returns the beam current</strong></div>
25
26<h2><a name="_synopsis"></a>SYNOPSIS <a href="#_top"><img alt="^" border="0" src="../../../up.png"></a></h2>
27<div class="box"><strong>function [RMN, tout, DataTime, ErrorFlag] = getrmn(varargin) </strong></div>
28
29<h2><a name="_description"></a>DESCRIPTION <a href="#_top"><img alt="^" border="0" src="../../../up.png"></a></h2>
30<div class="fragment"><pre class="comment">GETDCCT - returns the beam current
31  [RMN, tout, DataTime, ErrorFlag] = getdcct(t, InputFlags)
32
33  OUTPUTS
34  1. RMN = storage ring electron beam current
35 
36  INPUTS
37  1. 'Struct' will return a data structure
38     'Numeric' will return numeric outputs {Defaul}
39  2. 'Physics'  - Use physics  units (optional override of units)
40     'Hardware' - Use hardware units (optional override of units)
41  3. 'Online' - Get data online (optional override of the mode)
42     'Model'  - Get data from the model (optional override of the mode)
43     'Manual' - Get data manually (optional override of the mode)
44
45  NOTE
46  1. This function is just an alias for getam('RMN', ...)</pre></div>
47
48<!-- crossreference -->
49<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../../../up.png"></a></h2>
50This function calls:
51<ul style="list-style-image:url(../../../matlabicon.gif)">
52</ul>
53This function is called by:
54<ul style="list-style-image:url(../../../matlabicon.gif)">
55<li><a href="measchronat.html" class="code" title="">measchronat</a>    function [xix xiz] = measchronat</li></ul>
56<!-- crossreference -->
57
58
59<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../../../up.png"></a></h2>
60<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function [RMN, tout, DataTime, ErrorFlag] = getrmn(varargin)</a>
610002 <span class="comment">%GETDCCT - returns the beam current</span>
620003 <span class="comment">%  [RMN, tout, DataTime, ErrorFlag] = getdcct(t, InputFlags)</span>
630004 <span class="comment">%</span>
640005 <span class="comment">%  OUTPUTS</span>
650006 <span class="comment">%  1. RMN = storage ring electron beam current</span>
660007 <span class="comment">%</span>
670008 <span class="comment">%  INPUTS</span>
680009 <span class="comment">%  1. 'Struct' will return a data structure</span>
690010 <span class="comment">%     'Numeric' will return numeric outputs {Defaul}</span>
700011 <span class="comment">%  2. 'Physics'  - Use physics  units (optional override of units)</span>
710012 <span class="comment">%     'Hardware' - Use hardware units (optional override of units)</span>
720013 <span class="comment">%  3. 'Online' - Get data online (optional override of the mode)</span>
730014 <span class="comment">%     'Model'  - Get data from the model (optional override of the mode)</span>
740015 <span class="comment">%     'Manual' - Get data manually (optional override of the mode)</span>
750016 <span class="comment">%</span>
760017 <span class="comment">%  NOTE</span>
770018 <span class="comment">%  1. This function is just an alias for getam('RMN', ...)</span>
780019
790020 <span class="comment">%</span>
800021 <span class="comment">%  Written by Laurent S. Nadolski</span>
810022
820023
830024 <span class="keyword">if</span> nargout &gt; 2
840025     [RMN, tout, DataTime, ErrorFlag] = getpv(<span class="string">'RMN'</span>, <span class="string">'Monitor'</span>, [], varargin{:});
850026 <span class="keyword">else</span>
860027     [RMN, tout] = getpv(<span class="string">'RMN'</span>, <span class="string">'Monitor'</span>, [], varargin{:});
870028 <span class="keyword">end</span>
880029</pre></div>
89<hr><address>Generated on Mon 21-May-2007 15:35:27 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
90</body>
91</html>
Note: See TracBrowser for help on using the repository browser.