source: MML/trunk/mml/doc_html/mml/at/getatfield.html @ 4

Last change on this file since 4 was 4, checked in by zhangj, 11 years ago

Initial import--MML version from SOLEIL@2013
File size: 7.7 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 getatfield</title>
6  <meta name="keywords" content="getatfield">
7  <meta name="description" content="GETATFIELD - Returns the contents of an AT model field">
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; <a href="index.html">at</a> &gt; getatfield.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/at&nbsp;<img alt=">" border="0" src="../../right.png"></a></td></tr></table>-->
19
20<h1>getatfield
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>GETATFIELD - Returns the contents of an AT model field</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 [FieldValue, ATIndexList] = getatfield(Family, Field, 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">GETATFIELD - Returns the contents of an AT model field
31  [FieldValue, ATIndex] = getatfield(Family, Field, DeviceList, RowSubIndex, ColSubIndex)
32
33  INPUTS
34  1. Family - Family Name
35              Accelerator Object
36              AT FamName
37  2. Field - AT field name
38  3. DeviceList - [Sector Device #] or [element #] list {Default: whole family}
39                  Note: if using an AT family name, then DeviceList is an index
40                        within the AT family.
41  4. RowSubIndex - Row element index within the AT field {Default: the entire field}
42  5. ColSubIndex - Column element index within the AT field {Default: the entire field}
43 
44  OUTPUTS
45  1. FieldValue - Value of the AT field
46  2. ATIndex - AT index
47
48  Written by Greg Portmann</pre></div>
49
50<!-- crossreference -->
51<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../../up.png"></a></h2>
52This function calls:
53<ul style="list-style-image:url(../../matlabicon.gif)">
54<li><a href="family2atindex.html" class="code" title="function [ATIndexList, ErrorFlag] = family2atindex(Family, varargin);">family2atindex</a> FAMILY2ATINDEX - Returns the AT index for a given family</li></ul>
55This function is called by:
56<ul style="list-style-image:url(../../matlabicon.gif)">
57</ul>
58<!-- crossreference -->
59
60
61<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../../up.png"></a></h2>
62<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function [FieldValue, ATIndexList] = getatfield(Family, Field, varargin)</a>
630002 <span class="comment">%GETATFIELD - Returns the contents of an AT model field</span>
640003 <span class="comment">%  [FieldValue, ATIndex] = getatfield(Family, Field, DeviceList, RowSubIndex, ColSubIndex)</span>
650004 <span class="comment">%</span>
660005 <span class="comment">%  INPUTS</span>
670006 <span class="comment">%  1. Family - Family Name</span>
680007 <span class="comment">%              Accelerator Object</span>
690008 <span class="comment">%              AT FamName</span>
700009 <span class="comment">%  2. Field - AT field name</span>
710010 <span class="comment">%  3. DeviceList - [Sector Device #] or [element #] list {Default: whole family}</span>
720011 <span class="comment">%                  Note: if using an AT family name, then DeviceList is an index</span>
730012 <span class="comment">%                        within the AT family.</span>
740013 <span class="comment">%  4. RowSubIndex - Row element index within the AT field {Default: the entire field}</span>
750014 <span class="comment">%  5. ColSubIndex - Column element index within the AT field {Default: the entire field}</span>
760015 <span class="comment">%</span>
770016 <span class="comment">%  OUTPUTS</span>
780017 <span class="comment">%  1. FieldValue - Value of the AT field</span>
790018 <span class="comment">%  2. ATIndex - AT index</span>
800019 <span class="comment">%</span>
810020 <span class="comment">%  Written by Greg Portmann</span>
820021
830022
840023 <span class="keyword">global</span> THERING
850024
860025 <span class="keyword">if</span> nargin &lt; 2
870026     error(<span class="string">'Must have at least Family and Field inputs.'</span>);
880027 <span class="keyword">end</span>
890028
900029 <span class="keyword">if</span> length(varargin) &gt;= 1
910030     ATIndexList = <a href="family2atindex.html" class="code" title="function [ATIndexList, ErrorFlag] = family2atindex(Family, varargin);">family2atindex</a>(Family, varargin{1});
920031 <span class="keyword">else</span>
930032     ATIndexList = <a href="family2atindex.html" class="code" title="function [ATIndexList, ErrorFlag] = family2atindex(Family, varargin);">family2atindex</a>(Family);
940033 <span class="keyword">end</span>
950034
960035 <span class="keyword">if</span> isempty(ATIndexList)
970036     <span class="comment">% Try an AT family</span>
980037     ATIndexList = findcells(THERING, <span class="string">'FamName'</span>, Family);
990038     ATIndexList = ATIndexList(:);
1000039     <span class="keyword">if</span> length(varargin) &gt;= 1
1010040         ATIndexList = ATIndexList(varargin{1});
1020041     <span class="keyword">end</span>
1030042 <span class="keyword">end</span>
1040043
1050044 <span class="keyword">if</span> length(ATIndexList) == 1
1060045     <span class="keyword">if</span> isfield(THERING{ATIndexList}, Field)
1070046         <span class="keyword">if</span> length(varargin) == 2
1080047             FieldValue = THERING{ATIndexList}.(Field)(varargin{2},:);
1090048         <span class="keyword">elseif</span> length(varargin) &gt;= 3
1100049             FieldValue = THERING{ATIndexList}.(Field)(varargin{2},varargin{3});
1110050         <span class="keyword">else</span>
1120051             FieldValue = THERING{ATIndexList}.(Field);
1130052         <span class="keyword">end</span>
1140053     <span class="keyword">else</span>
1150054         FieldValue = NaN;
1160055     <span class="keyword">end</span>
1170056 <span class="keyword">else</span>
1180057     <span class="keyword">for</span> i = 1:size(ATIndexList,1)
1190058         <span class="keyword">if</span> isfield(THERING{ATIndexList(i)}, Field)
1200059             <span class="keyword">if</span> length(varargin) == 2
1210060                 FieldValue(i,:) = THERING{ATIndexList(i)}.(Field)(varargin{2},:);
1220061             <span class="keyword">elseif</span> length(varargin) &gt;= 3
1230062                 FieldValue(i,:) = THERING{ATIndexList(i)}.(Field)(varargin{2},varargin{3});
1240063             <span class="keyword">else</span>
1250064                 FieldValue(i,:) = THERING{ATIndexList(i)}.(Field);
1260065             <span class="keyword">end</span>
1270066         <span class="keyword">else</span>
1280067             <span class="keyword">if</span> length(varargin) &gt;= 2
1290068                 FieldValue(i,:) = NaN * ones(1,length(varargin{2}));
1300069             <span class="keyword">else</span>
1310070                 FieldValue(i,:) = NaN;
1320071             <span class="keyword">end</span>
1330072         <span class="keyword">end</span>
1340073     <span class="keyword">end</span>
1350074 <span class="keyword">end</span>
1360075</pre></div>
137<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>
138</body>
139</html>
Note: See TracBrowser for help on using the repository browser.