sam-t2/devtools/v8plus/html/python/lib/al-port-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="prev" href="al-config-objects.html" />
<link rel="parent" href="module-al.html" />
<link rel="next" href="module-al-constants.html" />
<meta name='aesop' content='information' />
<title>20.1.2 Port Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="20.1.1 Configuration Objects"
  href="al-config-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="20.1 al  "
  href="module-al.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="20.2 AL  "
  href="module-al-constants.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="al-config-objects.html">20.1.1 Configuration Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-al.html">20.1 al  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-al-constants.html">20.2 AL  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0022120000000000000000"></A><A NAME="al-port-objects"></A>
<BR>
20.1.2 Port Objects
</H2>

<P>
Port objects, as returned by <tt class="function">openport()</tt>, have the following
methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5054' xml:id='l2h-5054' class="method">closeport</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Close the port.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5055' xml:id='l2h-5055' class="method">getfd</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the file descriptor as an int.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5056' xml:id='l2h-5056' class="method">getfilled</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the number of filled samples.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5057' xml:id='l2h-5057' class="method">getfillable</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the number of fillable samples.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5058' xml:id='l2h-5058' class="method">readsamps</tt></b>(</nobr></td>
  <td><var>nsamples</var>)</td></tr></table></dt>
<dd>
Read a number of samples from the queue, blocking if necessary.
Return the data as a string containing the raw data, (e.g., 2 bytes per
sample in big-endian byte order (high byte, low byte) if you have set
the sample width to 2 bytes).
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5059' xml:id='l2h-5059' class="method">writesamps</tt></b>(</nobr></td>
  <td><var>samples</var>)</td></tr></table></dt>
<dd>
Write samples into the queue, blocking if necessary.  The samples are
encoded as described for the <tt class="method">readsamps()</tt> return value.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5060' xml:id='l2h-5060' class="method">getfillpoint</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the `fill point'.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5061' xml:id='l2h-5061' class="method">setfillpoint</tt></b>(</nobr></td>
  <td><var>fillpoint</var>)</td></tr></table></dt>
<dd>
Set the `fill point'.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5062' xml:id='l2h-5062' class="method">getconfig</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return a configuration object containing the current configuration of
the port.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5063' xml:id='l2h-5063' class="method">setconfig</tt></b>(</nobr></td>
  <td><var>config</var>)</td></tr></table></dt>
<dd>
Set the configuration from the argument, a configuration object.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5064' xml:id='l2h-5064' class="method">getstatus</tt></b>(</nobr></td>
  <td><var>list</var>)</td></tr></table></dt>
<dd>
Get status information on last error.
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="20.1.1 Configuration Objects"
  href="al-config-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="20.1 al  "
  href="module-al.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="20.2 AL  "
  href="module-al-constants.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="al-config-objects.html">20.1.1 Configuration Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-al.html">20.1 al  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-al-constants.html">20.2 AL  </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>