diff options
Diffstat (limited to 'docs/api/netaddr.eui.IAB-class.html')
| -rw-r--r-- | docs/api/netaddr.eui.IAB-class.html | 599 |
1 files changed, 599 insertions, 0 deletions
diff --git a/docs/api/netaddr.eui.IAB-class.html b/docs/api/netaddr.eui.IAB-class.html new file mode 100644 index 0000000..ff00ea8 --- /dev/null +++ b/docs/api/netaddr.eui.IAB-class.html @@ -0,0 +1,599 @@ +<?xml version="1.0" encoding="ascii"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>netaddr.eui.IAB</title> + <link rel="stylesheet" href="epydoc.css" type="text/css" /> + <script type="text/javascript" src="epydoc.js"></script> +</head> + +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="netaddr-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + >netaddr</th> + </tr></table></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + <a href="netaddr-module.html">Package netaddr</a> :: + <a href="netaddr.eui-module.html" onclick="show_private();">Package eui</a> :: + Class IAB + </span> + </td> + <td> + <table cellpadding="0" cellspacing="0"> + <!-- hide/show private --> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="netaddr.eui.IAB-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class IAB</h1><p class="nomargin-top"><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB">source code</a></span></p> +<pre class="base-tree"> +object --+ + | + <strong class="uidshort">IAB</strong> +</pre> + +<hr /> +<p>Represents an individual IEEE IAB (Individual Address Block) + identifier.</p> + <p>For online details see - http://standards.ieee.org/regauth/oui/</p> + +<!-- ==================== INSTANCE METHODS ==================== --> +<a name="section-InstanceMethods"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td align="left" colspan="2" class="table-header"> + <span class="table-header">Instance Methods</span></td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">iab</span>, + <span class="summary-sig-arg">strict</span>=<span class="summary-sig-default">False</span>)</span><br /> + Constructor</td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__init__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#address" class="summary-sig-name">address</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns: + registered address of organisation</td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.address">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#org" class="summary-sig-name">org</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns: + the name of organisation</td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.org">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#organisation" class="summary-sig-name">organisation</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns: + the name of organisation</td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.org">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#__int__" class="summary-sig-name">__int__</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns: + integer representation of this IAB</td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__int__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#__hex__" class="summary-sig-name">__hex__</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns: + network byte order hexadecimal string of this IAB</td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__hex__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns: + string representation of this IAB</td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__str__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#registration" class="summary-sig-name">registration</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns: + registration details for this IAB</td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.registration">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns: + executable Python string to recreate equivalent object.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__repr__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__delattr__</code>, + <code>__getattribute__</code>, + <code>__hash__</code>, + <code>__new__</code>, + <code>__reduce__</code>, + <code>__reduce_ex__</code>, + <code>__setattr__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== STATIC METHODS ==================== --> +<a name="section-StaticMethods"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td align="left" colspan="2" class="table-header"> + <span class="table-header">Static Methods</span></td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="netaddr.eui.IAB-class.html#split_iab_mac" class="summary-sig-name">split_iab_mac</a>(<span class="summary-sig-arg">eui_int</span>, + <span class="summary-sig-arg">strict</span>=<span class="summary-sig-default">False</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.split_iab_mac">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +</table> +<!-- ==================== PROPERTIES ==================== --> +<a name="section-Properties"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td align="left" colspan="2" class="table-header"> + <span class="table-header">Properties</span></td> +</tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__class__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== METHOD DETAILS ==================== --> +<a name="section-MethodDetails"></a> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td align="left" colspan="2" class="table-header"> + <span class="table-header">Method Details</span></td> +</tr> +</table> +<a name="split_iab_mac"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">split_iab_mac</span>(<span class="sig-arg">eui_int</span>, + <span class="sig-arg">strict</span>=<span class="sig-default">False</span>)</span> + <br /><em class="fname">Static Method</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.split_iab_mac">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>eui_int</code></strong> - a MAC IAB integer value in network byte order.</li> + <li><strong class="pname"><code>strict</code></strong> - If True, raises a ValueError if the last 12 bits of IAB + MAC/EUI-48 address are non-zero, ignores them otherwise. + (Default: False)</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="__init__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">iab</span>, + <span class="sig-arg">strict</span>=<span class="sig-default">False</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__init__">source code</a></span> + </td> + </tr></table> + + <p>Constructor</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>iab</code></strong> - an IAB string <code>00-50-C2-XX-X0-00</code> or a network byte + order integer. This address looks like an EUI-48 but it should + not have any non-zero bits in the last 3 bytes.</li> + <li><strong class="pname"><code>strict</code></strong> - If True, raises a ValueError if the last 12 bits of IAB + MAC/EUI-48 address are non-zero, ignores them otherwise. + (Default: False)</li> + </ul></dd> + <dt>Overrides: + object.__init__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="address"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">address</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.address">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Returns:</dt> + <dd>registered address of organisation</dd> + </dl> +</td></tr></table> +</div> +<a name="org"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">org</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.org">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Returns:</dt> + <dd>the name of organisation</dd> + </dl> +</td></tr></table> +</div> +<a name="organisation"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">organisation</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.org">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Returns:</dt> + <dd>the name of organisation</dd> + </dl> +</td></tr></table> +</div> +<a name="__int__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__int__</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__int__">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Returns:</dt> + <dd>integer representation of this IAB</dd> + </dl> +</td></tr></table> +</div> +<a name="__hex__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__hex__</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__hex__">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Returns:</dt> + <dd>network byte order hexadecimal string of this IAB</dd> + </dl> +</td></tr></table> +</div> +<a name="__str__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span> + <br /><em class="fname">(Informal representation operator)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__str__">source code</a></span> + </td> + </tr></table> + + <p>str(x)</p> + <dl class="fields"> + <dt>Returns:</dt> + <dd>string representation of this IAB</dd> + <dt>Overrides: + object.__str__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="registration"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">registration</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.registration">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Returns:</dt> + <dd>registration details for this IAB</dd> + </dl> +</td></tr></table> +</div> +<a name="__repr__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span> + <br /><em class="fname">(Representation operator)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="netaddr.eui-pysrc.html#IAB.__repr__">source code</a></span> + </td> + </tr></table> + + <p>repr(x)</p> + <dl class="fields"> + <dt>Returns:</dt> + <dd>executable Python string to recreate equivalent object.</dd> + <dt>Overrides: + object.__repr__ + </dt> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="netaddr-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + >netaddr</th> + </tr></table></th> + </tr> +</table> +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> + <tr> + <td align="left" class="footer"> + Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009 + </td> + <td align="right" class="footer"> + <a target="mainFrame" href="http://epydoc.sourceforge.net" + >http://epydoc.sourceforge.net</a> + </td> + </tr> +</table> + +<script type="text/javascript"> + <!-- + // Private objects are initially displayed (because if + // javascript is turned off then we want them to be + // visible); but by default, we want to hide them. So hide + // them unless we have a cookie that says to show them. + checkCookie(); + // --> +</script> +</body> +</html> |