citizen.html
api/sleela/3.0/version-001/package/citizen.html · 1323 line(s) · html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Package citizen — SleelaDoc API</title>
<link rel="stylesheet" href="../style.css">
</head>
<body>
<header class="top">
<div class="brand"><a href="../index.html">SleelaDoc API</a></div>
<div class="tag">HTML documentation for the SLeeLa standard library (/lib)</div>
</header>
<div class="wrap">
<nav class="side">
<a href="../index.html"><strong>Home</strong></a>
<a href="../packages.html"><strong>All packages</strong></a>
<a href="../glossary.html"><strong>Glossary</strong></a>
<a href="../authorship.html"><strong>Authorship</strong></a>
<h2>Packages</h2><ul>
<li><a href="../package/alphabet.html">alphabet</a></li>
<li><a href="../package/antivirus.html">antivirus</a></li>
<li><a href="../package/api.html">api</a></li>
<li><a href="../package/audio.html">audio</a></li>
<li><a href="../package/autocad.html">autocad</a></li>
<li><a href="../package/ballum.html">ballum</a></li>
<li><a href="../package/bash.html">bash</a></li>
<li><a href="../package/boolean.html">boolean</a></li>
<li><a href="../package/cdma.html">cdma</a></li>
<li><a href="../package/character.html">character</a></li>
<li><a href="../package/churn.html">churn</a></li>
<li><a href="../package/citizen.html">citizen</a></li>
<li><a href="../package/codecs.html">codecs</a></li>
<li><a href="../package/collections.html">collections</a></li>
<li><a href="../package/common-rails.html">common-rails</a></li>
<li><a href="../package/compiler.html">compiler</a></li>
<li><a href="../package/compression.html">compression</a></li>
<li><a href="../package/config.html">config</a></li>
<li><a href="../package/connector.html">connector</a></li>
<li><a href="../package/coorenagraph.html">coorenagraph</a></li>
<li><a href="../package/core.html">core</a></li>
<li><a href="../package/cpu.html">cpu</a></li>
<li><a href="../package/crypto.html">crypto</a></li>
<li><a href="../package/data.html">data</a></li>
<li><a href="../package/data-structures.html">data-structures</a></li>
<li><a href="../package/database.html">database</a></li>
<li><a href="../package/debugger.html">debugger</a></li>
<li><a href="../package/decompiler.html">decompiler</a></li>
<li><a href="../package/deliberation.html">deliberation</a></li>
<li><a href="../package/drivers.html">drivers</a></li>
<li><a href="../package/examples.html">examples</a></li>
<li><a href="../package/filesystem.html">filesystem</a></li>
<li><a href="../package/gameplay.html">gameplay</a></li>
<li><a href="../package/gui.html">gui</a></li>
<li><a href="../package/html.html">html</a></li>
<li><a href="../package/http.html">http</a></li>
<li><a href="../package/http-1.0.html">http-1.0</a></li>
<li><a href="../package/http-2.0.html">http-2.0</a></li>
<li><a href="../package/http-3.0.html">http-3.0</a></li>
<li><a href="../package/http-4.0.html">http-4.0</a></li>
<li><a href="../package/http-5.0.html">http-5.0</a></li>
<li><a href="../package/http-6.0.html">http-6.0</a></li>
<li><a href="../package/http-7.0.html">http-7.0</a></li>
<li><a href="../package/http-8.0.html">http-8.0</a></li>
<li><a href="../package/http-9.0.html">http-9.0</a></li>
<li><a href="../package/http-servers.html">http-servers</a></li>
<li><a href="../package/ide.html">ide</a></li>
<li><a href="../package/ide-workbench.html">ide-workbench</a></li>
<li><a href="../package/idea.html">idea</a></li>
<li><a href="../package/inference-model.html">inference-model</a></li>
<li><a href="../package/inputs.html">inputs</a></li>
<li><a href="../package/international-criminal-court.html">international-criminal-court</a></li>
<li><a href="../package/io.html">io</a></li>
<li><a href="../package/java.html">java</a></li>
<li><a href="../package/java28.html">java28</a></li>
<li><a href="../package/journey.html">journey</a></li>
<li><a href="../package/languages.html">languages</a></li>
<li><a href="../package/ledger.html">ledger</a></li>
<li><a href="../package/linux-editors.html">linux-editors</a></li>
<li><a href="../package/manifesto.html">manifesto</a></li>
<li><a href="../package/math.html">math</a></li>
<li><a href="../package/memory.html">memory</a></li>
<li><a href="../package/modules.html">modules</a></li>
<li><a href="../package/moral-capacitor.html">moral-capacitor</a></li>
<li><a href="../package/munction.html">munction</a></li>
<li><a href="../package/native.html">native</a></li>
<li><a href="../package/net.html">net</a></li>
<li><a href="../package/nordshrift.html">nordshrift</a></li>
<li><a href="../package/opcodes.html">opcodes</a></li>
<li><a href="../package/operating-system.html">operating-system</a></li>
<li><a href="../package/os-level-support.html">os-level-support</a></li>
<li><a href="../package/philosophers.html">philosophers</a></li>
<li><a href="../package/philosophy.html">philosophy</a></li>
<li><a href="../package/politico.html">politico</a></li>
<li><a href="../package/process.html">process</a></li>
<li><a href="../package/psychiatry.html">psychiatry</a></li>
<li><a href="../package/public.html">public</a></li>
<li><a href="../package/reflection.html">reflection</a></li>
<li><a href="../package/regex.html">regex</a></li>
<li><a href="../package/registry.html">registry</a></li>
<li><a href="../package/rmi.html">rmi</a></li>
<li><a href="../package/runtime.html">runtime</a></li>
<li><a href="../package/security.html">security</a></li>
<li><a href="../package/server-edition.html">server-edition</a></li>
<li><a href="../package/signal-processing.html">signal-processing</a></li>
<li><a href="../package/sldocument.html">sldocument</a></li>
<li><a href="../package/sleela.html">sleela</a></li>
<li><a href="../package/sleela-sql.html">sleela-sql</a></li>
<li><a href="../package/sleela-terminal.html">sleela-terminal</a></li>
<li><a href="../package/sleeladoc.html">sleeladoc</a></li>
<li><a href="../package/social-model.html">social-model</a></li>
<li><a href="../package/sommeliers.html">sommeliers</a></li>
<li><a href="../package/spatial.html">spatial</a></li>
<li><a href="../package/sst.html">sst</a></li>
<li><a href="../package/synchro.html">synchro</a></li>
<li><a href="../package/systems.html">systems</a></li>
<li><a href="../package/telephony-skya.html">telephony-skya</a></li>
<li><a href="../package/terminal.html">terminal</a></li>
<li><a href="../package/terminal_pixel.html">terminal_pixel</a></li>
<li><a href="../package/text.html">text</a></li>
<li><a href="../package/ui.html">ui</a></li>
<li><a href="../package/us-infrastructure.html">us-infrastructure</a></li>
<li><a href="../package/user-interface.html">user-interface</a></li>
<li><a href="../package/video.html">video</a></li>
<li><a href="../package/vm.html">vm</a></li>
<li><a href="../package/web-server-technology.html">web-server-technology</a></li>
<li><a href="../package/website.html">website</a></li>
<li><a href="../package/wifi.html">wifi</a></li>
<li><a href="../package/xlt.html">xlt</a></li>
<li><a href="../package/xml.html">xml</a></li>
</ul>
</nav>
<main>
<div class="crumbs"><a href="../index.html">Home</a> › <a href="../packages.html">Packages</a> › citizen</div>
<h1>Package <code>citizen</code></h1>
<div class="lead">This package contains <strong>34</strong> source unit(s) defining <strong>34</strong> class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.</div>
<input class="search" placeholder="Filter on this page (Ctrl+F also works)…" oninput="flt(this.value)">
<h2 class="section" data-u="advertisingmodel">AdvertisingModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/AdvertisingModel.sleela)</span></h2>
<div data-u="advertisingmodel advertisingmodel">
<h3 id="AdvertisingModel">AdvertisingModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">AdvertisingModel — the audience is not the customer; the audience is the product. Revenue is impressions priced per thousand (CPM), and the only cost that matters is keeping the audience entertained enough to stay. A concrete BusinessModel: revenue = (impressions / 1000) x CPM. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>impressions</code></td><td><span class="sig">int impressions</span></td><td class="desc">ad views this month</td></tr>
<tr><td><code>cpmCents</code></td><td><span class="sig">int cpmCents</span></td><td class="desc">revenue per 1000 impressions</td></tr>
<tr><td><code>contentCostCents</code></td><td><span class="sig">int contentCostCents</span></td><td class="desc">monthly cost of making the audience show up</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int views, int cpm, int contentCost)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="bankaccount">BankAccount <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/BankAccount.sleela)</span></h2>
<div data-u="bankaccount bankaccount">
<h3 id="BankAccount">BankAccount <span class="pill">class</span></h3>
<p class="desc">Defines BankAccount, the civic-finance Master Class — the quiet place a Citizen's money goes to be anxious. It models a single banking relationship: who you bank with, the routing + account numbers that get the money there, and the balance that is somehow always lower than you expect. BankAccount is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is a sidecar owned by Citizen and carries the real banking details: a 9-digit ABA routing number (the first two digits of which the Federal Reserve uses to decide which of its twelve Districts your money reports to) and an account number. It holds balance state in whole cents to keep the pennies honest. Family: citizen. Settlement crosses an explicit bridge to the ledger and the FederalReserveID clearing fabric.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "BankAccount"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>TYPE_CHECKING</code></td><td><span class="sig">static final int TYPE_CHECKING = 0</span></td><td class="desc">Account flavors, ranked by how guilty each one makes you feel. where money passes through, briefly</td></tr>
<tr><td><code>TYPE_SAVINGS</code></td><td><span class="sig">static final int TYPE_SAVINGS = 1</span></td><td class="desc">where money goes to be forgotten</td></tr>
<tr><td><code>TYPE_CREDIT</code></td><td><span class="sig">static final int TYPE_CREDIT = 2</span></td><td class="desc">where money you don't have lives</td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isOpen</code></td><td><span class="sig">boolean isOpen</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>holder</code></td><td><span class="sig">String holder</span></td><td class="desc">whose signature is on the dotted line</td></tr>
<tr><td><code>bankName</code></td><td><span class="sig">String bankName</span></td><td class="desc">the institution with the marble lobby</td></tr>
<tr><td><code>routingNumber</code></td><td><span class="sig">String routingNumber</span></td><td class="desc">9-digit ABA number: Fed District + bank + checkdigit</td></tr>
<tr><td><code>accountNumber</code></td><td><span class="sig">String accountNumber</span></td><td class="desc">the long one you can never remember</td></tr>
<tr><td><code>type</code></td><td><span class="sig">int type</span></td><td class="desc">one of TYPE_*</td></tr>
<tr><td><code>balanceCents</code></td><td><span class="sig">int balanceCents</span></td><td class="desc">the truth, in cents</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>openFor</code></td><td><span class="sig">void openFor(String accountHolder)</span></td><td class="desc">Open an account. Comes with a free pen on a chain you cannot steal.</td></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure(String bank, String routing, String account, int acctType)</span></td><td class="desc">Point the account at a specific bank + numbers (the grown-up setup).</td></tr>
<tr><td><code>deposit</code></td><td><span class="sig">void deposit(int cents)</span></td><td class="desc">Money arrives. A rare and beautiful event.</td></tr>
<tr><td><code>withdraw</code></td><td><span class="sig">boolean withdraw(int cents)</span></td><td class="desc">Money departs. Returns false if the account politely declines.</td></tr>
<tr><td><code>close</code></td><td><span class="sig">void close()</span></td><td class="desc">Close the account. The pen is yours to keep. It was always yours.</td></tr>
<tr><td><code>open</code></td><td><span class="sig">boolean open()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>balance</code></td><td><span class="sig">int balance()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>routing</code></td><td><span class="sig">String routing()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>account</code></td><td><span class="sig">String account()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>institution</code></td><td><span class="sig">String institution()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>fedDistrict</code></td><td><span class="sig">int fedDistrict()</span></td><td class="desc">The Federal Reserve District is encoded in the first two routing digits (01..12). This is how your checking account quietly knows its home office.</td></tr>
<tr><td><code>yn</code></td><td><span class="sig">String yn(boolean b)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="brokeragemodel">BrokerageModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/BrokerageModel.sleela)</span></h2>
<div data-u="brokeragemodel brokeragemodel">
<h3 id="BrokerageModel">BrokerageModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">BrokerageModel — stand between two parties who want to trade and charge a fee per trade for the privilege of your standing there. Revenue is trades x fee; cost is the clearing/compliance machinery that keeps the regulators calm. A concrete BusinessModel. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>trades</code></td><td><span class="sig">int trades</span></td><td class="desc">trades executed this month</td></tr>
<tr><td><code>feePerTradeCents</code></td><td><span class="sig">int feePerTradeCents</span></td><td class="desc">commission per trade</td></tr>
<tr><td><code>clearingCostCents</code></td><td><span class="sig">int clearingCostCents</span></td><td class="desc">clearing/settlement cost per trade</td></tr>
<tr><td><code>complianceCents</code></td><td><span class="sig">int complianceCents</span></td><td class="desc">monthly fixed compliance overhead</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int executed, int feePerTrade, int clearingCost, int compliance)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="businessmodel">BusinessModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/BusinessModel.sleela)</span></h2>
<div data-u="businessmodel businessmodel">
<h3 id="BusinessModel">BusinessModel <span class="pill">class</span></h3>
<p class="desc">Defines BusinessModel, the language-neutral base contract a</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "BusinessModel"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_NONE</code></td><td><span class="sig">static final int KIND_NONE = 0</span></td><td class="desc">Model archetypes, so a Character can say what it is without a pitch deck.</td></tr>
<tr><td><code>KIND_SUBSCRIPTION</code></td><td><span class="sig">static final int KIND_SUBSCRIPTION = 1</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_FREEMIUM</code></td><td><span class="sig">static final int KIND_FREEMIUM = 2</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_MARKETPLACE</code></td><td><span class="sig">static final int KIND_MARKETPLACE = 3</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_ADVERTISING</code></td><td><span class="sig">static final int KIND_ADVERTISING = 4</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_RETAIL</code></td><td><span class="sig">static final int KIND_RETAIL = 5</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_WHOLESALE</code></td><td><span class="sig">static final int KIND_WHOLESALE = 6</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_FRANCHISE</code></td><td><span class="sig">static final int KIND_FRANCHISE = 7</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_LICENSING</code></td><td><span class="sig">static final int KIND_LICENSING = 8</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_SAAS</code></td><td><span class="sig">static final int KIND_SAAS = 9</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_CONSULTING</code></td><td><span class="sig">static final int KIND_CONSULTING = 10</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_MANUFACTURING</code></td><td><span class="sig">static final int KIND_MANUFACTURING = 11</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>KIND_BROKERAGE</code></td><td><span class="sig">static final int KIND_BROKERAGE = 12</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc">1 once the module is loaded</td></tr>
<tr><td><code>modelName</code></td><td><span class="sig">String modelName</span></td><td class="desc">human-readable, e.g. "Subscription"</td></tr>
<tr><td><code>kind</code></td><td><span class="sig">int kind</span></td><td class="desc">one of KIND_*</td></tr>
<tr><td><code>unitsCents</code></td><td><span class="sig">int unitsCents</span></td><td class="desc">the model's primary quantity (seats, items, listings)</td></tr>
<tr><td><code>configured</code></td><td><span class="sig">boolean configured</span></td><td class="desc">true once a subclass has declared identity</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure(String name, int modelKind)</span></td><td class="desc">A subclass calls this from its own setup to declare identity. Mirrors the declare()/configure() pattern used by the lib/compiler front ends.</td></tr>
<tr><td><code>setUnits</code></td><td><span class="sig">void setUnits(int n)</span></td><td class="desc">The model's primary driver — seats, items sold, listings, billable hours. Expressed as a plain count; subclasses decide what it means.</td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc">--- revenue hooks. Base implementations report "nothing yet"; a concrete model overrides these with its own economics. All amounts are whole cents.</td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyProfit</code></td><td><span class="sig">int monthlyProfit()</span></td><td class="desc">Profit is the same arithmetic for every model, so the base owns it and no subclass has to repeat it. This is the one honest law of business.</td></tr>
<tr><td><code>profitable</code></td><td><span class="sig">boolean profitable()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>ready</code></td><td><span class="sig">boolean ready()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>modelKind</code></td><td><span class="sig">int modelKind()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>name</code></td><td><span class="sig">String name()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>units</code></td><td><span class="sig">int units()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>yn</code></td><td><span class="sig">String yn(boolean b)</span></td><td class="desc">Render a boolean as a word so describe() concatenates only Strings/ints, matching the proven /lib describe() idiom.</td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="character">Character <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/Character.sleela)</span></h2>
<div data-u="character character">
<h3 id="Character">Character <span class="pill">class</span></h3>
<p class="desc">Defines Character, the central Master Class of the character package — a named actor in the Sleela economy who adopts exactly one BusinessModel and lives or dies by its monthly profit. A Character is classful by design: it is one class that composes any one of the many, many business-model classes in this package. Character is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It holds a BusinessModel reference typed to the base class, so it can carry a Subscription, Freemium, Marketplace, Advertising, Retail, Wholesale, Franchise, Licensing, SaaS, Consulting, Manufacturing, or Brokerage model interchangeably and ask it, each month, the only question that matters. The polymorphism follows the exact base/subclass pattern used by lib/compiler's SLLanguageCompiler front ends. It also carries a little personality — grit and reputation — because a business model is only as good as the Character running it. Family: character. Settlement crosses an explicit bridge to the ledger.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "Character"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc">1 once the module is loaded</td></tr>
<tr><td><code>name</code></td><td><span class="sig">String name</span></td><td class="desc">who this Character is</td></tr>
<tr><td><code>tagline</code></td><td><span class="sig">String tagline</span></td><td class="desc">their elevator pitch, mercifully short</td></tr>
<tr><td><code>grit</code></td><td><span class="sig">int grit</span></td><td class="desc">0..100 — how many bad months they can stomach</td></tr>
<tr><td><code>reputation</code></td><td><span class="sig">int reputation</span></td><td class="desc">0..100 — grows with profit, bruises with loss</td></tr>
<tr><td><code>cashCents</code></td><td><span class="sig">int cashCents</span></td><td class="desc">running cash on hand</td></tr>
<tr><td><code>model</code></td><td><span class="sig">BusinessModel model</span></td><td class="desc">the one model they live by (any concrete subclass)</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>introduce</code></td><td><span class="sig">void introduce(String who, String pitch, int startingGrit, int startingCash)</span></td><td class="desc">Introduce the Character and give them a little personality.</td></tr>
<tr><td><code>adopt</code></td><td><span class="sig">void adopt(BusinessModel chosen)</span></td><td class="desc">Adopt a business model. Any concrete BusinessModel subclass will do — the Character does not care which, only whether it makes money. This is the whole point of a base-typed reference holding a subclass instance.</td></tr>
<tr><td><code>hasModel</code></td><td><span class="sig">boolean hasModel()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>liveAMonth</code></td><td><span class="sig">int liveAMonth()</span></td><td class="desc">Live one month: realize the model's profit into cash and let it move the Character's reputation and grit. Returns the profit for the month.</td></tr>
<tr><td><code>runMonths</code></td><td><span class="sig">int runMonths(int months)</span></td><td class="desc">Run several months and report the total profit realized.</td></tr>
<tr><td><code>stillStanding</code></td><td><span class="sig">boolean stillStanding()</span></td><td class="desc">The question every Character secretly asks at 3am.</td></tr>
<tr><td><code>thriving</code></td><td><span class="sig">boolean thriving()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cash</code></td><td><span class="sig">int cash()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>reputationScore</code></td><td><span class="sig">int reputationScore()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>gritScore</code></td><td><span class="sig">int gritScore()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>characterName</code></td><td><span class="sig">String characterName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>modelKind</code></td><td><span class="sig">int modelKind()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>modelName</code></td><td><span class="sig">String modelName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>clamp</code></td><td><span class="sig">int clamp(int v)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>yn</code></td><td><span class="sig">String yn(boolean b)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizen">Citizen <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/Citizen.sleela)</span></h2>
<div data-u="citizen citizen">
<h3 id="Citizen">Citizen <span class="pill">class</span></h3>
<p class="desc">Defines Citizen, the civic Master Class — one honest, taxpaying, coffee-drinking person as modeled by the Republic of Sleela. A Citizen is the smallest unit of a nation that still complains about the weather. Citizen is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe) with the other /lib Master Classes, so a loader can treat it uniformly. It composes three sidecar records that it owns and keeps consistent: an Industry affiliation (what they do for a living), a BankAccount (where the money quietly leaves from), and a FederalReserveID (how the central bank pretends to know them personally). A Citizen is, famously, able. It can be born, employed, paid, taxed, retired, and — on a good day — content. It holds civic state only; the paperwork is performed by the sidecar classes in this package. The runnable orchestration example lives in citizen/sleela/CitizenDemo.sleela. Family: citizen. Civic data crosses an explicit bridge to the ledger.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "Citizen"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>STAGE_UNBORN</code></td><td><span class="sig">static final int STAGE_UNBORN = 0</span></td><td class="desc">Life stages, because every bureaucracy loves an enum it can't spell. a gleam in the census-taker's eye</td></tr>
<tr><td><code>STAGE_MINOR</code></td><td><span class="sig">static final int STAGE_MINOR = 1</span></td><td class="desc">all rights, none of the taxes</td></tr>
<tr><td><code>STAGE_WORKING</code></td><td><span class="sig">static final int STAGE_WORKING = 2</span></td><td class="desc">the golden, caffeinated years</td></tr>
<tr><td><code>STAGE_RETIRED</code></td><td><span class="sig">static final int STAGE_RETIRED = 3</span></td><td class="desc">emeritus citizen, senior discount</td></tr>
<tr><td><code>STAGE_DECEASED</code></td><td><span class="sig">static final int STAGE_DECEASED = 4</span></td><td class="desc">files one final, very late return</td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc">1 once the module is loaded</td></tr>
<tr><td><code>legalName</code></td><td><span class="sig">String legalName</span></td><td class="desc">the name on the forms nobody reads</td></tr>
<tr><td><code>nickname</code></td><td><span class="sig">String nickname</span></td><td class="desc">the name their friends actually use</td></tr>
<tr><td><code>age</code></td><td><span class="sig">int age</span></td><td class="desc">in laps around a medium yellow star</td></tr>
<tr><td><code>stage</code></td><td><span class="sig">int stage</span></td><td class="desc">one of STAGE_*</td></tr>
<tr><td><code>moodOutOf100</code></td><td><span class="sig">int moodOutOf100</span></td><td class="desc">0 = DMV queue, 100 = Friday 5pm</td></tr>
<tr><td><code>industry</code></td><td><span class="sig">Industry industry</span></td><td class="desc">what they claim at parties</td></tr>
<tr><td><code>bank</code></td><td><span class="sig">BankAccount bank</span></td><td class="desc">the sad truth of what they can afford</td></tr>
<tr><td><code>fedId</code></td><td><span class="sig">FederalReserveID fedId</span></td><td class="desc">how the central bank addresses the holiday card</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>beBorn</code></td><td><span class="sig">void beBorn(String name)</span></td><td class="desc">A citizen is born. Congratulations, you now owe the system a resume.</td></tr>
<tr><td><code>haveABirthday</code></td><td><span class="sig">void haveABirthday()</span></td><td class="desc">Time, that undefeated opponent, advances exactly one year.</td></tr>
<tr><td><code>getAJob</code></td><td><span class="sig">void getAJob(int sector, int wageCents)</span></td><td class="desc">Pick a trade. The Industry class judges you so this class doesn't have to.</td></tr>
<tr><td><code>getPaid</code></td><td><span class="sig">int getPaid()</span></td><td class="desc">Payday. The one unambiguously good day of the fortnight.</td></tr>
<tr><td><code>payTaxes</code></td><td><span class="sig">int payTaxes(int ratePercent)</span></td><td class="desc">Taxes. A citizen is, after all, defined by their relationship with Form 1040.</td></tr>
<tr><td><code>treatYourself</code></td><td><span class="sig">boolean treatYourself(int cents)</span></td><td class="desc">Spend some money on something frivolous. Highly recommended for morale.</td></tr>
<tr><td><code>retire</code></td><td><span class="sig">void retire()</span></td><td class="desc">Gracefully exit the workforce; keep the opinions.</td></tr>
<tr><td><code>passAway</code></td><td><span class="sig">void passAway()</span></td><td class="desc">The final, non-negotiable withdrawal.</td></tr>
<tr><td><code>alive</code></td><td><span class="sig">boolean alive()</span></td><td class="desc">--- queries ------------------------------------------------------------</td></tr>
<tr><td><code>employed</code></td><td><span class="sig">boolean employed()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>solvent</code></td><td><span class="sig">boolean solvent()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isAble</code></td><td><span class="sig">boolean isAble()</span></td><td class="desc">The whole point: a Citizen is able. This proves it.</td></tr>
<tr><td><code>netWorthCents</code></td><td><span class="sig">int netWorthCents()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lifeStage</code></td><td><span class="sig">int lifeStage()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>happiness</code></td><td><span class="sig">int happiness()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>name</code></td><td><span class="sig">String name()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>fedNumber</code></td><td><span class="sig">String fedNumber()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>clampMood</code></td><td><span class="sig">void clampMood()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>yn</code></td><td><span class="sig">String yn(boolean b)</span></td><td class="desc">Render a boolean as a word, so describe() concatenates only Strings/ints — the exact idiom the shipped /lib describe() methods already use.</td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizencommunityrelationshipsandcivicparticipationstats">CitizenCommunityRelationshipsAndCivicParticipationStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenCommunityRelationshipsAndCivicParticipationStats.sleela)</span></h2>
<div data-u="citizencommunityrelationshipsandcivicparticipationstats citizencommunityrelationshipsandcivicparticipationstats">
<h3 id="CitizenCommunityRelationshipsAndCivicParticipationStats">CitizenCommunityRelationshipsAndCivicParticipationStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>socialConnection</code></td><td><span class="sig">int socialConnection</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>familySupport</code></td><td><span class="sig">int familySupport</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>friendNetworkSize</code></td><td><span class="sig">int friendNetworkSize</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>communityBelonging</code></td><td><span class="sig">int communityBelonging</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>socialTrust</code></td><td><span class="sig">int socialTrust</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>institutionalTrust</code></td><td><span class="sig">int institutionalTrust</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>volunteerHoursPerMonth</code></td><td><span class="sig">int volunteerHoursPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>communityServiceHours</code></td><td><span class="sig">int communityServiceHours</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>civicParticipation</code></td><td><span class="sig">int civicParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>votingParticipation</code></td><td><span class="sig">int votingParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicMeetingParticipation</code></td><td><span class="sig">int publicMeetingParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>localOrganizationMemberships</code></td><td><span class="sig">int localOrganizationMemberships</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>charitableGivingCentsPerYear</code></td><td><span class="sig">int charitableGivingCentsPerYear</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>neighborliness</code></td><td><span class="sig">int neighborliness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>socialIsolationRisk</code></td><td><span class="sig">int socialIsolationRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>discriminationExposure</code></td><td><span class="sig">int discriminationExposure</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>inclusionAccess</code></td><td><span class="sig">int inclusionAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>culturalParticipation</code></td><td><span class="sig">int culturalParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>recreationHoursPerWeek</code></td><td><span class="sig">int recreationHoursPerWeek</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>libraryUse</code></td><td><span class="sig">int libraryUse</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicServiceSatisfaction</code></td><td><span class="sig">int publicServiceSatisfaction</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>communityContribution</code></td><td><span class="sig">int communityContribution</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizendemo">CitizenDemo <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/seem/CitizenDemo.sleela)</span></h2>
<div data-u="citizendemo citizendemo">
<h3 id="CitizenDemo">CitizenDemo <span class="pill">class</span></h3>
<p class="desc">Walks a single Citizen through a whole, slightly comic life — born, schooled, employed across the whole industry, banked, cleared through a Federal Reserve District, paid, taxed, treated, and retired — printing a describe() line at each milestone. This is the executable counterpart to the citizen Master Classes; the authoritative definitions (Citizen, Industry, BankAccount, FederalReserveID) live one level up in lib/citizen/*.sleela. Family: citizen.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>main</code></td><td><span class="sig">void main()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizendigitalaccessandsafetystats">CitizenDigitalAccessAndSafetyStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenDigitalAccessAndSafetyStats.sleela)</span></h2>
<div data-u="citizendigitalaccessandsafetystats citizendigitalaccessandsafetystats">
<h3 id="CitizenDigitalAccessAndSafetyStats">CitizenDigitalAccessAndSafetyStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>deviceAccess</code></td><td><span class="sig">int deviceAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>computerAccess</code></td><td><span class="sig">int computerAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>broadbandQuality</code></td><td><span class="sig">int broadbandQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>onlineServiceUse</code></td><td><span class="sig">int onlineServiceUse</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cybersecurityAwareness</code></td><td><span class="sig">int cybersecurityAwareness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>digitalPrivacyAwareness</code></td><td><span class="sig">int digitalPrivacyAwareness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>accessibilityTechnologyAccess</code></td><td><span class="sig">int accessibilityTechnologyAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>digitalSkills</code></td><td><span class="sig">int digitalSkills</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>digitalExclusionRisk</code></td><td><span class="sig">int digitalExclusionRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>telehealthCapability</code></td><td><span class="sig">int telehealthCapability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizeneducationandknowledgestats">CitizenEducationAndKnowledgeStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenEducationAndKnowledgeStats.sleela)</span></h2>
<div data-u="citizeneducationandknowledgestats citizeneducationandknowledgestats">
<h3 id="CitizenEducationAndKnowledgeStats">CitizenEducationAndKnowledgeStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>educationLevel</code></td><td><span class="sig">int educationLevel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>yearsOfEducation</code></td><td><span class="sig">int yearsOfEducation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>literacy</code></td><td><span class="sig">int literacy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>numeracy</code></td><td><span class="sig">int numeracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>digitalLiteracy</code></td><td><span class="sig">int digitalLiteracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>financialLiteracy</code></td><td><span class="sig">int financialLiteracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>civicLiteracy</code></td><td><span class="sig">int civicLiteracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>scientificLiteracy</code></td><td><span class="sig">int scientificLiteracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>highestQualification</code></td><td><span class="sig">int highestQualification</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>schoolAttendanceRate</code></td><td><span class="sig">int schoolAttendanceRate</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>academicPerformance</code></td><td><span class="sig">int academicPerformance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>vocationalTraining</code></td><td><span class="sig">int vocationalTraining</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>apprenticeshipProgress</code></td><td><span class="sig">int apprenticeshipProgress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>certifications</code></td><td><span class="sig">int certifications</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>skillsCount</code></td><td><span class="sig">int skillsCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>languagesSpoken</code></td><td><span class="sig">int languagesSpoken</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>readingProficiency</code></td><td><span class="sig">int readingProficiency</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>writingProficiency</code></td><td><span class="sig">int writingProficiency</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mathematicsProficiency</code></td><td><span class="sig">int mathematicsProficiency</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>researchSkill</code></td><td><span class="sig">int researchSkill</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>teachingSkill</code></td><td><span class="sig">int teachingSkill</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lifelongLearning</code></td><td><span class="sig">int lifelongLearning</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>educationDebtCents</code></td><td><span class="sig">int educationDebtCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenemploymentworkandprofessionallifestats">CitizenEmploymentWorkAndProfessionalLifeStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenEmploymentWorkAndProfessionalLifeStats.sleela)</span></h2>
<div data-u="citizenemploymentworkandprofessionallifestats citizenemploymentworkandprofessionallifestats">
<h3 id="CitizenEmploymentWorkAndProfessionalLifeStats">CitizenEmploymentWorkAndProfessionalLifeStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>employerId</code></td><td><span class="sig">string employerId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>occupationCode</code></td><td><span class="sig">string occupationCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>industryCode</code></td><td><span class="sig">string industryCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>employmentStatus</code></td><td><span class="sig">string employmentStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>employed</code></td><td><span class="sig">int employed</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>selfEmployed</code></td><td><span class="sig">int selfEmployed</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>seekingWork</code></td><td><span class="sig">int seekingWork</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>workExperienceYears</code></td><td><span class="sig">int workExperienceYears</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tenureMonths</code></td><td><span class="sig">int tenureMonths</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hoursWorkedPerWeek</code></td><td><span class="sig">int hoursWorkedPerWeek</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>contractedHoursPerWeek</code></td><td><span class="sig">int contractedHoursPerWeek</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>productivity</code></td><td><span class="sig">int productivity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>workQuality</code></td><td><span class="sig">int workQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>attendanceReliability</code></td><td><span class="sig">int attendanceReliability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>jobSatisfaction</code></td><td><span class="sig">int jobSatisfaction</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>careerProgress</code></td><td><span class="sig">int careerProgress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>leadershipAtWork</code></td><td><span class="sig">int leadershipAtWork</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>workplaceSafety</code></td><td><span class="sig">int workplaceSafety</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>remoteWorkCapability</code></td><td><span class="sig">int remoteWorkCapability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>unionMembership</code></td><td><span class="sig">int unionMembership</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>unemploymentMonths</code></td><td><span class="sig">int unemploymentMonths</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>grossIncomeCentsPerMonth</code></td><td><span class="sig">long grossIncomeCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>netIncomeCentsPerMonth</code></td><td><span class="sig">long netIncomeCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>annualIncomeCents</code></td><td><span class="sig">long annualIncomeCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>benefitsValueCentsPerMonth</code></td><td><span class="sig">long benefitsValueCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>pensionContributionCentsPerMonth</code></td><td><span class="sig">long pensionContributionCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>incomeStability</code></td><td><span class="sig">int incomeStability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>jobSecurity</code></td><td><span class="sig">int jobSecurity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>workLifeBalance</code></td><td><span class="sig">int workLifeBalance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenhousingutilitiesandhouseholdservicesstats">CitizenHousingUtilitiesAndHouseholdServicesStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenHousingUtilitiesAndHouseholdServicesStats.sleela)</span></h2>
<div data-u="citizenhousingutilitiesandhouseholdservicesstats citizenhousingutilitiesandhouseholdservicesstats">
<h3 id="CitizenHousingUtilitiesAndHouseholdServicesStats">CitizenHousingUtilitiesAndHouseholdServicesStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>housingType</code></td><td><span class="sig">string housingType</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tenureType</code></td><td><span class="sig">string tenureType</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>housingQuality</code></td><td><span class="sig">int housingQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>housingSecurity</code></td><td><span class="sig">int housingSecurity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>roomsInHome</code></td><td><span class="sig">int roomsInHome</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>peoplePerRoom</code></td><td><span class="sig">int peoplePerRoom</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>overcrowdingRisk</code></td><td><span class="sig">int overcrowdingRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>homelessnessRisk</code></td><td><span class="sig">int homelessnessRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>waterAccess</code></td><td><span class="sig">int waterAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>sanitationAccess</code></td><td><span class="sig">int sanitationAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>electricityAccess</code></td><td><span class="sig">int electricityAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>heatingAccess</code></td><td><span class="sig">int heatingAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>coolingAccess</code></td><td><span class="sig">int coolingAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>internetAccess</code></td><td><span class="sig">int internetAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>phoneAccess</code></td><td><span class="sig">int phoneAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>wasteCollectionAccess</code></td><td><span class="sig">int wasteCollectionAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicTransportAccess</code></td><td><span class="sig">int publicTransportAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>distanceToHealthcare</code></td><td><span class="sig">int distanceToHealthcare</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>distanceToSchool</code></td><td><span class="sig">int distanceToSchool</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>neighborhoodSafety</code></td><td><span class="sig">int neighborhoodSafety</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>neighborhoodQuality</code></td><td><span class="sig">int neighborhoodQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>environmentalQuality</code></td><td><span class="sig">int environmentalQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>householdEnergyUse</code></td><td><span class="sig">int householdEnergyUse</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>householdWaterUse</code></td><td><span class="sig">int householdWaterUse</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>housingAssistance</code></td><td><span class="sig">int housingAssistance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenidentityanddemographicprofilestats">CitizenIdentityAndDemographicProfileStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenIdentityAndDemographicProfileStats.sleela)</span></h2>
<div data-u="citizenidentityanddemographicprofilestats citizenidentityanddemographicprofilestats">
<h3 id="CitizenIdentityAndDemographicProfileStats">CitizenIdentityAndDemographicProfileStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>citizenId</code></td><td><span class="sig">string citizenId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>legalName</code></td><td><span class="sig">string legalName</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>preferredName</code></td><td><span class="sig">string preferredName</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>householdId</code></td><td><span class="sig">string householdId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>familyId</code></td><td><span class="sig">string familyId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>citizenshipCode</code></td><td><span class="sig">string citizenshipCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>residencyCode</code></td><td><span class="sig">string residencyCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>birthPlace</code></td><td><span class="sig">string birthPlace</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>currentAddress</code></td><td><span class="sig">string currentAddress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>postalCode</code></td><td><span class="sig">string postalCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>municipality</code></td><td><span class="sig">string municipality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>region</code></td><td><span class="sig">string region</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>countryCode</code></td><td><span class="sig">string countryCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>primaryLanguage</code></td><td><span class="sig">string primaryLanguage</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>ageYears</code></td><td><span class="sig">int ageYears</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>ageMonths</code></td><td><span class="sig">int ageMonths</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>birthYear</code></td><td><span class="sig">int birthYear</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>birthMonth</code></td><td><span class="sig">int birthMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>birthDay</code></td><td><span class="sig">int birthDay</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lifeExpectancyYears</code></td><td><span class="sig">int lifeExpectancyYears</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>householdSize</code></td><td><span class="sig">int householdSize</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dependents</code></td><td><span class="sig">int dependents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isAlive</code></td><td><span class="sig">int isAlive</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isResident</code></td><td><span class="sig">int isResident</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isCitizen</code></td><td><span class="sig">int isCitizen</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isRegisteredVoter</code></td><td><span class="sig">int isRegisteredVoter</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isEmancipated</code></td><td><span class="sig">int isEmancipated</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasDisability</code></td><td><span class="sig">int hasDisability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>accessibilityNeeds</code></td><td><span class="sig">int accessibilityNeeds</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenlegalandadministrativestandingstats">CitizenLegalAndAdministrativeStandingStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenLegalAndAdministrativeStandingStats.sleela)</span></h2>
<div data-u="citizenlegalandadministrativestandingstats citizenlegalandadministrativestandingstats">
<h3 id="CitizenLegalAndAdministrativeStandingStats">CitizenLegalAndAdministrativeStandingStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>civilStatus</code></td><td><span class="sig">string civilStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>residencyStatus</code></td><td><span class="sig">string residencyStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>voterRegistrationStatus</code></td><td><span class="sig">string voterRegistrationStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>taxAccountId</code></td><td><span class="sig">string taxAccountId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>identityVerified</code></td><td><span class="sig">int identityVerified</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addressVerified</code></td><td><span class="sig">int addressVerified</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>permitsHeld</code></td><td><span class="sig">int permitsHeld</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>licensesHeld</code></td><td><span class="sig">int licensesHeld</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>legalCaseCount</code></td><td><span class="sig">int legalCaseCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>unresolvedLegalCases</code></td><td><span class="sig">int unresolvedLegalCases</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>fineBalanceCents</code></td><td><span class="sig">int fineBalanceCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>complianceScore</code></td><td><span class="sig">int complianceScore</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>civicObligationsComplete</code></td><td><span class="sig">int civicObligationsComplete</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>juryServiceEligible</code></td><td><span class="sig">int juryServiceEligible</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>juryServiceCompleted</code></td><td><span class="sig">int juryServiceCompleted</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicRecordsConsent</code></td><td><span class="sig">int publicRecordsConsent</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>privacyPreferenceLevel</code></td><td><span class="sig">int privacyPreferenceLevel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenlifestagegoalsandpersonalstatusstats">CitizenLifeStageGoalsAndPersonalStatusStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenLifeStageGoalsAndPersonalStatusStats.sleela)</span></h2>
<div data-u="citizenlifestagegoalsandpersonalstatusstats citizenlifestagegoalsandpersonalstatusstats">
<h3 id="CitizenLifeStageGoalsAndPersonalStatusStats">CitizenLifeStageGoalsAndPersonalStatusStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>lifeSatisfaction</code></td><td><span class="sig">int lifeSatisfaction</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>happiness</code></td><td><span class="sig">int happiness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>morale</code></td><td><span class="sig">int morale</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>motivation</code></td><td><span class="sig">int motivation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>futureOutlook</code></td><td><span class="sig">int futureOutlook</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>personalGoalProgress</code></td><td><span class="sig">int personalGoalProgress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>retirementStatus</code></td><td><span class="sig">int retirementStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>caregiverStatus</code></td><td><span class="sig">int caregiverStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>parentingStatus</code></td><td><span class="sig">int parentingStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>studentStatus</code></td><td><span class="sig">int studentStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>veteranStatus</code></td><td><span class="sig">int veteranStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>newcomerStatus</code></td><td><span class="sig">int newcomerStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>displacedStatus</code></td><td><span class="sig">int displacedStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>disasterExposure</code></td><td><span class="sig">int disasterExposure</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>emergencyPreparedness</code></td><td><span class="sig">int emergencyPreparedness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>resilienceAfterCrisis</code></td><td><span class="sig">int resilienceAfterCrisis</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lastSurveyYear</code></td><td><span class="sig">int lastSurveyYear</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dataCompleteness</code></td><td><span class="sig">int dataCompleteness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dataConfidence</code></td><td><span class="sig">int dataConfidence</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenmobilitytransportandenvironmentalimpactstats">CitizenMobilityTransportAndEnvironmentalImpactStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenMobilityTransportAndEnvironmentalImpactStats.sleela)</span></h2>
<div data-u="citizenmobilitytransportandenvironmentalimpactstats citizenmobilitytransportandenvironmentalimpactstats">
<h3 id="CitizenMobilityTransportAndEnvironmentalImpactStats">CitizenMobilityTransportAndEnvironmentalImpactStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>primaryTransportMode</code></td><td><span class="sig">string primaryTransportMode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasDrivingLicense</code></td><td><span class="sig">int hasDrivingLicense</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasVehicle</code></td><td><span class="sig">int hasVehicle</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commuteMinutes</code></td><td><span class="sig">int commuteMinutes</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commuteDistanceMeters</code></td><td><span class="sig">int commuteDistanceMeters</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>walkingAbility</code></td><td><span class="sig">int walkingAbility</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cyclingAbility</code></td><td><span class="sig">int cyclingAbility</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>transitUseDaysPerWeek</code></td><td><span class="sig">int transitUseDaysPerWeek</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>transportReliability</code></td><td><span class="sig">int transportReliability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mobilityAccess</code></td><td><span class="sig">int mobilityAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>travelIndependence</code></td><td><span class="sig">int travelIndependence</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>estimatedCarbonKgPerMonth</code></td><td><span class="sig">int estimatedCarbonKgPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>energyConservation</code></td><td><span class="sig">int energyConservation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>recyclingParticipation</code></td><td><span class="sig">int recyclingParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>environmentalStewardship</code></td><td><span class="sig">int environmentalStewardship</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenpersonalfinanceandeconomicresiliencestats">CitizenPersonalFinanceAndEconomicResilienceStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenPersonalFinanceAndEconomicResilienceStats.sleela)</span></h2>
<div data-u="citizenpersonalfinanceandeconomicresiliencestats citizenpersonalfinanceandeconomicresiliencestats">
<h3 id="CitizenPersonalFinanceAndEconomicResilienceStats">CitizenPersonalFinanceAndEconomicResilienceStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>cashBalanceCents</code></td><td><span class="sig">long cashBalanceCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>bankBalanceCents</code></td><td><span class="sig">long bankBalanceCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>savingsCents</code></td><td><span class="sig">long savingsCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>investmentValueCents</code></td><td><span class="sig">long investmentValueCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>debtBalanceCents</code></td><td><span class="sig">long debtBalanceCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyDebtPaymentCents</code></td><td><span class="sig">long monthlyDebtPaymentCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyExpensesCents</code></td><td><span class="sig">long monthlyExpensesCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyHousingCostCents</code></td><td><span class="sig">long monthlyHousingCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyFoodCostCents</code></td><td><span class="sig">long monthlyFoodCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyTransportCostCents</code></td><td><span class="sig">long monthlyTransportCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyHealthcareCostCents</code></td><td><span class="sig">long monthlyHealthcareCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyUtilityCostCents</code></td><td><span class="sig">long monthlyUtilityCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>creditLimitCents</code></td><td><span class="sig">long creditLimitCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>creditScore</code></td><td><span class="sig">int creditScore</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>financialStress</code></td><td><span class="sig">int financialStress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>emergencyFundMonths</code></td><td><span class="sig">int emergencyFundMonths</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>povertyRisk</code></td><td><span class="sig">int povertyRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>foodSecurity</code></td><td><span class="sig">int foodSecurity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>economicResilience</code></td><td><span class="sig">int economicResilience</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>taxCompliance</code></td><td><span class="sig">int taxCompliance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>taxBracket</code></td><td><span class="sig">int taxBracket</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>taxRateBasisPoints</code></td><td><span class="sig">int taxRateBasisPoints</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>receivesPublicBenefits</code></td><td><span class="sig">int receivesPublicBenefits</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicBenefitsCentsPerMonth</code></td><td><span class="sig">long publicBenefitsCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>pensionEligibility</code></td><td><span class="sig">int pensionEligibility</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>retirementReadiness</code></td><td><span class="sig">int retirementReadiness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>financialDependents</code></td><td><span class="sig">int financialDependents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenpersonalityabilitiesandpersonalcapabilitiesstats">CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats.sleela)</span></h2>
<div data-u="citizenpersonalityabilitiesandpersonalcapabilitiesstats citizenpersonalityabilitiesandpersonalcapabilitiesstats">
<h3 id="CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats">CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>INT</code></td><td><span class="sig">int INT</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>CON</code></td><td><span class="sig">int CON</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>WIS</code></td><td><span class="sig">int WIS</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>CHA</code></td><td><span class="sig">int CHA</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>STR</code></td><td><span class="sig">int STR</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DEX</code></td><td><span class="sig">int DEX</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>EMP</code></td><td><span class="sig">int EMP</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>WILL</code></td><td><span class="sig">int WILL</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>LCK</code></td><td><span class="sig">int LCK</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>creativity</code></td><td><span class="sig">int creativity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>adaptability</code></td><td><span class="sig">int adaptability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>reliability</code></td><td><span class="sig">int reliability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>conscientiousness</code></td><td><span class="sig">int conscientiousness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>curiosity</code></td><td><span class="sig">int curiosity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>patience</code></td><td><span class="sig">int patience</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>emotionalStability</code></td><td><span class="sig">int emotionalStability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>conflictResolution</code></td><td><span class="sig">int conflictResolution</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>civicMindedness</code></td><td><span class="sig">int civicMindedness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>trustworthiness</code></td><td><span class="sig">int trustworthiness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>riskTolerance</code></td><td><span class="sig">int riskTolerance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>leadership</code></td><td><span class="sig">int leadership</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>teamwork</code></td><td><span class="sig">int teamwork</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>communication</code></td><td><span class="sig">int communication</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>negotiation</code></td><td><span class="sig">int negotiation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>problemSolving</code></td><td><span class="sig">int problemSolving</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenphysicalhealthanddailywellbeingstats">CitizenPhysicalHealthAndDailyWellbeingStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenPhysicalHealthAndDailyWellbeingStats.sleela)</span></h2>
<div data-u="citizenphysicalhealthanddailywellbeingstats citizenphysicalhealthanddailywellbeingstats">
<h3 id="CitizenPhysicalHealthAndDailyWellbeingStats">CitizenPhysicalHealthAndDailyWellbeingStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>healthScore</code></td><td><span class="sig">int healthScore</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>maxHealthScore</code></td><td><span class="sig">int maxHealthScore</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>fitness</code></td><td><span class="sig">int fitness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mobility</code></td><td><span class="sig">int mobility</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>vision</code></td><td><span class="sig">int vision</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hearing</code></td><td><span class="sig">int hearing</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>speech</code></td><td><span class="sig">int speech</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>nutrition</code></td><td><span class="sig">int nutrition</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hydration</code></td><td><span class="sig">int hydration</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>sleepQuality</code></td><td><span class="sig">int sleepQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>stressLevel</code></td><td><span class="sig">int stressLevel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mentalWellbeing</code></td><td><span class="sig">int mentalWellbeing</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>physicalWellbeing</code></td><td><span class="sig">int physicalWellbeing</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>chronicConditionCount</code></td><td><span class="sig">int chronicConditionCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>acuteConditionSeverity</code></td><td><span class="sig">int acuteConditionSeverity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>injurySeverity</code></td><td><span class="sig">int injurySeverity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>infectionRisk</code></td><td><span class="sig">int infectionRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>vaccinationStatus</code></td><td><span class="sig">int vaccinationStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>healthcareAccess</code></td><td><span class="sig">int healthcareAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>healthInsuranceCoverage</code></td><td><span class="sig">int healthInsuranceCoverage</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>medicationAdherence</code></td><td><span class="sig">int medicationAdherence</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>substanceRisk</code></td><td><span class="sig">int substanceRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>disabilitySupportLevel</code></td><td><span class="sig">int disabilitySupportLevel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenschemaandrulesmetadatastats">CitizenSchemaAndRulesMetadataStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/CitizenSchemaAndRulesMetadataStats.sleela)</span></h2>
<div data-u="citizenschemaandrulesmetadatastats citizenschemaandrulesmetadatastats">
<h3 id="CitizenSchemaAndRulesMetadataStats">CitizenSchemaAndRulesMetadataStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>schemaVersion</code></td><td><span class="sig">int schemaVersion</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>rulesetId</code></td><td><span class="sig">int rulesetId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="citizenstats">CitizenStats <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/seem/CitizenStats.sleela)</span></h2>
<div data-u="citizenstats citizenstats">
<h3 id="CitizenStats">CitizenStats <span class="pill">class</span></h3>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>citizenId</code></td><td><span class="sig">string citizenId</span></td><td class="desc">Identity and demographic profile</td></tr>
<tr><td><code>legalName</code></td><td><span class="sig">string legalName</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>preferredName</code></td><td><span class="sig">string preferredName</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>householdId</code></td><td><span class="sig">string householdId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>familyId</code></td><td><span class="sig">string familyId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>citizenshipCode</code></td><td><span class="sig">string citizenshipCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>residencyCode</code></td><td><span class="sig">string residencyCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>birthPlace</code></td><td><span class="sig">string birthPlace</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>currentAddress</code></td><td><span class="sig">string currentAddress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>postalCode</code></td><td><span class="sig">string postalCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>municipality</code></td><td><span class="sig">string municipality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>region</code></td><td><span class="sig">string region</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>countryCode</code></td><td><span class="sig">string countryCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>primaryLanguage</code></td><td><span class="sig">string primaryLanguage</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>ageYears</code></td><td><span class="sig">int ageYears</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>ageMonths</code></td><td><span class="sig">int ageMonths</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>birthYear</code></td><td><span class="sig">int birthYear</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>birthMonth</code></td><td><span class="sig">int birthMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>birthDay</code></td><td><span class="sig">int birthDay</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lifeExpectancyYears</code></td><td><span class="sig">int lifeExpectancyYears</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>householdSize</code></td><td><span class="sig">int householdSize</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dependents</code></td><td><span class="sig">int dependents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isAlive</code></td><td><span class="sig">int isAlive</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isResident</code></td><td><span class="sig">int isResident</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isCitizen</code></td><td><span class="sig">int isCitizen</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isRegisteredVoter</code></td><td><span class="sig">int isRegisteredVoter</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isEmancipated</code></td><td><span class="sig">int isEmancipated</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasDisability</code></td><td><span class="sig">int hasDisability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>accessibilityNeeds</code></td><td><span class="sig">int accessibilityNeeds</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>healthScore</code></td><td><span class="sig">int healthScore</span></td><td class="desc">Physical health and daily wellbeing (game-defined scales)</td></tr>
<tr><td><code>maxHealthScore</code></td><td><span class="sig">int maxHealthScore</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>fitness</code></td><td><span class="sig">int fitness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mobility</code></td><td><span class="sig">int mobility</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>vision</code></td><td><span class="sig">int vision</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hearing</code></td><td><span class="sig">int hearing</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>speech</code></td><td><span class="sig">int speech</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>nutrition</code></td><td><span class="sig">int nutrition</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hydration</code></td><td><span class="sig">int hydration</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>sleepQuality</code></td><td><span class="sig">int sleepQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>stressLevel</code></td><td><span class="sig">int stressLevel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mentalWellbeing</code></td><td><span class="sig">int mentalWellbeing</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>physicalWellbeing</code></td><td><span class="sig">int physicalWellbeing</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>chronicConditionCount</code></td><td><span class="sig">int chronicConditionCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>acuteConditionSeverity</code></td><td><span class="sig">int acuteConditionSeverity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>injurySeverity</code></td><td><span class="sig">int injurySeverity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>infectionRisk</code></td><td><span class="sig">int infectionRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>vaccinationStatus</code></td><td><span class="sig">int vaccinationStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>healthcareAccess</code></td><td><span class="sig">int healthcareAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>healthInsuranceCoverage</code></td><td><span class="sig">int healthInsuranceCoverage</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>medicationAdherence</code></td><td><span class="sig">int medicationAdherence</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>substanceRisk</code></td><td><span class="sig">int substanceRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>disabilitySupportLevel</code></td><td><span class="sig">int disabilitySupportLevel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>creativity</code></td><td><span class="sig">int creativity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>adaptability</code></td><td><span class="sig">int adaptability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>reliability</code></td><td><span class="sig">int reliability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>conscientiousness</code></td><td><span class="sig">int conscientiousness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>curiosity</code></td><td><span class="sig">int curiosity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>patience</code></td><td><span class="sig">int patience</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>emotionalStability</code></td><td><span class="sig">int emotionalStability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>conflictResolution</code></td><td><span class="sig">int conflictResolution</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>civicMindedness</code></td><td><span class="sig">int civicMindedness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>trustworthiness</code></td><td><span class="sig">int trustworthiness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>riskTolerance</code></td><td><span class="sig">int riskTolerance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>leadership</code></td><td><span class="sig">int leadership</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>teamwork</code></td><td><span class="sig">int teamwork</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>communication</code></td><td><span class="sig">int communication</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>negotiation</code></td><td><span class="sig">int negotiation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>problemSolving</code></td><td><span class="sig">int problemSolving</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>educationLevel</code></td><td><span class="sig">int educationLevel</span></td><td class="desc">Education and knowledge</td></tr>
<tr><td><code>yearsOfEducation</code></td><td><span class="sig">int yearsOfEducation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>literacy</code></td><td><span class="sig">int literacy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>numeracy</code></td><td><span class="sig">int numeracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>digitalLiteracy</code></td><td><span class="sig">int digitalLiteracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>financialLiteracy</code></td><td><span class="sig">int financialLiteracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>civicLiteracy</code></td><td><span class="sig">int civicLiteracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>scientificLiteracy</code></td><td><span class="sig">int scientificLiteracy</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>highestQualification</code></td><td><span class="sig">int highestQualification</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>schoolAttendanceRate</code></td><td><span class="sig">int schoolAttendanceRate</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>academicPerformance</code></td><td><span class="sig">int academicPerformance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>vocationalTraining</code></td><td><span class="sig">int vocationalTraining</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>apprenticeshipProgress</code></td><td><span class="sig">int apprenticeshipProgress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>certifications</code></td><td><span class="sig">int certifications</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>skillsCount</code></td><td><span class="sig">int skillsCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>languagesSpoken</code></td><td><span class="sig">int languagesSpoken</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>readingProficiency</code></td><td><span class="sig">int readingProficiency</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>writingProficiency</code></td><td><span class="sig">int writingProficiency</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mathematicsProficiency</code></td><td><span class="sig">int mathematicsProficiency</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>researchSkill</code></td><td><span class="sig">int researchSkill</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>teachingSkill</code></td><td><span class="sig">int teachingSkill</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lifelongLearning</code></td><td><span class="sig">int lifelongLearning</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>educationDebtCents</code></td><td><span class="sig">int educationDebtCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>employerId</code></td><td><span class="sig">string employerId</span></td><td class="desc">Employment, work, and professional life</td></tr>
<tr><td><code>occupationCode</code></td><td><span class="sig">string occupationCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>industryCode</code></td><td><span class="sig">string industryCode</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>employmentStatus</code></td><td><span class="sig">string employmentStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>employed</code></td><td><span class="sig">int employed</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>selfEmployed</code></td><td><span class="sig">int selfEmployed</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>seekingWork</code></td><td><span class="sig">int seekingWork</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>workExperienceYears</code></td><td><span class="sig">int workExperienceYears</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tenureMonths</code></td><td><span class="sig">int tenureMonths</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hoursWorkedPerWeek</code></td><td><span class="sig">int hoursWorkedPerWeek</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>contractedHoursPerWeek</code></td><td><span class="sig">int contractedHoursPerWeek</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>productivity</code></td><td><span class="sig">int productivity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>workQuality</code></td><td><span class="sig">int workQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>attendanceReliability</code></td><td><span class="sig">int attendanceReliability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>jobSatisfaction</code></td><td><span class="sig">int jobSatisfaction</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>careerProgress</code></td><td><span class="sig">int careerProgress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>leadershipAtWork</code></td><td><span class="sig">int leadershipAtWork</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>workplaceSafety</code></td><td><span class="sig">int workplaceSafety</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>remoteWorkCapability</code></td><td><span class="sig">int remoteWorkCapability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>unionMembership</code></td><td><span class="sig">int unionMembership</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>unemploymentMonths</code></td><td><span class="sig">int unemploymentMonths</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>grossIncomeCentsPerMonth</code></td><td><span class="sig">int grossIncomeCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>netIncomeCentsPerMonth</code></td><td><span class="sig">int netIncomeCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>annualIncomeCents</code></td><td><span class="sig">int annualIncomeCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>benefitsValueCentsPerMonth</code></td><td><span class="sig">int benefitsValueCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>pensionContributionCentsPerMonth</code></td><td><span class="sig">int pensionContributionCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>incomeStability</code></td><td><span class="sig">int incomeStability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>jobSecurity</code></td><td><span class="sig">int jobSecurity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>workLifeBalance</code></td><td><span class="sig">int workLifeBalance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cashBalanceCents</code></td><td><span class="sig">int cashBalanceCents</span></td><td class="desc">Personal finance and economic resilience</td></tr>
<tr><td><code>bankBalanceCents</code></td><td><span class="sig">int bankBalanceCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>savingsCents</code></td><td><span class="sig">int savingsCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>investmentValueCents</code></td><td><span class="sig">int investmentValueCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>debtBalanceCents</code></td><td><span class="sig">int debtBalanceCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyDebtPaymentCents</code></td><td><span class="sig">int monthlyDebtPaymentCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyExpensesCents</code></td><td><span class="sig">int monthlyExpensesCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyHousingCostCents</code></td><td><span class="sig">int monthlyHousingCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyFoodCostCents</code></td><td><span class="sig">int monthlyFoodCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyTransportCostCents</code></td><td><span class="sig">int monthlyTransportCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyHealthcareCostCents</code></td><td><span class="sig">int monthlyHealthcareCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyUtilityCostCents</code></td><td><span class="sig">int monthlyUtilityCostCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>creditLimitCents</code></td><td><span class="sig">int creditLimitCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>creditScore</code></td><td><span class="sig">int creditScore</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>financialStress</code></td><td><span class="sig">int financialStress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>emergencyFundMonths</code></td><td><span class="sig">int emergencyFundMonths</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>povertyRisk</code></td><td><span class="sig">int povertyRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>foodSecurity</code></td><td><span class="sig">int foodSecurity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>economicResilience</code></td><td><span class="sig">int economicResilience</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>taxCompliance</code></td><td><span class="sig">int taxCompliance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>taxBracket</code></td><td><span class="sig">int taxBracket</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>taxRateBasisPoints</code></td><td><span class="sig">int taxRateBasisPoints</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>receivesPublicBenefits</code></td><td><span class="sig">int receivesPublicBenefits</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicBenefitsCentsPerMonth</code></td><td><span class="sig">int publicBenefitsCentsPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>pensionEligibility</code></td><td><span class="sig">int pensionEligibility</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>retirementReadiness</code></td><td><span class="sig">int retirementReadiness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>financialDependents</code></td><td><span class="sig">int financialDependents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>housingType</code></td><td><span class="sig">string housingType</span></td><td class="desc">Housing, utilities, and household services</td></tr>
<tr><td><code>tenureType</code></td><td><span class="sig">string tenureType</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>housingQuality</code></td><td><span class="sig">int housingQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>housingSecurity</code></td><td><span class="sig">int housingSecurity</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>roomsInHome</code></td><td><span class="sig">int roomsInHome</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>peoplePerRoom</code></td><td><span class="sig">int peoplePerRoom</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>overcrowdingRisk</code></td><td><span class="sig">int overcrowdingRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>homelessnessRisk</code></td><td><span class="sig">int homelessnessRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>waterAccess</code></td><td><span class="sig">int waterAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>sanitationAccess</code></td><td><span class="sig">int sanitationAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>electricityAccess</code></td><td><span class="sig">int electricityAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>heatingAccess</code></td><td><span class="sig">int heatingAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>coolingAccess</code></td><td><span class="sig">int coolingAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>internetAccess</code></td><td><span class="sig">int internetAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>phoneAccess</code></td><td><span class="sig">int phoneAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>wasteCollectionAccess</code></td><td><span class="sig">int wasteCollectionAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicTransportAccess</code></td><td><span class="sig">int publicTransportAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>distanceToHealthcare</code></td><td><span class="sig">int distanceToHealthcare</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>distanceToSchool</code></td><td><span class="sig">int distanceToSchool</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>neighborhoodSafety</code></td><td><span class="sig">int neighborhoodSafety</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>neighborhoodQuality</code></td><td><span class="sig">int neighborhoodQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>environmentalQuality</code></td><td><span class="sig">int environmentalQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>householdEnergyUse</code></td><td><span class="sig">int householdEnergyUse</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>householdWaterUse</code></td><td><span class="sig">int householdWaterUse</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>housingAssistance</code></td><td><span class="sig">int housingAssistance</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>socialConnection</code></td><td><span class="sig">int socialConnection</span></td><td class="desc">Community, relationships, and civic participation</td></tr>
<tr><td><code>familySupport</code></td><td><span class="sig">int familySupport</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>friendNetworkSize</code></td><td><span class="sig">int friendNetworkSize</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>communityBelonging</code></td><td><span class="sig">int communityBelonging</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>socialTrust</code></td><td><span class="sig">int socialTrust</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>institutionalTrust</code></td><td><span class="sig">int institutionalTrust</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>volunteerHoursPerMonth</code></td><td><span class="sig">int volunteerHoursPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>communityServiceHours</code></td><td><span class="sig">int communityServiceHours</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>civicParticipation</code></td><td><span class="sig">int civicParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>votingParticipation</code></td><td><span class="sig">int votingParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicMeetingParticipation</code></td><td><span class="sig">int publicMeetingParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>localOrganizationMemberships</code></td><td><span class="sig">int localOrganizationMemberships</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>charitableGivingCentsPerYear</code></td><td><span class="sig">int charitableGivingCentsPerYear</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>neighborliness</code></td><td><span class="sig">int neighborliness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>socialIsolationRisk</code></td><td><span class="sig">int socialIsolationRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>discriminationExposure</code></td><td><span class="sig">int discriminationExposure</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>inclusionAccess</code></td><td><span class="sig">int inclusionAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>culturalParticipation</code></td><td><span class="sig">int culturalParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>recreationHoursPerWeek</code></td><td><span class="sig">int recreationHoursPerWeek</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>libraryUse</code></td><td><span class="sig">int libraryUse</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicServiceSatisfaction</code></td><td><span class="sig">int publicServiceSatisfaction</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>communityContribution</code></td><td><span class="sig">int communityContribution</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>civilStatus</code></td><td><span class="sig">string civilStatus</span></td><td class="desc">Legal and administrative standing</td></tr>
<tr><td><code>residencyStatus</code></td><td><span class="sig">string residencyStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>voterRegistrationStatus</code></td><td><span class="sig">string voterRegistrationStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>taxAccountId</code></td><td><span class="sig">string taxAccountId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>identityVerified</code></td><td><span class="sig">int identityVerified</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addressVerified</code></td><td><span class="sig">int addressVerified</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>permitsHeld</code></td><td><span class="sig">int permitsHeld</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>licensesHeld</code></td><td><span class="sig">int licensesHeld</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>legalCaseCount</code></td><td><span class="sig">int legalCaseCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>unresolvedLegalCases</code></td><td><span class="sig">int unresolvedLegalCases</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>fineBalanceCents</code></td><td><span class="sig">int fineBalanceCents</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>complianceScore</code></td><td><span class="sig">int complianceScore</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>civicObligationsComplete</code></td><td><span class="sig">int civicObligationsComplete</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>juryServiceEligible</code></td><td><span class="sig">int juryServiceEligible</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>juryServiceCompleted</code></td><td><span class="sig">int juryServiceCompleted</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>publicRecordsConsent</code></td><td><span class="sig">int publicRecordsConsent</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>privacyPreferenceLevel</code></td><td><span class="sig">int privacyPreferenceLevel</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>primaryTransportMode</code></td><td><span class="sig">string primaryTransportMode</span></td><td class="desc">Mobility, transport, and environmental impact</td></tr>
<tr><td><code>hasDrivingLicense</code></td><td><span class="sig">int hasDrivingLicense</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasVehicle</code></td><td><span class="sig">int hasVehicle</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commuteMinutes</code></td><td><span class="sig">int commuteMinutes</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>commuteDistanceMeters</code></td><td><span class="sig">int commuteDistanceMeters</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>walkingAbility</code></td><td><span class="sig">int walkingAbility</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cyclingAbility</code></td><td><span class="sig">int cyclingAbility</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>transitUseDaysPerWeek</code></td><td><span class="sig">int transitUseDaysPerWeek</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>transportReliability</code></td><td><span class="sig">int transportReliability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>mobilityAccess</code></td><td><span class="sig">int mobilityAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>travelIndependence</code></td><td><span class="sig">int travelIndependence</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>estimatedCarbonKgPerMonth</code></td><td><span class="sig">int estimatedCarbonKgPerMonth</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>energyConservation</code></td><td><span class="sig">int energyConservation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>recyclingParticipation</code></td><td><span class="sig">int recyclingParticipation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>environmentalStewardship</code></td><td><span class="sig">int environmentalStewardship</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>deviceAccess</code></td><td><span class="sig">int deviceAccess</span></td><td class="desc">Digital access and safety</td></tr>
<tr><td><code>computerAccess</code></td><td><span class="sig">int computerAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>broadbandQuality</code></td><td><span class="sig">int broadbandQuality</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>onlineServiceUse</code></td><td><span class="sig">int onlineServiceUse</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cybersecurityAwareness</code></td><td><span class="sig">int cybersecurityAwareness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>digitalPrivacyAwareness</code></td><td><span class="sig">int digitalPrivacyAwareness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>accessibilityTechnologyAccess</code></td><td><span class="sig">int accessibilityTechnologyAccess</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>digitalSkills</code></td><td><span class="sig">int digitalSkills</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>digitalExclusionRisk</code></td><td><span class="sig">int digitalExclusionRisk</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>telehealthCapability</code></td><td><span class="sig">int telehealthCapability</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lifeSatisfaction</code></td><td><span class="sig">int lifeSatisfaction</span></td><td class="desc">Life stage, goals, and personal status</td></tr>
<tr><td><code>happiness</code></td><td><span class="sig">int happiness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>morale</code></td><td><span class="sig">int morale</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>motivation</code></td><td><span class="sig">int motivation</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>futureOutlook</code></td><td><span class="sig">int futureOutlook</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>personalGoalProgress</code></td><td><span class="sig">int personalGoalProgress</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>retirementStatus</code></td><td><span class="sig">int retirementStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>caregiverStatus</code></td><td><span class="sig">int caregiverStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>parentingStatus</code></td><td><span class="sig">int parentingStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>studentStatus</code></td><td><span class="sig">int studentStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>veteranStatus</code></td><td><span class="sig">int veteranStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>newcomerStatus</code></td><td><span class="sig">int newcomerStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>displacedStatus</code></td><td><span class="sig">int displacedStatus</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>disasterExposure</code></td><td><span class="sig">int disasterExposure</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>emergencyPreparedness</code></td><td><span class="sig">int emergencyPreparedness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>resilienceAfterCrisis</code></td><td><span class="sig">int resilienceAfterCrisis</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lastSurveyYear</code></td><td><span class="sig">int lastSurveyYear</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dataCompleteness</code></td><td><span class="sig">int dataCompleteness</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dataConfidence</code></td><td><span class="sig">int dataConfidence</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>schemaVersion</code></td><td><span class="sig">int schemaVersion</span></td><td class="desc">Schema and rules metadata</td></tr>
<tr><td><code>rulesetId</code></td><td><span class="sig">int rulesetId</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>isAdult</code></td><td><span class="sig">int isAdult()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isWorkingAge</code></td><td><span class="sig">int isWorkingAge()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isEmployed</code></td><td><span class="sig">int isEmployed()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isFinanciallyStable</code></td><td><span class="sig">int isFinanciallyStable()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasBasicUtilities</code></td><td><span class="sig">int hasBasicUtilities()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>hasDigitalAccess</code></td><td><span class="sig">int hasDigitalAccess()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>canParticipateCivically</code></td><td><span class="sig">int canParticipateCivically()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>adjustHealth</code></td><td><span class="sig">int adjustHealth(int delta)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setAge</code></td><td><span class="sig">int setAge(int years, int months)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>normalize</code></td><td><span class="sig">int normalize()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="consultingmodel">ConsultingModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/ConsultingModel.sleela)</span></h2>
<div data-u="consultingmodel consultingmodel">
<h3 id="ConsultingModel">ConsultingModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">ConsultingModel — sell time, dressed up as insight. Revenue is billable hours x rate, bounded by the brutal truth that there are only so many hours and consultants insist on sleeping some of them. A concrete BusinessModel: revenue scales with utilization, not headcount alone; cost is the consultants' salaries whether or not they billed. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>consultants</code></td><td><span class="sig">int consultants</span></td><td class="desc">people who can bill</td></tr>
<tr><td><code>billableHours</code></td><td><span class="sig">int billableHours</span></td><td class="desc">total hours actually billed this month</td></tr>
<tr><td><code>rateCents</code></td><td><span class="sig">int rateCents</span></td><td class="desc">billing rate per hour</td></tr>
<tr><td><code>salaryPerHeadCents</code></td><td><span class="sig">int salaryPerHeadCents</span></td><td class="desc">monthly salary cost per consultant</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int heads, int hours, int rate, int salaryPerHead)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>utilizationPercent</code></td><td><span class="sig">int utilizationPercent()</span></td><td class="desc">Utilization as a percent of a nominal 160-hour month across all heads.</td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="federalreserveid">FederalReserveID <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/FederalReserveID.sleela)</span></h2>
<div data-u="federalreserveid federalreserveid">
<h3 id="FederalReserveID">FederalReserveID <span class="pill">class</span></h3>
<p class="desc">Defines FederalReserveID, the central-bank identity Master Class — the number by which the Federal Reserve pretends to know a Citizen personally. It issues and validates a civic clearing ID and maps the money to one of the twelve Federal Reserve Districts. FederalReserveID is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is a sidecar owned by Citizen and the single source of truth for Federal Reserve details in this package: the twelve District codes (01 Boston .. 12 San Francisco), the mapping from an ABA routing prefix to a District, and the issuance of a deterministic, obviously-synthetic clearing identifier. No real identifiers are generated — the central bank's holiday card list remains, mercifully, fictional. Family: citizen. Clearing crosses an explicit bridge to the ledger.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "FederalReserveID"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_BOSTON</code></td><td><span class="sig">static final int DISTRICT_BOSTON = 1</span></td><td class="desc">The twelve Federal Reserve Districts. Yes, there are exactly twelve. No, nobody remembers why Missouri got two.</td></tr>
<tr><td><code>DISTRICT_NEW_YORK</code></td><td><span class="sig">static final int DISTRICT_NEW_YORK = 2</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_PHILADELPHIA</code></td><td><span class="sig">static final int DISTRICT_PHILADELPHIA = 3</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_CLEVELAND</code></td><td><span class="sig">static final int DISTRICT_CLEVELAND = 4</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_RICHMOND</code></td><td><span class="sig">static final int DISTRICT_RICHMOND = 5</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_ATLANTA</code></td><td><span class="sig">static final int DISTRICT_ATLANTA = 6</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_CHICAGO</code></td><td><span class="sig">static final int DISTRICT_CHICAGO = 7</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_ST_LOUIS</code></td><td><span class="sig">static final int DISTRICT_ST_LOUIS = 8</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_MINNEAPOLIS</code></td><td><span class="sig">static final int DISTRICT_MINNEAPOLIS = 9</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_KANSAS_CITY</code></td><td><span class="sig">static final int DISTRICT_KANSAS_CITY = 10</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_DALLAS</code></td><td><span class="sig">static final int DISTRICT_DALLAS = 11</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_SAN_FRANCISCO</code></td><td><span class="sig">static final int DISTRICT_SAN_FRANCISCO = 12</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>DISTRICT_COUNT</code></td><td><span class="sig">static final int DISTRICT_COUNT = 12</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>issued</code></td><td><span class="sig">boolean issued</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>idNumber</code></td><td><span class="sig">String idNumber</span></td><td class="desc">synthetic clearing ID: FRS-<district>-<serial></td></tr>
<tr><td><code>district</code></td><td><span class="sig">int district</span></td><td class="desc">one of DISTRICT_*</td></tr>
<tr><td><code>serial</code></td><td><span class="sig">int serial</span></td><td class="desc">the citizen's spot in a very long, patient line</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>issue</code></td><td><span class="sig">void issue(String legalName)</span></td><td class="desc">Issue a Fed clearing ID to a named citizen. Deterministic + fake on purpose.</td></tr>
<tr><td><code>assignDistrict</code></td><td><span class="sig">void assignDistrict(int whichDistrict)</span></td><td class="desc">Re-home the citizen to a specific District (e.g. they moved to Dallas).</td></tr>
<tr><td><code>districtOfRouting</code></td><td><span class="sig">int districtOfRouting(String routing)</span></td><td class="desc">Map an ABA routing number to its Federal Reserve District. The first two digits (01..12) ARE the District; anything else is a rounding error.</td></tr>
<tr><td><code>districtName</code></td><td><span class="sig">String districtName()</span></td><td class="desc">A friendly name for the District, for forms and small talk alike.</td></tr>
<tr><td><code>valid</code></td><td><span class="sig">boolean valid()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>number</code></td><td><span class="sig">String number()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>currentDistrict</code></td><td><span class="sig">int currentDistrict()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>routingPrefix</code></td><td><span class="sig">int routingPrefix(String routing)</span></td><td class="desc">Turn the first two characters of the routing string into an int 0..99.</td></tr>
<tr><td><code>nameSerial</code></td><td><span class="sig">int nameSerial(String legalName)</span></td><td class="desc">Fold a name into a stable 6-digit serial. Not secure; delightfully not.</td></tr>
<tr><td><code>digitValue</code></td><td><span class="sig">int digitValue(String c)</span></td><td class="desc">Map a single-character String to its digit value 0..9, or -1 if not a digit.</td></tr>
<tr><td><code>charWeight</code></td><td><span class="sig">int charWeight(String c)</span></td><td class="desc">A stable per-character weight for serial folding. Digits use their value; everything else gets a constant nudge so names still spread out nicely.</td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="franchisemodel">FranchiseModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/FranchiseModel.sleela)</span></h2>
<div data-u="franchisemodel franchisemodel">
<h3 id="FranchiseModel">FranchiseModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">FranchiseModel — don't run the shops; rent out the right to BE the shop. Revenue is an ongoing royalty on each franchisee's sales plus a one-time fee amortized across the month, and the brand does the rest. A concrete BusinessModel. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>outlets</code></td><td><span class="sig">int outlets</span></td><td class="desc">franchised locations</td></tr>
<tr><td><code>avgOutletSalesCents</code></td><td><span class="sig">int avgOutletSalesCents</span></td><td class="desc">average monthly sales per outlet</td></tr>
<tr><td><code>royaltyPercent</code></td><td><span class="sig">int royaltyPercent</span></td><td class="desc">the franchisor's royalty (0..100)</td></tr>
<tr><td><code>supportCostCents</code></td><td><span class="sig">int supportCostCents</span></td><td class="desc">monthly cost to support one outlet</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int locations, int avgSales, int royalty, int supportCost)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>networkSales</code></td><td><span class="sig">int networkSales()</span></td><td class="desc">Total sales across the whole brand this month.</td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="freemiummodel">FreemiumModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/FreemiumModel.sleela)</span></h2>
<div data-u="freemiummodel freemiummodel">
<h3 id="FreemiumModel">FreemiumModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">FreemiumModel — a large crowd uses the product for free, a small fraction converts to paid, and that fraction quietly funds everyone else. The business of giving most of it away on purpose. A concrete BusinessModel: revenue comes only from the converted fraction; cost scales with the whole free-plus-paid population. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>freeUsers</code></td><td><span class="sig">int freeUsers</span></td><td class="desc">the generous majority</td></tr>
<tr><td><code>conversionPercent</code></td><td><span class="sig">int conversionPercent</span></td><td class="desc">share of free users who go paid (0..100)</td></tr>
<tr><td><code>priceCents</code></td><td><span class="sig">int priceCents</span></td><td class="desc">monthly price for a converted user</td></tr>
<tr><td><code>serveCostCents</code></td><td><span class="sig">int serveCostCents</span></td><td class="desc">cost to serve ONE user (free or paid) per month</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int free, int conversion, int price, int serveCost)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>paidUsers</code></td><td><span class="sig">int paidUsers()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>totalUsers</code></td><td><span class="sig">int totalUsers()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="industry">Industry <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/Industry.sleela)</span></h2>
<div data-u="industry industry">
<h3 id="Industry">Industry <span class="pill">class</span></h3>
<p class="desc">Defines Industry, the civic-sector Master Class — the honest living a Citizen claims to make. It models which slice of "the whole economy" a person belongs to and what that slice pays per cycle. Industry is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is a sidecar owned by Citizen: Citizen models the person; Industry models their place in the great churning machine of commerce — and whether that machine currently remembers their name. It covers the whole industry at the sector level, from the people who grow the food to the people who grow the spreadsheets. Family: citizen. Economic data crosses an explicit bridge to the ledger.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "Industry"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>SECTOR_NONE</code></td><td><span class="sig">static final int SECTOR_NONE = 0</span></td><td class="desc">The whole economy, abridged to fit on one business card. between jobs; "consulting"</td></tr>
<tr><td><code>SECTOR_AGRICULTURE</code></td><td><span class="sig">static final int SECTOR_AGRICULTURE = 1</span></td><td class="desc">feeds everyone, thanked by few</td></tr>
<tr><td><code>SECTOR_MINING</code></td><td><span class="sig">static final int SECTOR_MINING = 2</span></td><td class="desc">digs up tomorrow's shortage</td></tr>
<tr><td><code>SECTOR_MANUFACTURING</code></td><td><span class="sig">static final int SECTOR_MANUFACTURING = 3</span></td><td class="desc">makes the thing in the box</td></tr>
<tr><td><code>SECTOR_ENERGY</code></td><td><span class="sig">static final int SECTOR_ENERGY = 4</span></td><td class="desc">keeps the lights, bills on</td></tr>
<tr><td><code>SECTOR_CONSTRUCTION</code></td><td><span class="sig">static final int SECTOR_CONSTRUCTION = 5</span></td><td class="desc">runs 3 weeks over, always</td></tr>
<tr><td><code>SECTOR_RETAIL</code></td><td><span class="sig">static final int SECTOR_RETAIL = 6</span></td><td class="desc">"did you find everything okay?"</td></tr>
<tr><td><code>SECTOR_TRANSPORT</code></td><td><span class="sig">static final int SECTOR_TRANSPORT = 7</span></td><td class="desc">the box, now moving</td></tr>
<tr><td><code>SECTOR_FINANCE</code></td><td><span class="sig">static final int SECTOR_FINANCE = 8</span></td><td class="desc">moves money, keeps a slice</td></tr>
<tr><td><code>SECTOR_HEALTHCARE</code></td><td><span class="sig">static final int SECTOR_HEALTHCARE = 9</span></td><td class="desc">the only sector that bills you</td></tr>
<tr><td><code>SECTOR_EDUCATION</code></td><td><span class="sig">static final int SECTOR_EDUCATION = 10</span></td><td class="desc">for existing near it underpaid, over-caffeinated</td></tr>
<tr><td><code>SECTOR_TECHNOLOGY</code></td><td><span class="sig">static final int SECTOR_TECHNOLOGY = 11</span></td><td class="desc">"we've gone fully remote"</td></tr>
<tr><td><code>SECTOR_GOVERNMENT</code></td><td><span class="sig">static final int SECTOR_GOVERNMENT = 12</span></td><td class="desc">the sector that counts the rest</td></tr>
<tr><td><code>SECTOR_COUNT</code></td><td><span class="sig">static final int SECTOR_COUNT = 13</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>sector</code></td><td><span class="sig">int sector</span></td><td class="desc">one of SECTOR_*</td></tr>
<tr><td><code>wageCents</code></td><td><span class="sig">int wageCents</span></td><td class="desc">pay per cycle, in cents, so nobody loses a penny</td></tr>
<tr><td><code>onPayroll</code></td><td><span class="sig">boolean onPayroll</span></td><td class="desc">whether the machine currently remembers your name</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>employ</code></td><td><span class="sig">void employ(int whichSector, int cents)</span></td><td class="desc">Join the workforce in a given sector at a given wage. Welcome aboard.</td></tr>
<tr><td><code>layOff</code></td><td><span class="sig">void layOff()</span></td><td class="desc">"We're going in a different direction." Famous last words of a Friday.</td></tr>
<tr><td><code>giveRaise</code></td><td><span class="sig">void giveRaise(int cents)</span></td><td class="desc">A modest raise. The economy's rare act of kindness.</td></tr>
<tr><td><code>employed</code></td><td><span class="sig">boolean employed()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>wage</code></td><td><span class="sig">int wage()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>currentSector</code></td><td><span class="sig">int currentSector()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>sectorName</code></td><td><span class="sig">String sectorName()</span></td><td class="desc">A human-readable job title, because SECTOR_8 impresses no one at dinner.</td></tr>
<tr><td><code>yn</code></td><td><span class="sig">String yn(boolean b)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="licensingmodel">LicensingModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/LicensingModel.sleela)</span></h2>
<div data-u="licensingmodel licensingmodel">
<h3 id="LicensingModel">LicensingModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">LicensingModel — own the idea, let others do the sweating. The Character licenses intellectual property and collects a royalty per licensed unit sold by someone else, with almost no marginal cost of its own. A concrete BusinessModel: wonderfully cheap to run, entirely dependent on the licensee's hustle. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>licensedUnits</code></td><td><span class="sig">int licensedUnits</span></td><td class="desc">units the licensees sold this month</td></tr>
<tr><td><code>royaltyPerUnitCents</code></td><td><span class="sig">int royaltyPerUnitCents</span></td><td class="desc">royalty collected per licensed unit</td></tr>
<tr><td><code>ipUpkeepCents</code></td><td><span class="sig">int ipUpkeepCents</span></td><td class="desc">monthly cost to maintain/defend the IP</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int unitsLicensed, int royaltyPerUnit, int ipUpkeep)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="manufacturingmodel">ManufacturingModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/ManufacturingModel.sleela)</span></h2>
<div data-u="manufacturingmodel manufacturingmodel">
<h3 id="ManufacturingModel">ManufacturingModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">ManufacturingModel — make the physical thing at scale. Revenue is units shipped x wholesale price; cost is variable material/labor per unit plus a large, stubborn fixed cost for the factory that does not care whether the line ran today. A concrete BusinessModel: the fixed cost is the drama; volume is the cure. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>unitsProduced</code></td><td><span class="sig">int unitsProduced</span></td><td class="desc">units shipped this month</td></tr>
<tr><td><code>wholesalePriceCents</code></td><td><span class="sig">int wholesalePriceCents</span></td><td class="desc">price per unit to the buyer</td></tr>
<tr><td><code>variableCostCents</code></td><td><span class="sig">int variableCostCents</span></td><td class="desc">material + labor per unit</td></tr>
<tr><td><code>fixedPlantCents</code></td><td><span class="sig">int fixedPlantCents</span></td><td class="desc">monthly fixed factory cost (regardless of volume)</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int produced, int wholesalePrice, int variableCost, int fixedPlant)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>breakEvenUnits</code></td><td><span class="sig">int breakEvenUnits()</span></td><td class="desc">Break-even volume: units needed to cover the fixed plant cost alone.</td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="marketplacemodel">MarketplaceModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/MarketplaceModel.sleela)</span></h2>
<div data-u="marketplacemodel marketplacemodel">
<h3 id="MarketplaceModel">MarketplaceModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">MarketplaceModel — the Character owns neither the goods nor the buyers; it owns the handshake, and takes a cut of every one. Revenue is a commission on gross merchandise value (GMV). A concrete BusinessModel: revenue = GMV x take-rate; cost scales with the number of transactions it has to shepherd. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>transactions</code></td><td><span class="sig">int transactions</span></td><td class="desc">deals brokered this month</td></tr>
<tr><td><code>avgOrderCents</code></td><td><span class="sig">int avgOrderCents</span></td><td class="desc">average value of one order</td></tr>
<tr><td><code>takeRatePercent</code></td><td><span class="sig">int takeRatePercent</span></td><td class="desc">the house's cut (0..100)</td></tr>
<tr><td><code>opCostCents</code></td><td><span class="sig">int opCostCents</span></td><td class="desc">operating cost per transaction (support, fraud, etc.)</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int txns, int avgOrder, int takeRate, int opCost)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>gmv</code></td><td><span class="sig">int gmv()</span></td><td class="desc">Gross merchandise value: everything that flowed through the marketplace.</td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="retailmodel">RetailModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/RetailModel.sleela)</span></h2>
<div data-u="retailmodel retailmodel">
<h3 id="RetailModel">RetailModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">RetailModel — buy a thing, mark it up, sell it to a person who wants it today. Revenue is units x retail price; cost is units x what you paid, plus the rent on the shop with the nice window. A concrete BusinessModel. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>unitsSold</code></td><td><span class="sig">int unitsSold</span></td><td class="desc">items sold this month</td></tr>
<tr><td><code>retailPriceCents</code></td><td><span class="sig">int retailPriceCents</span></td><td class="desc">price on the shelf</td></tr>
<tr><td><code>unitCostCents</code></td><td><span class="sig">int unitCostCents</span></td><td class="desc">what the item cost to acquire</td></tr>
<tr><td><code>overheadCents</code></td><td><span class="sig">int overheadCents</span></td><td class="desc">monthly rent/staff/lights</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int sold, int retailPrice, int unitCost, int overhead)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>unitMargin</code></td><td><span class="sig">int unitMargin()</span></td><td class="desc">Margin per unit, in case anyone asks how thin it really is.</td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="saasmodel">SaaSModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/SaaSModel.sleela)</span></h2>
<div data-u="saasmodel saasmodel">
<h3 id="SaaSModel">SaaSModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">SaaSModel — software as a service, billed per seat per month, priced across tiers. Like Subscription's more ambitious cousin: seats are split across a basic and a premium tier, each at its own price, and the cloud bill scales with the whole seat count. A concrete BusinessModel. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>basicSeats</code></td><td><span class="sig">int basicSeats</span></td><td class="desc">seats on the basic tier</td></tr>
<tr><td><code>premiumSeats</code></td><td><span class="sig">int premiumSeats</span></td><td class="desc">seats on the premium tier</td></tr>
<tr><td><code>basicPriceCents</code></td><td><span class="sig">int basicPriceCents</span></td><td class="desc">monthly price per basic seat</td></tr>
<tr><td><code>premiumPriceCents</code></td><td><span class="sig">int premiumPriceCents</span></td><td class="desc">monthly price per premium seat</td></tr>
<tr><td><code>infraCostPerSeatCents</code></td><td><span class="sig">int infraCostPerSeatCents</span></td><td class="desc">cloud/infra cost per seat per month</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int basic, int premium, int basicPrice, int premiumPrice, int infraPerSeat)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>totalSeats</code></td><td><span class="sig">int totalSeats()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="slpackage">SLPackage <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/SLPackage.sleela)</span></h2>
<div data-u="slpackage slpackage">
<h3 id="SLPackage">SLPackage <span class="pill">class</span></h3>
<p class="desc">Defines the SLeeLa standard-library package for citizen.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>packageName</code></td><td><span class="sig">String packageName</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure(String name)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>name</code></td><td><span class="sig">String name()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>available</code></td><td><span class="sig">boolean available()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="subscriptionmodel">SubscriptionModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/SubscriptionModel.sleela)</span></h2>
<div data-u="subscriptionmodel subscriptionmodel">
<h3 id="SubscriptionModel">SubscriptionModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">SubscriptionModel — recurring revenue from subscribers who each pay the same price every month and leave at a steady churn rate. The classic "predictable until it isn't" business. A concrete BusinessModel: subclass, declare identity in setUp(), and override the revenue/cost hooks. Revenue is subscribers x price, minus the ones who quietly cancelled this month. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>subscribers</code></td><td><span class="sig">int subscribers</span></td><td class="desc">paying seats right now</td></tr>
<tr><td><code>priceCents</code></td><td><span class="sig">int priceCents</span></td><td class="desc">monthly price per subscriber</td></tr>
<tr><td><code>churnPercent</code></td><td><span class="sig">int churnPercent</span></td><td class="desc">share who cancel each month (0..100)</td></tr>
<tr><td><code>serviceCostCents</code></td><td><span class="sig">int serviceCostCents</span></td><td class="desc">cost to serve one subscriber per month</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int seats, int price, int churn, int serviceCost)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>retained</code></td><td><span class="sig">int retained()</span></td><td class="desc">Subscribers who are still around after this month's churn pay full price.</td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="wholesalemodel">WholesaleModel <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/citizen/character/WholesaleModel.sleela)</span></h2>
<div data-u="wholesalemodel wholesalemodel">
<h3 id="WholesaleModel">WholesaleModel <span class="pill">class</span> <span class="muted">extends <code>BusinessModel</code></span></h3>
<p class="desc">WholesaleModel — sell in bulk to the people who sell to people. Thin margin per case, enormous volume, and a loyalty to the pallet jack that borders on romantic. A concrete BusinessModel: revenue is cases x case-price; the per-case margin is slim by design. Family: character.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>cases</code></td><td><span class="sig">int cases</span></td><td class="desc">cases moved this month</td></tr>
<tr><td><code>casePriceCents</code></td><td><span class="sig">int casePriceCents</span></td><td class="desc">price per case to the retailer</td></tr>
<tr><td><code>caseCostCents</code></td><td><span class="sig">int caseCostCents</span></td><td class="desc">cost per case from the manufacturer</td></tr>
<tr><td><code>logisticsCents</code></td><td><span class="sig">int logisticsCents</span></td><td class="desc">monthly warehouse + freight overhead</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp(int casesSold, int casePrice, int caseCost, int logistics)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyRevenue</code></td><td><span class="sig">int monthlyRevenue()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>monthlyCost</code></td><td><span class="sig">int monthlyCost()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<script>function flt(q){q=q.toLowerCase();document.querySelectorAll('[data-u]').forEach(function(el){el.style.display = el.getAttribute('data-u').indexOf(q)>=0||q==''?'':'none';});}</script>
<footer>
Generated by <code>tools/generate-sleeladoc-api.py</code> from the live
<code>/lib</code> tree on 2026-11-05 06:10 UTC.
SleelaDoc — the SLeeLa documentation brand. SLeeLa — MEARVK LLC · Max Rupplin · UNCW, NCSU, Harvard · 2026 · George Soros 2507-2608.
</footer>
</main>
</div>
</body>
</html>