[4] | 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 family2channel</title> |
---|
| 6 | <meta name="keywords" content="family2channel"> |
---|
| 7 | <meta name="description" content="FAMILY2CHANNEL - Converts the family name to a channel name"> |
---|
| 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">mml</a> > family2channel.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 mml <img alt=">" border="0" src="../right.png"></a></td></tr></table>--> |
---|
| 19 | |
---|
| 20 | <h1>family2channel |
---|
| 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>FAMILY2CHANNEL - Converts the family name to a channel name</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 [ChannelNames, ErrorFlag] = family2channel(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">FAMILY2CHANNEL - Converts the family name to a channel name |
---|
| 31 | ChannelName = family2channel(Family, Field, DeviceList) |
---|
| 32 | ChannelName = family2channel(Family, DeviceList) |
---|
| 33 | |
---|
| 34 | INPUTS |
---|
| 35 | 1. Family - Family Name |
---|
| 36 | Data Structure |
---|
| 37 | Accelerator Object |
---|
| 38 | or Cell Array of Families |
---|
| 39 | 2. Field = Accelerator Object field name ('Monitor', 'Setpoint', etc) {Default: 'Monitor'} |
---|
| 40 | 3. DeviceList ([Sector Device #] or [element #]) {Default: whole family} |
---|
| 41 | |
---|
| 42 | OUTPUTS |
---|
| 43 | 1. ChannelName - Channel name corresponding to the Family, Field, and DeviceList |
---|
| 44 | |
---|
| 45 | Written by Greg Portmann</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> |
---|
| 49 | This function calls: |
---|
| 50 | <ul style="list-style-image:url(../matlabicon.gif)"> |
---|
| 51 | <li><a href="common2dev.html" class="code" title="function [DeviceList, FamilyName, ErrorFlag] = common2dev(CommonNames, FamilyList)">common2dev</a> COMMON2DEV - Converts a common name to a device list</li><li><a href="family2channel.html" class="code" title="function [ChannelNames, ErrorFlag] = family2channel(varargin);">family2channel</a> FAMILY2CHANNEL - Converts the family name to a channel name</li><li><a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a> FAMILY2DEV - Return the device list for a family</li><li><a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a> GETFAMILYDATA - Gets data associated with the accelerator control</li></ul> |
---|
| 52 | This function is called by: |
---|
| 53 | <ul style="list-style-image:url(../matlabicon.gif)"> |
---|
| 54 | <li><a href="family2channel.html" class="code" title="function [ChannelNames, ErrorFlag] = family2channel(varargin);">family2channel</a> FAMILY2CHANNEL - Converts the family name to a channel name</li><li><a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a> FAMILY2DEV - Return the device list for a family</li><li><a href="family2handle.html" class="code" title="function [Handles, ErrorFlag] = family2handle(Family, Field, DeviceList);">family2handle</a> [Handles, ErrorFlag] = family2handle(Family, Field, DeviceList)</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 [ChannelNames, ErrorFlag] = family2channel(varargin);</a> |
---|
| 60 | 0002 <span class="comment">%FAMILY2CHANNEL - Converts the family name to a channel name</span> |
---|
| 61 | 0003 <span class="comment">% ChannelName = family2channel(Family, Field, DeviceList)</span> |
---|
| 62 | 0004 <span class="comment">% ChannelName = family2channel(Family, DeviceList)</span> |
---|
| 63 | 0005 <span class="comment">%</span> |
---|
| 64 | 0006 <span class="comment">% INPUTS</span> |
---|
| 65 | 0007 <span class="comment">% 1. Family - Family Name</span> |
---|
| 66 | 0008 <span class="comment">% Data Structure</span> |
---|
| 67 | 0009 <span class="comment">% Accelerator Object</span> |
---|
| 68 | 0010 <span class="comment">% or Cell Array of Families</span> |
---|
| 69 | 0011 <span class="comment">% 2. Field = Accelerator Object field name ('Monitor', 'Setpoint', etc) {Default: 'Monitor'}</span> |
---|
| 70 | 0012 <span class="comment">% 3. DeviceList ([Sector Device #] or [element #]) {Default: whole family}</span> |
---|
| 71 | 0013 <span class="comment">%</span> |
---|
| 72 | 0014 <span class="comment">% OUTPUTS</span> |
---|
| 73 | 0015 <span class="comment">% 1. ChannelName - Channel name corresponding to the Family, Field, and DeviceList</span> |
---|
| 74 | 0016 <span class="comment">%</span> |
---|
| 75 | 0017 <span class="comment">% Written by Greg Portmann</span> |
---|
| 76 | 0018 |
---|
| 77 | 0019 |
---|
| 78 | 0020 <span class="keyword">if</span> nargin == 0 |
---|
| 79 | 0021 error(<span class="string">'Must have at least one input (''Family'')!'</span>); |
---|
| 80 | 0022 <span class="keyword">end</span> |
---|
| 81 | 0023 |
---|
| 82 | 0024 |
---|
| 83 | 0025 <span class="comment">%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 84 | 0026 <span class="comment">% Cell Array Inputs %</span> |
---|
| 85 | 0027 <span class="comment">%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 86 | 0028 <span class="keyword">if</span> iscell(varargin{1}) |
---|
| 87 | 0029 <span class="keyword">if</span> length(varargin) >= 3 && iscell(varargin{3}) |
---|
| 88 | 0030 <span class="keyword">if</span> length(varargin{1}) ~= length(varargin{3}) |
---|
| 89 | 0031 error(<span class="string">'Family and DeviceList must be the same size cell arrays.'</span>); |
---|
| 90 | 0032 <span class="keyword">end</span> |
---|
| 91 | 0033 <span class="keyword">end</span> |
---|
| 92 | 0034 <span class="keyword">if</span> length(varargin) >= 2 && iscell(varargin{2}) |
---|
| 93 | 0035 <span class="keyword">if</span> length(varargin{1}) ~= length(varargin{2}) |
---|
| 94 | 0036 error(<span class="string">'If Field is a cell array, then must be the same size as Family.'</span>); |
---|
| 95 | 0037 <span class="keyword">end</span> |
---|
| 96 | 0038 <span class="keyword">end</span> |
---|
| 97 | 0039 |
---|
| 98 | 0040 |
---|
| 99 | 0041 ErrorFlag = 0; |
---|
| 100 | 0042 <span class="keyword">for</span> i = 1:length(varargin{1}) |
---|
| 101 | 0043 <span class="keyword">if</span> length(varargin) == 1 |
---|
| 102 | 0044 [ChannelNames{i}, ErrorTmp] = <a href="family2channel.html" class="code" title="function [ChannelNames, ErrorFlag] = family2channel(varargin);">family2channel</a>(varargin{1}{i}); |
---|
| 103 | 0045 <span class="keyword">elseif</span> length(varargin) == 2 |
---|
| 104 | 0046 <span class="keyword">if</span> iscell(varargin{2}) |
---|
| 105 | 0047 [ChannelNames{i}, ErrorTmp] = <a href="family2channel.html" class="code" title="function [ChannelNames, ErrorFlag] = family2channel(varargin);">family2channel</a>(varargin{1}{i}, varargin{2}{i}); |
---|
| 106 | 0048 <span class="keyword">else</span> |
---|
| 107 | 0049 [ChannelNames{i}, ErrorTmp] = <a href="family2channel.html" class="code" title="function [ChannelNames, ErrorFlag] = family2channel(varargin);">family2channel</a>(varargin{1}{i}, varargin{2}); |
---|
| 108 | 0050 <span class="keyword">end</span> |
---|
| 109 | 0051 <span class="keyword">else</span> |
---|
| 110 | 0052 <span class="keyword">if</span> iscell(varargin{2}) |
---|
| 111 | 0053 <span class="keyword">if</span> iscell(varargin{3}) |
---|
| 112 | 0054 [ChannelNames{i}, ErrorTmp] = <a href="family2channel.html" class="code" title="function [ChannelNames, ErrorFlag] = family2channel(varargin);">family2channel</a>(varargin{1}{i}, varargin{2}{i}, varargin{3}{i}); |
---|
| 113 | 0055 <span class="keyword">else</span> |
---|
| 114 | 0056 [ChannelNames{i}, ErrorTmp] = <a href="family2channel.html" class="code" title="function [ChannelNames, ErrorFlag] = family2channel(varargin);">family2channel</a>(varargin{1}{i}, varargin{2}{i}, varargin{3}); |
---|
| 115 | 0057 <span class="keyword">end</span> |
---|
| 116 | 0058 <span class="keyword">else</span> |
---|
| 117 | 0059 <span class="keyword">if</span> iscell(varargin{3}) |
---|
| 118 | 0060 [ChannelNames{i}, ErrorTmp] = <a href="family2channel.html" class="code" title="function [ChannelNames, ErrorFlag] = family2channel(varargin);">family2channel</a>(varargin{1}{i}, varargin{2}, varargin{3}{i}); |
---|
| 119 | 0061 <span class="keyword">else</span> |
---|
| 120 | 0062 [ChannelNames{i}, ErrorTmp] = <a href="family2channel.html" class="code" title="function [ChannelNames, ErrorFlag] = family2channel(varargin);">family2channel</a>(varargin{1}{i}, varargin{2}, varargin{3}); |
---|
| 121 | 0063 <span class="keyword">end</span> |
---|
| 122 | 0064 <span class="keyword">end</span> |
---|
| 123 | 0065 <span class="keyword">end</span> |
---|
| 124 | 0066 ErrorFlag = ErrorFlag | ErrorTmp; |
---|
| 125 | 0067 <span class="keyword">end</span> |
---|
| 126 | 0068 <span class="keyword">return</span> |
---|
| 127 | 0069 <span class="keyword">end</span> |
---|
| 128 | 0070 |
---|
| 129 | 0071 |
---|
| 130 | 0072 |
---|
| 131 | 0073 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 132 | 0074 <span class="comment">% Family or data structure inputs beyond this point %</span> |
---|
| 133 | 0075 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 134 | 0076 <span class="keyword">if</span> isstruct(varargin{1}) |
---|
| 135 | 0077 <span class="keyword">if</span> isfield(varargin{1},<span class="string">'FamilyName'</span>) & isfield(varargin{1},<span class="string">'Field'</span>) |
---|
| 136 | 0078 <span class="comment">% Data structure inputs</span> |
---|
| 137 | 0079 Family = varargin{1}.FamilyName; |
---|
| 138 | 0080 |
---|
| 139 | 0081 Field = varargin{1}.Field; |
---|
| 140 | 0082 <span class="keyword">if</span> length(varargin) >= 2 |
---|
| 141 | 0083 <span class="keyword">if</span> ischar(varargin{2}) |
---|
| 142 | 0084 Field = varargin{2}; |
---|
| 143 | 0085 varargin(2) = []; |
---|
| 144 | 0086 <span class="keyword">end</span> |
---|
| 145 | 0087 <span class="keyword">end</span> |
---|
| 146 | 0088 <span class="keyword">if</span> length(varargin) >= 2 |
---|
| 147 | 0089 DeviceList = varargin{2}; |
---|
| 148 | 0090 <span class="keyword">else</span> |
---|
| 149 | 0091 DeviceList = varargin{1}.DeviceList; |
---|
| 150 | 0092 <span class="keyword">end</span> |
---|
| 151 | 0093 <span class="keyword">else</span> |
---|
| 152 | 0094 <span class="comment">% AO input</span> |
---|
| 153 | 0095 Field = <span class="string">''</span>; |
---|
| 154 | 0096 <span class="keyword">if</span> length(varargin) >= 2 |
---|
| 155 | 0097 <span class="keyword">if</span> ischar(varargin{2}) |
---|
| 156 | 0098 Field = varargin{2}; |
---|
| 157 | 0099 varargin(2) = []; |
---|
| 158 | 0100 <span class="keyword">end</span> |
---|
| 159 | 0101 <span class="keyword">end</span> |
---|
| 160 | 0102 <span class="keyword">if</span> length(varargin) >= 2 |
---|
| 161 | 0103 DeviceList = varargin{2}; |
---|
| 162 | 0104 <span class="keyword">else</span> |
---|
| 163 | 0105 DeviceList = varargin{1}.DeviceList; |
---|
| 164 | 0106 <span class="keyword">end</span> |
---|
| 165 | 0107 |
---|
| 166 | 0108 <span class="keyword">if</span> isempty(Field) |
---|
| 167 | 0109 Field = <span class="string">'Monitor'</span>; |
---|
| 168 | 0110 <span class="keyword">end</span> |
---|
| 169 | 0111 <span class="keyword">if</span> isempty(DeviceList) |
---|
| 170 | 0112 DeviceList = varargin{1}.DeviceList; |
---|
| 171 | 0113 <span class="keyword">end</span> |
---|
| 172 | 0114 <span class="keyword">if</span> isempty(DeviceList) |
---|
| 173 | 0115 DeviceList = <a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a>(Family); |
---|
| 174 | 0116 <span class="keyword">end</span> |
---|
| 175 | 0117 |
---|
| 176 | 0118 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 177 | 0119 <span class="comment">% CommonName Input: Convert common names to a varargin{3} %</span> |
---|
| 178 | 0120 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 179 | 0121 <span class="keyword">if</span> isstr(DeviceList) |
---|
| 180 | 0122 DeviceList = <a href="common2dev.html" class="code" title="function [DeviceList, FamilyName, ErrorFlag] = common2dev(CommonNames, FamilyList)">common2dev</a>(DeviceList, Family); |
---|
| 181 | 0123 <span class="keyword">if</span> isempty(DeviceList) |
---|
| 182 | 0124 error(<span class="string">'DeviceList was a string but common names could not be found.'</span>); |
---|
| 183 | 0125 <span class="keyword">end</span> |
---|
| 184 | 0126 <span class="keyword">end</span> |
---|
| 185 | 0127 |
---|
| 186 | 0128 [i,iNotFound] = findrowindex(DeviceList, varargin{1}.DeviceList); |
---|
| 187 | 0129 <span class="keyword">if</span> ~isempty(iNotFound) |
---|
| 188 | 0130 error(<span class="string">'Device at found in the input structure'</span>); |
---|
| 189 | 0131 <span class="keyword">end</span> |
---|
| 190 | 0132 ChannelNames = varargin{1}.(Field).ChannelNames(i,:); |
---|
| 191 | 0133 ErrorFlag = 0; |
---|
| 192 | 0134 |
---|
| 193 | 0135 <span class="keyword">return</span>; |
---|
| 194 | 0136 <span class="keyword">end</span> |
---|
| 195 | 0137 |
---|
| 196 | 0138 <span class="keyword">else</span> |
---|
| 197 | 0139 |
---|
| 198 | 0140 <span class="comment">% Family input</span> |
---|
| 199 | 0141 Family = varargin{1}; |
---|
| 200 | 0142 |
---|
| 201 | 0143 Field = <span class="string">''</span>; |
---|
| 202 | 0144 <span class="keyword">if</span> length(varargin) >= 2 |
---|
| 203 | 0145 <span class="keyword">if</span> ischar(varargin{2}) |
---|
| 204 | 0146 Field = varargin{2}; |
---|
| 205 | 0147 varargin(2) = []; |
---|
| 206 | 0148 <span class="keyword">end</span> |
---|
| 207 | 0149 <span class="keyword">end</span> |
---|
| 208 | 0150 <span class="keyword">if</span> length(varargin) >= 2 |
---|
| 209 | 0151 DeviceList = varargin{2}; |
---|
| 210 | 0152 <span class="keyword">else</span> |
---|
| 211 | 0153 DeviceList = []; |
---|
| 212 | 0154 <span class="keyword">end</span> |
---|
| 213 | 0155 |
---|
| 214 | 0156 <span class="keyword">end</span> |
---|
| 215 | 0157 |
---|
| 216 | 0158 <span class="keyword">if</span> isempty(Field) |
---|
| 217 | 0159 Field = <span class="string">'Monitor'</span>; |
---|
| 218 | 0160 <span class="keyword">end</span> |
---|
| 219 | 0161 <span class="keyword">if</span> isempty(DeviceList) |
---|
| 220 | 0162 DeviceList = <a href="family2dev.html" class="code" title="function DeviceList = family2dev(Family, varargin);">family2dev</a>(Family); |
---|
| 221 | 0163 <span class="keyword">end</span> |
---|
| 222 | 0164 |
---|
| 223 | 0165 |
---|
| 224 | 0166 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 225 | 0167 <span class="comment">% CommonName Input: Convert common names to a varargin{3} %</span> |
---|
| 226 | 0168 <span class="comment">%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%</span> |
---|
| 227 | 0169 <span class="keyword">if</span> isstr(DeviceList) |
---|
| 228 | 0170 DeviceList = <a href="common2dev.html" class="code" title="function [DeviceList, FamilyName, ErrorFlag] = common2dev(CommonNames, FamilyList)">common2dev</a>(DeviceList, Family); |
---|
| 229 | 0171 <span class="keyword">if</span> isempty(DeviceList) |
---|
| 230 | 0172 error(<span class="string">'DeviceList was a string but common names could not be found.'</span>); |
---|
| 231 | 0173 <span class="keyword">end</span> |
---|
| 232 | 0174 <span class="keyword">end</span> |
---|
| 233 | 0175 |
---|
| 234 | 0176 |
---|
| 235 | 0177 <span class="comment">%%%%%%%%%%%%</span> |
---|
| 236 | 0178 <span class="comment">% Get data %</span> |
---|
| 237 | 0179 <span class="comment">%%%%%%%%%%%%</span> |
---|
| 238 | 0180 [ChannelNames, ErrorFlag] = <a href="getfamilydata.html" class="code" title="function [Data, ErrorFlag] = getfamilydata(Family, Field1, Field2, DeviceList)">getfamilydata</a>(Family, Field, <span class="string">'ChannelNames'</span>, DeviceList);</pre></div> |
---|
| 239 | <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> © 2003</address> |
---|
| 240 | </body> |
---|
| 241 | </html> |
---|