<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Group — Astropy v0.2.4</title>
<link rel="stylesheet" href="../_static/bootstrap-astropy.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.2.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="shortcut icon" href="../_static/astropy_logo.ico"/>
<link rel="top" title="Astropy v0.2.4" href="../index.html" />
<link rel="up" title="VOTable XML handling (astropy.io.votable)" href="../io/votable/index.html" />
<link rel="next" title="Table" href="astropy.io.votable.tree.Table.html" />
<link rel="prev" title="ParamRef" href="astropy.io.votable.tree.ParamRef.html" />
</head>
<body>
<div class="topbar">
<a class="brand" title="Documentation Home" href="../index.html"></a>
<ul>
<li><a class="homelink" title="AstroPy Homepage" href="http://www.astropy.org"></a></li>
<li><a title="General Index" href="../genindex.html">Index</a></li>
<li><a title="Python Module Index" href="../py-modindex.html">Modules</a></li>
<li>
<form action="../search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</li>
</ul>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<a href="astropy.io.votable.tree.Table.html" title="Table">
next »
</a>
</li>
<li class="right">
<a href="astropy.io.votable.tree.ParamRef.html" title="ParamRef">
« previous
</a>
|
</li>
<li>
<a href="../index.html">Astropy v0.2.4</a>
»
</li>
<li><a href="../io/votable/index.html" accesskey="U">VOTable XML handling (<tt class="docutils literal"><span class="pre">astropy.io.votable</span></tt>)</a> »</li>
<li>Group</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="id1">
<h1>Group<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="astropy.io.votable.tree.Group">
<em class="property">class </em><tt class="descclassname">astropy.io.votable.tree.</tt><tt class="descname">Group</tt><big>(</big><em>table</em>, <em>ID=None</em>, <em>name=None</em>, <em>ref=None</em>, <em>ucd=None</em>, <em>utype=None</em>, <em>id=None</em>, <em>config={}</em>, <em>pos=None</em>, <em>**extra</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L1720" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Group"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Group" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">astropy.io.votable.tree.Element</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">astropy.io.votable.tree._IDProperty</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">astropy.io.votable.tree._NameProperty</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">astropy.io.votable.tree._UtypeProperty</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">astropy.io.votable.tree._UcdProperty</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">astropy.io.votable.tree._DescriptionProperty</span></tt></p>
<p><a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC31">GROUP</a> element: groups <a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC24">FIELD</a> and <a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC24">PARAM</a> elements.</p>
<p>This information is currently ignored by the vo package—that is
the columns in the recarray are always flat—but the grouping
information is stored so that it can be written out again to the
XML file.</p>
<p>The keyword arguments correspond to setting members of the same
name, documented below.</p>
<p class="rubric">Attributes Summary</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#astropy.io.votable.tree.Group.entries" title="astropy.io.votable.tree.Group.entries"><tt class="xref py py-obj docutils literal"><span class="pre">entries</span></tt></a></td>
<td>[read-only] A list of members of the <a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC31">GROUP</a>. This list may</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.io.votable.tree.Group.ref" title="astropy.io.votable.tree.Group.ref"><tt class="xref py py-obj docutils literal"><span class="pre">ref</span></tt></a></td>
<td>Currently ignored, as it’s not clear from the spec how this is meant to work.</td>
</tr>
</tbody>
</table>
<p class="rubric">Methods Summary</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#astropy.io.votable.tree.Group.iter_fields_and_params" title="astropy.io.votable.tree.Group.iter_fields_and_params"><tt class="xref py py-obj docutils literal"><span class="pre">iter_fields_and_params</span></tt></a>()</td>
<td>Recursively iterate over all <a class="reference internal" href="astropy.io.votable.tree.Param.html#astropy.io.votable.tree.Param" title="astropy.io.votable.tree.Param"><tt class="xref py py-class docutils literal"><span class="pre">Param</span></tt></a> elements in this <a class="reference internal" href="#astropy.io.votable.tree.Group" title="astropy.io.votable.tree.Group"><tt class="xref py py-class docutils literal"><span class="pre">Group</span></tt></a>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.io.votable.tree.Group.iter_groups" title="astropy.io.votable.tree.Group.iter_groups"><tt class="xref py py-obj docutils literal"><span class="pre">iter_groups</span></tt></a>()</td>
<td>Recursively iterate over all sub-<a class="reference internal" href="#astropy.io.votable.tree.Group" title="astropy.io.votable.tree.Group"><tt class="xref py py-class docutils literal"><span class="pre">Group</span></tt></a> instances in this <a class="reference internal" href="#astropy.io.votable.tree.Group" title="astropy.io.votable.tree.Group"><tt class="xref py py-class docutils literal"><span class="pre">Group</span></tt></a>.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.io.votable.tree.Group.parse" title="astropy.io.votable.tree.Group.parse"><tt class="xref py py-obj docutils literal"><span class="pre">parse</span></tt></a>(iterator, config)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.io.votable.tree.Group.to_xml" title="astropy.io.votable.tree.Group.to_xml"><tt class="xref py py-obj docutils literal"><span class="pre">to_xml</span></tt></a>(w, **kwargs)</td>
<td></td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes Documentation</p>
<dl class="attribute">
<dt id="astropy.io.votable.tree.Group.entries">
<tt class="descname">entries</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Group.entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Group.entries" title="Permalink to this definition">¶</a></dt>
<dd><p>[read-only] A list of members of the <a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC31">GROUP</a>. This list may
only contain objects of type <a class="reference internal" href="astropy.io.votable.tree.Param.html#astropy.io.votable.tree.Param" title="astropy.io.votable.tree.Param"><tt class="xref py py-class docutils literal"><span class="pre">Param</span></tt></a>, <a class="reference internal" href="#astropy.io.votable.tree.Group" title="astropy.io.votable.tree.Group"><tt class="xref py py-class docutils literal"><span class="pre">Group</span></tt></a>,
<a class="reference internal" href="astropy.io.votable.tree.ParamRef.html#astropy.io.votable.tree.ParamRef" title="astropy.io.votable.tree.ParamRef"><tt class="xref py py-class docutils literal"><span class="pre">ParamRef</span></tt></a> and <a class="reference internal" href="astropy.io.votable.tree.FieldRef.html#astropy.io.votable.tree.FieldRef" title="astropy.io.votable.tree.FieldRef"><tt class="xref py py-class docutils literal"><span class="pre">FieldRef</span></tt></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="astropy.io.votable.tree.Group.ref">
<tt class="descname">ref</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Group.ref"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Group.ref" title="Permalink to this definition">¶</a></dt>
<dd><p>Currently ignored, as it’s not clear from the spec how this is
meant to work.</p>
</dd></dl>
<p class="rubric">Methods Documentation</p>
<dl class="method">
<dt id="astropy.io.votable.tree.Group.iter_fields_and_params">
<tt class="descname">iter_fields_and_params</tt><big>(</big><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L1834" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Group.iter_fields_and_params"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Group.iter_fields_and_params" title="Permalink to this definition">¶</a></dt>
<dd><p>Recursively iterate over all <a class="reference internal" href="astropy.io.votable.tree.Param.html#astropy.io.votable.tree.Param" title="astropy.io.votable.tree.Param"><tt class="xref py py-class docutils literal"><span class="pre">Param</span></tt></a> elements in this
<a class="reference internal" href="#astropy.io.votable.tree.Group" title="astropy.io.votable.tree.Group"><tt class="xref py py-class docutils literal"><span class="pre">Group</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="astropy.io.votable.tree.Group.iter_groups">
<tt class="descname">iter_groups</tt><big>(</big><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L1846" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Group.iter_groups"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Group.iter_groups" title="Permalink to this definition">¶</a></dt>
<dd><p>Recursively iterate over all sub-<a class="reference internal" href="#astropy.io.votable.tree.Group" title="astropy.io.votable.tree.Group"><tt class="xref py py-class docutils literal"><span class="pre">Group</span></tt></a> instances in
this <a class="reference internal" href="#astropy.io.votable.tree.Group" title="astropy.io.votable.tree.Group"><tt class="xref py py-class docutils literal"><span class="pre">Group</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="astropy.io.votable.tree.Group.parse">
<tt class="descname">parse</tt><big>(</big><em>iterator</em>, <em>config</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L1803" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Group.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Group.parse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="astropy.io.votable.tree.Group.to_xml">
<tt class="descname">to_xml</tt><big>(</big><em>w</em>, <em>**kwargs</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L1824" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Group.to_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Group.to_xml" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Page Contents</h3>
<ul>
<li><a class="reference internal" href="#">Group</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="../_sources/_generated/astropy.io.votable.tree.Group.txt"
rel="nofollow">Page Source</a>
<a href="#">Back to Top</a></p>
<p>
© Copyright 2011-2013, The Astropy Developers.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
Last built 22 Oct 2013. <br/>
</p>
</footer>
</body>
</html>
