source: MML/trunk/at/doc_html/at/simulator/element/hmonitor.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.3 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 hmonitor</title>
6  <meta name="keywords" content="hmonitor">
7  <meta name="description" content="hmonitor('FAMILYNAME','METHOD')">
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="../../index.html">at</a> &gt; <a href="#">simulator</a> &gt; <a href="index.html">element</a> &gt; hmonitor.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 at/simulator/element&nbsp;<img alt=">" border="0" src="../../../right.png"></a></td></tr></table>-->
19
20<h1>hmonitor
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>hmonitor('FAMILYNAME','METHOD')</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 z = hmonitor(fname,method) </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"> hmonitor('FAMILYNAME','METHOD')
31       creates a new family in the FAMLIST - a structure with fields
32               FamName                 family name
33               Length                  = 0 for  bpm type
34               PassMethod              name of the function on disk to use fortracking
35                                                       use 'IdentityPass' for bpms that have no action
36
37 returns assigned address in the FAMLIST that is uniquely identifies
38 the family
39 declare bpms in the lattice file  as BPM = hmonitor('BPM','IdentityPass');</pre></div>
40
41<!-- crossreference -->
42<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../../../up.png"></a></h2>
43This function calls:
44<ul style="list-style-image:url(../../../matlabicon.gif)">
45</ul>
46This function is called by:
47<ul style="list-style-image:url(../../../matlabicon.gif)">
48</ul>
49<!-- crossreference -->
50
51
52<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../../../up.png"></a></h2>
53<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function z = hmonitor(fname,method)</a>
540002 <span class="comment">% hmonitor('FAMILYNAME','METHOD')</span>
550003 <span class="comment">%       creates a new family in the FAMLIST - a structure with fields</span>
560004 <span class="comment">%               FamName                 family name</span>
570005 <span class="comment">%               Length                  = 0 for  bpm type</span>
580006 <span class="comment">%               PassMethod              name of the function on disk to use fortracking</span>
590007 <span class="comment">%                                                       use 'IdentityPass' for bpms that have no action</span>
600008 <span class="comment">%</span>
610009 <span class="comment">% returns assigned address in the FAMLIST that is uniquely identifies</span>
620010 <span class="comment">% the family</span>
630011 <span class="comment">% declare bpms in the lattice file  as BPM = hmonitor('BPM','IdentityPass');</span>
640012
650013
660014 ElemData.FamName = fname;  <span class="comment">% add check for identical family names</span>
670015 ElemData.Name=<span class="string">'HBPM'</span>;
680016 ElemData.Length=0;
690017 ElemData.PassMethod=method;
700018
710019 <span class="keyword">global</span> FAMLIST
720020 z = length(FAMLIST)+1; <span class="comment">% number of declare families including this one</span>
730021 FAMLIST{z}.FamName = fname;
740022 FAMLIST{z}.NumKids = 0;
750023 FAMLIST{z}.KidsList= [];
760024 FAMLIST{z}.ElemData= ElemData;</pre></div>
77<hr><address>Generated on Mon 21-May-2007 15:26:45 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
78</body>
79</html>
Note: See TracBrowser for help on using the repository browser.