source: MML/trunk/mml/doc_html/mml/getlist.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: 6.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 getlist</title>
6  <meta name="keywords" content="getlist">
7  <meta name="description" content="GETLIST - Returns Device List for a Family">
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">mml</a> &gt; getlist.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 mml&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->
19
20<h1>getlist
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>GETLIST - Returns Device List for a Family</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 DeviceList = getlist(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">GETLIST - Returns Device List for a Family
31  getlist(FamilyName)
32 
33  INPUTS
34  1. FamilyNames
35
36  OUTPUTS
37  1. Device list for families specified in input
38  2. StatusFlag = 0 return all devices
39                 1 return only devices with good status {Default}
40
41  EXAMPLES
42  1. getlist('BPMx')
43  2. getlist('HCOR',0)
44
45  See also <a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a></pre></div>
46
47<!-- crossreference -->
48<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
49This function calls:
50<ul style="list-style-image:url(../matlabicon.gif)">
51<li><a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a>   FAMILY2DEV - Return the device list for a family</li></ul>
52This function is called by:
53<ul style="list-style-image:url(../matlabicon.gif)">
54<li><a href="dev2common.html" class="code" title="function [Output, Err] = dev2common(Family, DeviceList)">dev2common</a>       DEV2COMMON - Converts Device lists to common names</li><li><a href="dev2elem.html" class="code" title="function Output = dev2elem(Family, DevList)">dev2elem</a>        DEV2ELEM - Converts an element list to a device list</li><li><a href="elem2dev.html" class="code" title="function Output = elem2dev(Family, ElementList)">elem2dev</a>  ELEM2DEV - Converts a device list to an element list</li><li><a href="getphysdata.html" class="code" title="function [Data, iNotFound] = getphysdata(Family, Field, DeviceList)">getphysdata</a>        GETPHYSDATA - Gets physics data</li><li><a href="meascmhysteresis.html" class="code" title="function meascmhysteresis(BPMList, CMFamily, CMList, MaxChange, NSteps)">meascmhysteresis</a>       MEASCMHYSTERESIS - Measure corrector magnet hysteresis</li><li><a href="monrate.html" class="code" title="function [AvgRate, N] = monrate(family, DeviceList, T);">monrate</a>  MONRATE - Calculates the control system data rate of a noisy channel</li><li><a href="monrates.html" class="code" title="function monrates">monrates</a>        MONRATES - Tests the analog monitor data rate for BPMs and corrector magnets</li><li><a href="quadcenter.html" class="code" title="function [QMS1, QMS2] = quadcenter(QuadFamily, QuadDev, XYPlane, FigureHandle)">quadcenter</a>       QUADCENTER - Measure the magnet center of a quadrupole magnet</li><li><a href="rmdisp.html" class="code" title="function [DeltaRF, BPM, c, DispOrbit] = rmdisp(varargin)">rmdisp</a>    RMDISP - Removes the portion of the orbit that correlates with the dispersion</li><li><a href="setfamilydata.html" class="code" title="function setfamilydata(Data, Family, Field1, Field2, DeviceList)">setfamilydata</a>      SETFAMILYDATA - Sets data associated with accelerator control</li><li><a href="setphysdata.html" class="code" title="function setphysdata(varargin)">setphysdata</a>    SETPHYSDATA - Set physics data</li><li><a href="sext2bpm.html" class="code" title="function [BPMFamilyOutput, BPMDevOutput, DeltaSpos] = sext2bpm(SEXTFamily, SEXTDev)">sext2bpm</a>    SEXT2BPM - Returns the nearest BPM to the specified sextupole</li></ul>
55<!-- crossreference -->
56
57
58<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
59<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function DeviceList = getlist(varargin)  </a>
600002 <span class="comment">%GETLIST - Returns Device List for a Family</span>
610003 <span class="comment">%  getlist(FamilyName)</span>
620004 <span class="comment">%</span>
630005 <span class="comment">%  INPUTS</span>
640006 <span class="comment">%  1. FamilyNames</span>
650007 <span class="comment">%</span>
660008 <span class="comment">%  OUTPUTS</span>
670009 <span class="comment">%  1. Device list for families specified in input</span>
680010 <span class="comment">%  2. StatusFlag = 0 return all devices</span>
690011 <span class="comment">%                 1 return only devices with good status {Default}</span>
700012 <span class="comment">%</span>
710013 <span class="comment">%  EXAMPLES</span>
720014 <span class="comment">%  1. getlist('BPMx')</span>
730015 <span class="comment">%  2. getlist('HCOR',0)</span>
740016 <span class="comment">%</span>
750017 <span class="comment">%  See also family2dev</span>
760018
770019 <span class="comment">%</span>
780020 <span class="comment">%  Written by Gregory J. Portmann</span>
790021
800022 <span class="keyword">if</span> nargin == 0
810023    error(<span class="string">'Must have at least one input (''Family'')!'</span>);
820024 <span class="keyword">end</span>
830025
840026 DeviceList = <a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a>(varargin{:});</pre></div>
85<hr><address>Generated on Mon 21-May-2007 15:29:18 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
86</body>
87</html>
Note: See TracBrowser for help on using the repository browser.