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 family2devcell</title> |
---|
6 | <meta name="keywords" content="family2devcell"> |
---|
7 | <meta name="description" content="FAMILY2DEVCELL - Returns the device list for a family and a cell"> |
---|
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="#">machine</a> > <a href="#">Soleil</a> > <a href="index.html">common</a> > family2devcell.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 machine/Soleil/common <img alt=">" border="0" src="../../../right.png"></a></td></tr></table>--> |
---|
19 | |
---|
20 | <h1>family2devcell |
---|
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>FAMILY2DEVCELL - Returns the device list for a family and a cell</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 = family2devcell(Family, 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">FAMILY2DEVCELL - Returns the device list for a family and a cell |
---|
31 | DeviceList = family2dev(FamilyName, StatusFlag) |
---|
32 | |
---|
33 | INPUTS |
---|
34 | 1. Family = Family name ('BEND', 'Q1', 'S1', 'S2', 'HCOR', 'VCOR', etc.) |
---|
35 | Data Structure (only the FamilyName field is used) |
---|
36 | Accelerator Object (only the FamilyName field is used) |
---|
37 | Cell Array |
---|
38 | 2. CellNumber - Cell number eg. 1, [2 3] |
---|
39 | 3. StatusFlag - 0 return all devices |
---|
40 | 1 return only devices with good status {Default} |
---|
41 | |
---|
42 | OUTPUTS |
---|
43 | 1. DeviceList - Device list corresponding to the Family |
---|
44 | Empty if not found |
---|
45 | |
---|
46 | See Also dev2family, family2common, family2dev, family2handle |
---|
47 | family2status, family2tol, family2units, family2tango</pre></div> |
---|
48 | |
---|
49 | <!-- crossreference --> |
---|
50 | <h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../../../up.png"></a></h2> |
---|
51 | This function calls: |
---|
52 | <ul style="list-style-image:url(../../../matlabicon.gif)"> |
---|
53 | <li><a href="family2devcell.html" class="code" title="function DeviceList = family2devcell(Family, varargin);">family2devcell</a> FAMILY2DEVCELL - Returns the device list for a family and a cell</li></ul> |
---|
54 | This function is called by: |
---|
55 | <ul style="list-style-image:url(../../../matlabicon.gif)"> |
---|
56 | <li><a href="family2devcell.html" class="code" title="function DeviceList = family2devcell(Family, varargin);">family2devcell</a> FAMILY2DEVCELL - Returns the device list for a family and a cell</li></ul> |
---|
57 | <!-- crossreference --> |
---|
58 | |
---|
59 | |
---|
60 | <h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../../../up.png"></a></h2> |
---|
61 | <div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function DeviceList = family2devcell(Family, varargin);</a> |
---|
62 | 0002 <span class="comment">%FAMILY2DEVCELL - Returns the device list for a family and a cell</span> |
---|
63 | 0003 <span class="comment">% DeviceList = family2dev(FamilyName, StatusFlag)</span> |
---|
64 | 0004 <span class="comment">%</span> |
---|
65 | 0005 <span class="comment">% INPUTS</span> |
---|
66 | 0006 <span class="comment">% 1. Family = Family name ('BEND', 'Q1', 'S1', 'S2', 'HCOR', 'VCOR', etc.)</span> |
---|
67 | 0007 <span class="comment">% Data Structure (only the FamilyName field is used)</span> |
---|
68 | 0008 <span class="comment">% Accelerator Object (only the FamilyName field is used)</span> |
---|
69 | 0009 <span class="comment">% Cell Array</span> |
---|
70 | 0010 <span class="comment">% 2. CellNumber - Cell number eg. 1, [2 3]</span> |
---|
71 | 0011 <span class="comment">% 3. StatusFlag - 0 return all devices</span> |
---|
72 | 0012 <span class="comment">% 1 return only devices with good status {Default}</span> |
---|
73 | 0013 <span class="comment">%</span> |
---|
74 | 0014 <span class="comment">% OUTPUTS</span> |
---|
75 | 0015 <span class="comment">% 1. DeviceList - Device list corresponding to the Family</span> |
---|
76 | 0016 <span class="comment">% Empty if not found</span> |
---|
77 | 0017 <span class="comment">%</span> |
---|
78 | 0018 <span class="comment">% See Also dev2family, family2common, family2dev, family2handle</span> |
---|
79 | 0019 <span class="comment">% family2status, family2tol, family2units, family2tango</span> |
---|
80 | 0020 |
---|
81 | 0021 <span class="comment">%</span> |
---|
82 | 0022 <span class="comment">% Written by Laurent S. Nadolski</span> |
---|
83 | 0023 |
---|
84 | 0024 <span class="keyword">if</span> nargin == 0 |
---|
85 | 0025 error(<span class="string">'Must have at least one input.'</span>); |
---|
86 | 0026 <span class="keyword">end</span> |
---|
87 | 0027 |
---|
88 | 0028 <span class="comment">% Status input</span> |
---|
89 | 0029 <span class="keyword">if</span> nargin >= 2 |
---|
90 | 0030 CellNumber = varargin{1}; |
---|
91 | 0031 <span class="keyword">if</span> nargin >= 3 |
---|
92 | 0032 StatusFlag = varargin{2}; |
---|
93 | 0033 <span class="keyword">else</span> |
---|
94 | 0034 <span class="comment">% This choice changes the default behavior for the entire middle layer !!!!</span> |
---|
95 | 0035 StatusFlag = 1; <span class="comment">% Only return good status devices</span> |
---|
96 | 0036 <span class="keyword">end</span> |
---|
97 | 0037 <span class="keyword">else</span> |
---|
98 | 0038 CellNumber = 1; |
---|
99 | 0039 StatusFlag = 1; <span class="comment">% Only return good status devices</span> |
---|
100 | 0040 <span class="keyword">end</span> |
---|
101 | 0041 |
---|
102 | 0042 <span class="comment">%%%%%%%%%%%%%%%%%%%%%</span> |
---|
103 | 0043 <span class="comment">% Cell Array Inputs %</span> |
---|
104 | 0044 <span class="comment">%%%%%%%%%%%%%%%%%%%%%</span> |
---|
105 | 0045 <span class="keyword">if</span> iscell(Family) |
---|
106 | 0046 <span class="keyword">for</span> i = 1:length(Family) |
---|
107 | 0047 <span class="keyword">if</span> iscell(StatusFlag) |
---|
108 | 0048 DeviceList{i} = <a href="family2devcell.html" class="code" title="function DeviceList = family2devcell(Family, varargin);">family2devcell</a>(Family{i}, StatusFlag{i}); |
---|
109 | 0049 <span class="keyword">else</span> |
---|
110 | 0050 DeviceList{i} = <a href="family2devcell.html" class="code" title="function DeviceList = family2devcell(Family, varargin);">family2devcell</a>(Family{i}, StatusFlag); |
---|
111 | 0051 <span class="keyword">end</span> |
---|
112 | 0052 <span class="keyword">end</span> |
---|
113 | 0053 <span class="keyword">return</span> |
---|
114 | 0054 <span class="keyword">end</span> |
---|
115 | 0055 |
---|
116 | 0056 |
---|
117 | 0057 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
118 | 0058 <span class="comment">% Family or data structure inputs beyond this point %</span> |
---|
119 | 0059 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
120 | 0060 <span class="keyword">if</span> isstruct(Family) |
---|
121 | 0061 <span class="comment">% Structures can be an accelerator object or a data structure (as returned by getpv)</span> |
---|
122 | 0062 <span class="keyword">if</span> isfield(Family, <span class="string">'FamilyName'</span>) |
---|
123 | 0063 <span class="comment">% Data structure</span> |
---|
124 | 0064 Family = Family.FamilyName; |
---|
125 | 0065 <span class="keyword">else</span> |
---|
126 | 0066 error(<span class="string">'Family input of unknown type'</span>); |
---|
127 | 0067 <span class="keyword">end</span> |
---|
128 | 0068 <span class="keyword">end</span> |
---|
129 | 0069 |
---|
130 | 0070 |
---|
131 | 0071 [DeviceList, ErrorFlag] = getfamilydata(Family, <span class="string">'DeviceList'</span>); |
---|
132 | 0072 <span class="keyword">if</span> isempty(DeviceList) |
---|
133 | 0073 error(sprintf(<span class="string">'%s family not found'</span>, Family)); |
---|
134 | 0074 <span class="keyword">end</span> |
---|
135 | 0075 |
---|
136 | 0076 ind = []; |
---|
137 | 0077 <span class="keyword">for</span> k = 1:length(CellNumber) |
---|
138 | 0078 ind = [ind; find(DeviceList(:,1) == CellNumber(k))]; |
---|
139 | 0079 <span class="keyword">end</span> |
---|
140 | 0080 DeviceList = DeviceList(ind,:); |
---|
141 | 0081 |
---|
142 | 0082 <span class="keyword">if</span> StatusFlag |
---|
143 | 0083 Status = getfamilydata(Family, <span class="string">'Status'</span>, DeviceList); |
---|
144 | 0084 <span class="keyword">if</span> isempty(Status) |
---|
145 | 0085 fprintf(<span class="string">' WARNING: Status field not in the AO, hence ignored.\n'</span>); |
---|
146 | 0086 <span class="keyword">else</span> |
---|
147 | 0087 DeviceList = DeviceList(find(Status),:); |
---|
148 | 0088 <span class="keyword">end</span> |
---|
149 | 0089 <span class="keyword">end</span></pre></div> |
---|
150 | <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> © 2003</address> |
---|
151 | </body> |
---|
152 | </html> |
---|