Values¶
-
class
astropy.io.votable.tree.
Values
(votable, field, ID=None, null=None, ref=None, type='legal', id=None, config=None, pos=None, **extras)[source]¶ Bases:
astropy.io.votable.tree.Element
,astropy.io.votable.tree._IDProperty
VALUES element: used within FIELD and PARAM elements to define the domain of values.
The keyword arguments correspond to setting members of the same name, documented below.
Attributes Summary
The maximum value of the domain.
When
True
, the domain includes the maximum value.The minimum value of the domain.
When
True
, the domain includes the minimum value.For integral datatypes, null is used to define the value used for missing values.
A list of string key-value tuples defining other OPTION elements for the domain.
Refer to another VALUES element by ID, defined previously in the document, for MIN/MAX/OPTION information.
[required] Defines the applicability of the domain defined by this VALUES element.
Methods Summary
from_table_column
(self, column)is_defaults
(self)Are the settings on this
VALUE
element all the same as the XML defaults?parse
(self, iterator, config)For internal use.
to_table_column
(self, column)to_xml
(self, w, **kwargs)For internal use.
Attributes Documentation
-
max
¶ The maximum value of the domain. See
max_inclusive
.
-
min
¶ The minimum value of the domain. See
min_inclusive
.
-
null
¶ For integral datatypes, null is used to define the value used for missing values.
-
options
¶ A list of string key-value tuples defining other OPTION elements for the domain. All options are ignored – they are stored for round-tripping purposes only.
-
ref
¶ Refer to another VALUES element by ID, defined previously in the document, for MIN/MAX/OPTION information.
-
type
¶ [required] Defines the applicability of the domain defined by this VALUES element. Must be one of the following strings:
‘legal’: The domain of this column applies in general to this datatype. (default)
‘actual’: The domain of this column applies only to the data enclosed in the parent table.
Methods Documentation
-
parse
(self, iterator, config)[source]¶ For internal use. Parse the XML content of the children of the element.
- Parameters
- iteratorxml iterator
An iterator over XML elements as returned by
get_xml_iterator
.- configdict
The configuration dictionary that affects how certain elements are read.
- Returns
- selfElement
Returns self as a convenience.
-