Group¶
-
class
astropy.io.votable.tree.
Group
[source] [edit on github]¶ Bases:
astropy.io.votable.tree.Element
,astropy.io.votable.tree._IDProperty
,astropy.io.votable.tree._NameProperty
,astropy.io.votable.tree._UtypeProperty
,astropy.io.votable.tree._UcdProperty
,astropy.io.votable.tree._DescriptionProperty
GROUP element: groups FIELD and PARAM elements.
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.
The keyword arguments correspond to setting members of the same name, documented below.
Attributes Summary
entries
[read-only] A list of members of the GROUP. This list may ref
Currently ignored, as it’s not clear from the spec how this is meant to work. Methods Summary
iter_fields_and_params
()Recursively iterate over all Param
elements in thisGroup
.iter_groups
()Recursively iterate over all sub- Group
instances in thisGroup
.parse
(iterator, config)For internal use. to_xml
(w, **kwargs)For internal use. Attributes Documentation
-
entries
¶ [read-only] A list of members of the GROUP. This list may only contain objects of type
Param
,Group
,ParamRef
andFieldRef
.
-
ref
¶ Currently ignored, as it’s not clear from the spec how this is meant to work.
Methods Documentation
-
iter_fields_and_params
()[source] [edit on github]¶
-
iter_groups
()[source] [edit on github]¶ Recursively iterate over all sub-
Group
instances in thisGroup
.
-
parse
(iterator, config)[source] [edit on github]¶ For internal use. Parse the XML content of the children of the element.
Parameters: iterator : xml iterator
An iterator over XML elements as returned by
get_xml_iterator
.config : dict
The configuration dictionary that affects how certain elements are read.
Returns: self : Element
Returns self as a convenience.
-
to_xml
(w, **kwargs)[source] [edit on github]¶ For internal use. Output the element to XML.
Parameters: w : astropy.utils.xml.writer.XMLWriter object
An XML writer to write to.
kwargs : dict
Any configuration parameters to control the output.
-