source: MML/trunk/mml/doc_html/mml/showfamily.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: 7.8 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 showfamily</title>
6  <meta name="keywords" content="showfamily">
7  <meta name="description" content="SHOWFAMILY - Displays a list of all families">
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; showfamily.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>showfamily
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>SHOWFAMILY - Displays a list of all families</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  AO = showfamily(Family) </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">SHOWFAMILY - Displays a list of all families
31  AO = showfamily(Family)
32
33  INPUTS
34  1. Family -  Family name {Default: All families}
35 
36  OUTPUTS
37  1. AO - Structure for that family or the entire AO for no inputs
38
39  See also <a href="getfamilylist.html" class="code" title="function  [Families, AO] = getfamilylist(OutputFlag)">getfamilylist</a>, <a href="showfamily.html" class="code" title="function  AO = showfamily(Family)">showfamily</a>, <a href="isfamily.html" class="code" title="function  [FamilyFlag, AO] = isfamily(Family, Field)">isfamily</a>, getfamilytype</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>
43This function calls:
44<ul style="list-style-image:url(../matlabicon.gif)">
45<li><a href="getao.html" class="code" title="function  AO = getao(FileName)">getao</a>  GETAO - returns the AcceleratorObject (AO)</li><li><a href="isfamily.html" class="code" title="function  [FamilyFlag, AO] = isfamily(Family, Field)">isfamily</a>       ISFAMILY - True for family names</li></ul>
46This 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  AO = showfamily(Family)</a>
540002 <span class="comment">%SHOWFAMILY - Displays a list of all families</span>
550003 <span class="comment">%  AO = showfamily(Family)</span>
560004 <span class="comment">%</span>
570005 <span class="comment">%  INPUTS</span>
580006 <span class="comment">%  1. Family -  Family name {Default: All families}</span>
590007 <span class="comment">%</span>
600008 <span class="comment">%  OUTPUTS</span>
610009 <span class="comment">%  1. AO - Structure for that family or the entire AO for no inputs</span>
620010 <span class="comment">%</span>
630011 <span class="comment">%  See also getfamilylist, showfamily, isfamily, getfamilytype</span>
640012
650013 <span class="comment">%</span>
660014 <span class="comment">%  Written by J. Corbett</span>
670015 <span class="comment">% Modified by Laurent S. Nadolski</span>
680016 <span class="comment">% ChannelNames --&gt; TangoNames</span>
690017
700018 <span class="keyword">if</span> nargin &lt; 1
710019     AO = <a href="getao.html" class="code" title="function  AO = getao(FileName)">getao</a>;
720020     FieldNameCell = fieldnames(AO);
730021     Ntotal = 0;
740022     
750023     <span class="keyword">for</span> i = 1:length(FieldNameCell)
760024         <span class="keyword">if</span> isfield(AO, FieldNameCell{i})
770025             <span class="keyword">if</span> isfield(AO.(FieldNameCell{i}),<span class="string">'FamilyName'</span>)
780026                 N = size(AO.(FieldNameCell{i}).DeviceList,1);
790027                 fprintf(<span class="string">'   Family = %s (%d devices)\n'</span>, AO.(FieldNameCell{i}).FamilyName,  N);
800028             <span class="keyword">else</span>
810029                 N = 0;
820030             <span class="keyword">end</span>
830031             
840032             <span class="comment">% Find all the subfields that are data structures</span>
850033             SubFieldNameCell = fieldnames(AO.(FieldNameCell{i}));
860034             NDeviceFamily = 0;
870035             <span class="keyword">for</span> ii = 1:length(SubFieldNameCell)
880036                 <span class="keyword">if</span> isfield(AO.(FieldNameCell{i}).(SubFieldNameCell{ii}),<span class="string">'TangoNames'</span>)  <span class="keyword">...</span>
890037                 | isfield(AO.(FieldNameCell{i}).(SubFieldNameCell{ii}),<span class="string">'SpecialFunction'</span>)  <span class="keyword">...</span><span class="comment"> </span>
900038                 | isfield(AO.(FieldNameCell{i}).(SubFieldNameCell{ii}),<span class="string">'SpecialFunctionGet'</span>)  <span class="keyword">...</span><span class="comment"> </span>
910039                 | isfield(AO.(FieldNameCell{i}).(SubFieldNameCell{ii}),<span class="string">'SpecialFunctionSet'</span>)
920040                     
930041                     fprintf(<span class="string">'   %s.%s\n'</span>, AO.(FieldNameCell{i}).FamilyName, SubFieldNameCell{ii});
940042                     NDeviceFamily = NDeviceFamily + N;
950043                     Ntotal = Ntotal + N;
960044                 <span class="keyword">end</span>
970045             <span class="keyword">end</span>
980046             fprintf(<span class="string">'\n'</span>);
990047         <span class="keyword">end</span>
1000048     <span class="keyword">end</span>
1010049     fprintf(<span class="string">'   The total number of devices is %d\n'</span>, Ntotal);
1020050     
1030051 <span class="keyword">else</span>
1040052     
1050053     [Flag, AO] = <a href="isfamily.html" class="code" title="function  [FamilyFlag, AO] = isfamily(Family, Field)">isfamily</a>(Family);
1060054     
1070055     <span class="keyword">if</span> ~Flag 
1080056         disp(<span class="string">'Warning: Family not found in showfamily'</span>);
1090057         <span class="keyword">return</span>;
1100058     <span class="keyword">end</span>
1110059     
1120060     fields = fieldnames(AO);
1130061     
1140062     disp(<span class="string">'   ============================================='</span>);
1150063     fprintf(<span class="string">'   Fields contained in Family:  %s (%d devices)\n'</span>, AO.FamilyName,  size(AO.DeviceList,1));
1160064     disp(<span class="string">'   ============================================='</span>);
1170065     <span class="keyword">for</span> ii=1:length(fields)
1180066         disp([<span class="string">'   '</span>, fields{ii}])
1190067         <span class="keyword">if</span> isstruct(AO.(fields{ii}))                      <span class="comment">%dynamic field names</span>
1200068             subfields=fieldnames(AO.(fields{ii}));
1210069             <span class="keyword">for</span> jj=1:length(subfields)
1220070                 disp([<span class="string">'      '</span> subfields{jj}])
1230071             <span class="keyword">end</span>
1240072         <span class="keyword">end</span>
1250073     <span class="keyword">end</span>
1260074     fprintf(<span class="string">'\n'</span>);
1270075     
1280076 <span class="keyword">end</span></pre></div>
129<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>
130</body>
131</html>
Note: See TracBrowser for help on using the repository browser.