Files
kittycad.py/docs/html/_modules/kittycad/models/unit_area.html
2023-07-08 02:27:32 +00:00

148 lines
9.9 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.models.unit_area &mdash; kittycad v0.4.4 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/autoclasstoc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home">
kittycad
</a>
<div class="version">
v0.4.4
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../_autosummary/kittycad.types.html">kittycad.types</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">kittycad</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
<li class="breadcrumb-item active">kittycad.models.unit_area</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for kittycad.models.unit_area</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
<div class="viewcode-block" id="UnitArea"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.unit_area.UnitArea.html#kittycad.models.unit_area.UnitArea">[docs]</a><span class="k">class</span> <span class="nc">UnitArea</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The valid types of area units.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Acres &lt;https://en.wikipedia.org/wiki/Acre&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">ACRES</span> <span class="o">=</span> <span class="s2">&quot;acres&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Hectares &lt;https://en.wikipedia.org/wiki/Hectare&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">HECTARES</span> <span class="o">=</span> <span class="s2">&quot;hectares&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square centimetres &lt;https://en.wikipedia.org/wiki/Square_centimetre&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_CENTIMETRES</span> <span class="o">=</span> <span class="s2">&quot;square_centimetres&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square decimetres &lt;https://en.wikipedia.org/wiki/Square_decimetre&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_DECIMETRES</span> <span class="o">=</span> <span class="s2">&quot;square_decimetres&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square feet &lt;https://en.wikipedia.org/wiki/Square_foot&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_FEET</span> <span class="o">=</span> <span class="s2">&quot;square_feet&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square hectometres &lt;https://en.wikipedia.org/wiki/Square_hectometre&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_HECTOMETRES</span> <span class="o">=</span> <span class="s2">&quot;square_hectometres&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square inches &lt;https://en.wikipedia.org/wiki/Square_inch&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_INCHES</span> <span class="o">=</span> <span class="s2">&quot;square_inches&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square kilometres &lt;https://en.wikipedia.org/wiki/Square_kilometre&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_KILOMETRES</span> <span class="o">=</span> <span class="s2">&quot;square_kilometres&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square metres &lt;https://en.wikipedia.org/wiki/Square_metre&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_METRES</span> <span class="o">=</span> <span class="s2">&quot;square_metres&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square micrometres &lt;https://en.wikipedia.org/wiki/Square_micrometre&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_MICROMETRES</span> <span class="o">=</span> <span class="s2">&quot;square_micrometres&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square miles &lt;https://en.wikipedia.org/wiki/Square_mile&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_MILES</span> <span class="o">=</span> <span class="s2">&quot;square_miles&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square millimetres &lt;https://en.wikipedia.org/wiki/Square_millimetre&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_MILLIMETRES</span> <span class="o">=</span> <span class="s2">&quot;square_millimetres&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square nanometres &lt;https://en.wikipedia.org/wiki/Square_nanometre&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_NANOMETRES</span> <span class="o">=</span> <span class="s2">&quot;square_nanometres&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;# Square yards &lt;https://en.wikipedia.org/wiki/Square_mile&gt; &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">SQUARE_YARDS</span> <span class="o">=</span> <span class="s2">&quot;square_yards&quot;</span>
<div class="viewcode-block" id="UnitArea.__str__"><a class="viewcode-back" href="../../../_autosummary/kittycad.models.unit_area.UnitArea.html#kittycad.models.unit_area.UnitArea.__str__">[docs]</a> <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, KittyCAD Team Members.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>