source: MML/trunk/mml/doc_html/mml/channel2family.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: 5.4 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 channel2family</title>
6  <meta name="keywords" content="channel2family">
7  <meta name="description" content="CHANNEL2FAMILY - Convert a channel name to a Family, Field, DeviceList">
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; channel2family.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>channel2family
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>CHANNEL2FAMILY - Convert a channel name to a Family, Field, DeviceList</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 [FamilyName, Field, DeviceList, ErrorFlag] = channel2family(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">CHANNEL2FAMILY - Convert a channel name to a Family, Field, DeviceList
31  [Family, Field, DeviceList, ErrorFlag] = channel2family(ChannelNames, Family)
32
33  INPUTS
34  1. ChannelNames - List of channel names (string, matrix, or cell array)
35  2. Family - Family Names to to limit search (string or cell of strings)
36              Accelerator Object
37              '' search all families {Default}
38
39  OUTPUTS
40  1. Family - Family name corresponding to the channel name
41              If the channel name cannot be found an empty strings
42             (or a blank string for matrix inputs) is returned
43  2. Field - Field Name
44  3. DeviceList - DeviceList corresponding to the common name
45                  If no common names are found, an empty matrix is returned
46                  If only some common names are not found, [NaN NaN] will be
47                  inserted into the device list where they are not found.
48  4. ErrorFlag - number of errors found
49
50  Written by Greg Portmann</pre></div>
51
52<!-- crossreference -->
53<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
54This function calls:
55<ul style="list-style-image:url(../matlabicon.gif)">
56<li><a href="channel2dev.html" class="code" title="function [DeviceList, FamilyName, Field, ErrorFlag] = channel2dev(ChannelNames, FamilyList)">channel2dev</a> CHANNEL2DEV - Converts a channel name list to a device list</li></ul>
57This function is called by:
58<ul style="list-style-image:url(../matlabicon.gif)">
59</ul>
60<!-- crossreference -->
61
62
63<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
64<div class="fragment"><pre>0001 <a name="_sub0" href="#_subfunctions" class="code">function [FamilyName, Field, DeviceList, ErrorFlag] = channel2family(varargin)</a>
650002 <span class="comment">%CHANNEL2FAMILY - Convert a channel name to a Family, Field, DeviceList</span>
660003 <span class="comment">%  [Family, Field, DeviceList, ErrorFlag] = channel2family(ChannelNames, Family)</span>
670004 <span class="comment">%</span>
680005 <span class="comment">%  INPUTS</span>
690006 <span class="comment">%  1. ChannelNames - List of channel names (string, matrix, or cell array)</span>
700007 <span class="comment">%  2. Family - Family Names to to limit search (string or cell of strings)</span>
710008 <span class="comment">%              Accelerator Object</span>
720009 <span class="comment">%              '' search all families {Default}</span>
730010 <span class="comment">%</span>
740011 <span class="comment">%  OUTPUTS</span>
750012 <span class="comment">%  1. Family - Family name corresponding to the channel name</span>
760013 <span class="comment">%              If the channel name cannot be found an empty strings</span>
770014 <span class="comment">%             (or a blank string for matrix inputs) is returned</span>
780015 <span class="comment">%  2. Field - Field Name</span>
790016 <span class="comment">%  3. DeviceList - DeviceList corresponding to the common name</span>
800017 <span class="comment">%                  If no common names are found, an empty matrix is returned</span>
810018 <span class="comment">%                  If only some common names are not found, [NaN NaN] will be</span>
820019 <span class="comment">%                  inserted into the device list where they are not found.</span>
830020 <span class="comment">%  4. ErrorFlag - number of errors found</span>
840021 <span class="comment">%</span>
850022 <span class="comment">%  Written by Greg Portmann</span>
860023
870024
880025 [DeviceList, FamilyName, Field, ErrorFlag] = <a href="channel2dev.html" class="code" title="function [DeviceList, FamilyName, Field, ErrorFlag] = channel2dev(ChannelNames, FamilyList)">channel2dev</a>(varargin{:});
890026</pre></div>
90<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>
91</body>
92</html>
Note: See TracBrowser for help on using the repository browser.