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 monitor</title> |
---|
6 | <meta name="keywords" content="monitor"> |
---|
7 | <meta name="description" content="monitor('FAMILYNAME','METHOD')"> |
---|
8 | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
---|
9 | <meta name="generator" content="m2html © 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> > <a href="../../index.html">at</a> > <a href="#">simulator</a> > <a href="index.html">element</a> > monitor.m</div> |
---|
16 | |
---|
17 | <!--<table width="100%"><tr><td align="left"><a href="../../../index.html"><img alt="<" border="0" src="../../../left.png"> Master index</a></td> |
---|
18 | <td align="right"><a href="index.html">Index for at/simulator/element <img alt=">" border="0" src="../../../right.png"></a></td></tr></table>--> |
---|
19 | |
---|
20 | <h1>monitor |
---|
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>monitor('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 = monitor(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"> monitor('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 = monitor('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> |
---|
43 | This function calls: |
---|
44 | <ul style="list-style-image:url(../../../matlabicon.gif)"> |
---|
45 | </ul> |
---|
46 | This 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 = monitor(fname,method)</a> |
---|
54 | 0002 <span class="comment">% monitor('FAMILYNAME','METHOD')</span> |
---|
55 | 0003 <span class="comment">% creates a new family in the FAMLIST - a structure with fields</span> |
---|
56 | 0004 <span class="comment">% FamName family name</span> |
---|
57 | 0005 <span class="comment">% Length = 0 for bpm type</span> |
---|
58 | 0006 <span class="comment">% PassMethod name of the function on disk to use fortracking</span> |
---|
59 | 0007 <span class="comment">% use 'IdentityPass' for bpms that have no action</span> |
---|
60 | 0008 <span class="comment">%</span> |
---|
61 | 0009 <span class="comment">% returns assigned address in the FAMLIST that is uniquely identifies</span> |
---|
62 | 0010 <span class="comment">% the family</span> |
---|
63 | 0011 <span class="comment">% declare bpms in the lattice file as BPM = monitor('BPM','IdentityPass');</span> |
---|
64 | 0012 |
---|
65 | 0013 |
---|
66 | 0014 ElemData.FamName = fname; <span class="comment">% add check for identical family names</span> |
---|
67 | 0015 ElemData.Name=<span class="string">'BPM'</span>; |
---|
68 | 0016 ElemData.Length=0; |
---|
69 | 0017 ElemData.PassMethod=method; |
---|
70 | 0018 |
---|
71 | 0019 <span class="keyword">global</span> FAMLIST |
---|
72 | 0020 z = length(FAMLIST)+1; <span class="comment">% number of declare families including this one</span> |
---|
73 | 0021 FAMLIST{z}.FamName = fname; |
---|
74 | 0022 FAMLIST{z}.NumKids = 0; |
---|
75 | 0023 FAMLIST{z}.KidsList= []; |
---|
76 | 0024 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> © 2003</address> |
---|
78 | </body> |
---|
79 | </html> |
---|