1
2
3
|
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!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>Value types</title><meta name="generator" content="DocBook XSL Stylesheets V1.70.1" /><link rel="start" href="index.html" title="pyElemental reference" /><link rel="up" href="index.html" title="pyElemental reference" /><link rel="prev" href="value.html" title="Basic classes and data" /><link rel="next" href="properties.html" title="Categories and properties" /><link rel="copyright" href="ln-legalnotice.html" title="Legal Notice" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Value types</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="value.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="properties.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="value-types"></a>Value types</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="value-classes"></a>Value classes</h3></div></div></div><p>These value classes inherit from <code class="classname"><a href="value.html#class-value_base">value_base</a></code>:</p><div class="itemizedlist"><ul type="disc"><li><a id="class-Float"></a><code class="classname">Float</code> (<span class="type">float</span>)</li><li><a id="class-Int"></a><code class="classname">Int</code> (<span class="type">int</span>)</li><li><a id="class-String"></a><code class="classname">String</code> (<span class="type">unicode</span>—does not require translation)</li><li><a id="class-Message"></a><code class="classname">Message</code> (<span class="type">unicode</span>—requires translation)</li></ul></div><p>These value classes inherit from <code class="classname"><a href="value.html#class-color_value_base">color_value_base</a></code>:</p><div class="itemizedlist"><ul type="disc"><li><code class="classname"><a href="value-types.html#class-Series">Series</a></code></li><li><code class="classname"><a href="value-types.html#class-Block">Block</a></code></li><li><code class="classname"><a href="value-types.html#class-Phase">Phase</a></code></li><li><code class="classname"><a href="value-types.html#class-LatticeType">LatticeType</a></code></li><li><a id="class-ColorValue"></a><code class="classname">ColorValue</code> (<code class="classname"><a href="value.html#class-color">color</a></code>)</li></ul></div><p>These methods and attributes are present in each value class, where TYPE is the type held by the class, as listed above:</p><div class="variablelist"><dl><dt><span class="term"><code xmlns="" class="constructorsynopsis"><strong class="methodname">__init__</strong> ([<span class="methodparam"><span class="type">TYPE </span><var class="parameter">value</var></span>, <span class="methodparam"><span class="type">int </span><var class="parameter">qualifier</var></span>])</code></span></dt><dd><p>If <em class="parameter"><code>value</code></em> is given, <em class="parameter"><code>qualifier</code></em> defaults to <code class="varname">Q_NEUTRAL</code>. If not, <em class="parameter"><code>qualifier</code></em> defaults to <code class="varname">Q_UNK</code>.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">TYPE </span><strong class="varname">value</strong></code></span></dt><dd><p>The value, if defined.</p></dd></dl></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="value-list-classes"></a>Value list classes</h3></div></div></div><p>These value list classes inherit from <code class="classname"><a href="value.html#class-value_base">value_base</a></code>:</p><div class="itemizedlist"><ul type="disc"><li><a id="class-FloatList"></a><code class="classname">FloatList</code> (<span class="type">float</span>)</li><li><a id="class-IntList"></a><code class="classname">IntList</code> (<span class="type">int</span>)</li></ul></div><p>These methods and attributes are present in each value list class, where TYPE is the type held by the class, as listed above:</p><div class="variablelist"><dl><dt><span class="term"><code xmlns="" class="constructorsynopsis"><strong class="methodname">__init__</strong> ([<span class="methodparam"><span class="type">list(TYPE) </span><var class="parameter">values</var></span>, <span class="methodparam"><span class="type">int </span><var class="parameter">qualifier</var></span>])</code></span></dt><dd><p>If <em class="parameter"><code>values</code></em> are given, <em class="parameter"><code>qualifier</code></em> defaults to <code class="varname">Q_NEUTRAL</code>. If not, <em class="parameter"><code>qualifier</code></em> defaults to <code class="varname">Q_UNK</code>.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">list(TYPE) </span><strong class="varname">values</strong></code></span></dt><dd><p>A <span class="type">list</span> of TYPE values, if defined.</p></dd></dl></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="class-Event"></a>class <code class="classname">Event</code></h3></div></div></div><p>A qualified value representing the time and location of an event.</p><div class="variablelist"><dl><dt><span class="term"><code xmlns="" class="constructorsynopsis"><strong class="methodname">Event</strong> ([<span class="methodparam"><span class="type">int </span><var class="parameter">when</var></span>, <span class="methodparam"><span class="type">unicode </span><var class="parameter">where</var></span>, <span class="methodparam"><span class="type">int </span><var class="parameter">qualifier</var></span>])</code></span></dt><dd><p>If <em class="parameter"><code>when</code></em> and <em class="parameter"><code>where</code></em> are given, <em class="parameter"><code>qualifier</code></em> defaults to <code class="varname">Q_NEUTRAL</code>. If not, <em class="parameter"><code>qualifier</code></em> defaults to <code class="varname">Q_UNK</code>.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">int </span><strong class="varname">when</strong></code></span></dt><dd><p>The year in which the event occurred, if defined.</p></dd><dt><span class="term"><code xmlns="" class="fieldsynopsis"><span class="type">unicode </span><strong class="varname">where</strong></code></span></dt><dd><p>The place in which the event occurred, if defined.</p></dd></dl></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="class-Series"></a>class <code class="classname">Series</code></h3></div></div></div><p>A qualified value representing a chemical series. See the <a href="value-types.html#value-classes" title="Value classes">value class synopsis</a>.</p><p>These read-only <span class="type">int</span> attributes of class <code class="classname">Series</code> are the valid values of <code class="varname">Series.value</code>:</p><div class="variablelist"><table border="0"><col align="left" valign="top" /><tbody><tr><td><span class="term"><code class="varname">Series.NONMETAL</code></span></td><td>nonmetals</td></tr><tr><td><span class="term"><code class="varname">Series.NOBLE_GAS</code></span></td><td>noble gases</td></tr><tr><td><span class="term"><code class="varname">Series.ALKALI_METAL</code></span></td><td>alkali metals</td></tr><tr><td><span class="term"><code class="varname">Series.ALKALINE_EARTH_METAL</code></span></td><td>alkaline earth metals</td></tr><tr><td><span class="term"><code class="varname">Series.SEMIMETAL</code></span></td><td>semimetals</td></tr><tr><td><span class="term"><code class="varname">Series.HALOGEN</code></span></td><td>halogens</td></tr><tr><td><span class="term"><code class="varname">Series.POST_TRANSITION_METAL</code></span></td><td>post-transition metals</td></tr><tr><td><span class="term"><code class="varname">Series.TRANSITION_METAL</code></span></td><td>transition metals</td></tr><tr><td><span class="term"><code class="varname">Series.LANTHANIDE</code></span></td><td>lanthanides</td></tr><tr><td><span class="term"><code class="varname">Series.ACTINIDE</code></span></td><td>actinides</td></tr></tbody></table></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="class-Block"></a>class <code class="classname">Block</code></h3></div></div></div><p>A qualified value representing a periodic table block. See the <a href="value-types.html#value-classes" title="Value classes">value class synopsis</a>.</p><p>These read-only <span class="type">int</span> attributes of class <code class="classname">Block</code> are the valid values of <code class="varname">Block.value</code>:</p><div class="variablelist"><table border="0"><col align="left" valign="top" /><tbody><tr><td><span class="term"><code class="varname">Block.S</code></span></td><td>s-block (sharp)</td></tr><tr><td><span class="term"><code class="varname">Block.P</code></span></td><td>p-block (principal)</td></tr><tr><td><span class="term"><code class="varname">Block.D</code></span></td><td>d-block (diffuse)</td></tr><tr><td><span class="term"><code class="varname">Block.F</code></span></td><td>f-block (fundamental)</td></tr></tbody></table></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="class-Phase"></a>class <code class="classname">Phase</code></h3></div></div></div><p>A qualified value representing a phase of matter. See the <a href="value-types.html#value-classes" title="Value classes">value class synopsis</a>.</p><p>These read-only <span class="type">int</span> attributes of class <code class="classname">Phase</code> are the valid values of <code class="varname">Phase.value</code>:</p><div class="variablelist"><table border="0"><col align="left" valign="top" /><tbody><tr><td><span class="term"><code class="varname">Phase.SOLID</code></span></td><td>solid</td></tr><tr><td><span class="term"><code class="varname">Phase.LIQUID</code></span></td><td>liquid</td></tr><tr><td><span class="term"><code class="varname">Phase.GAS</code></span></td><td>gas</td></tr></tbody></table></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="class-LatticeType"></a>class <code class="classname">LatticeType</code></h3></div></div></div><p>A qualified value representing a Bravais lattice type. See the <a href="value-types.html#value-classes" title="Value classes">value class synopsis</a>.</p><p>These read-only <span class="type">int</span> attributes of class <code class="classname">LatticeType</code> are the valid values of <code class="varname">LatticeType.value</code>:</p><div class="variablelist"><table border="0"><col align="left" valign="top" /><tbody><tr><td><span class="term"><code class="varname">LatticeType.TRI</code></span></td><td>triclinic</td></tr><tr><td><span class="term"><code class="varname">LatticeType.MONO</code></span></td><td>monoclinic</td></tr><tr><td><span class="term"><code class="varname">LatticeType.ORTH</code></span></td><td>orthorhombic</td></tr><tr><td><span class="term"><code class="varname">LatticeType.TET</code></span></td><td>tetragonal</td></tr><tr><td><span class="term"><code class="varname">LatticeType.RHO</code></span></td><td>rhombohedral</td></tr><tr><td><span class="term"><code class="varname">LatticeType.HEX</code></span></td><td>hexagonal</td></tr><tr><td><span class="term"><code class="varname">LatticeType.SC</code></span></td><td>simple cubic</td></tr><tr><td><span class="term"><code class="varname">LatticeType.BCC</code></span></td><td>body-centered cubic</td></tr><tr><td><span class="term"><code class="varname">LatticeType.FCC</code></span></td><td>face-centered cubic</td></tr></tbody></table></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="value.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="properties.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Basic classes and data </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Categories and properties</td></tr></table></div></body></html>
|
