SleelaDoc API
HTML documentation for the SLeeLa standard library (/lib)
Home › Packages › citizen

Package citizen

This package contains 34 source unit(s) defining 34 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.

AdvertisingModel #sleela 2.5 (lib/citizen/character/AdvertisingModel.sleela)

AdvertisingModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
impressionsint impressionsad views this month
cpmCentsint cpmCentsrevenue per 1000 impressions
contentCostCentsint contentCostCentsmonthly cost of making the audience show up

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int views, int cpm, int contentCost)No description in source.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

BankAccount #sleela 2.5 (lib/citizen/BankAccount.sleela)

BankAccount class

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
MODULEstatic final String MODULE = "BankAccount"No description in source.
TYPE_CHECKINGstatic final int TYPE_CHECKING = 0Account flavors, ranked by how guilty each one makes you feel. where money passes through, briefly
TYPE_SAVINGSstatic final int TYPE_SAVINGS = 1where money goes to be forgotten
TYPE_CREDITstatic final int TYPE_CREDIT = 2where money you don't have lives
loadedFlagint loadedFlagNo description in source.
isOpenboolean isOpenNo description in source.
holderString holderwhose signature is on the dotted line
bankNameString bankNamethe institution with the marble lobby
routingNumberString routingNumber9-digit ABA number: Fed District + bank + checkdigit
accountNumberString accountNumberthe long one you can never remember
typeint typeone of TYPE_*
balanceCentsint balanceCentsthe truth, in cents

Methods — the actions this unit can perform.

MethodSignatureWhat it does
loadvoid load()No description in source.
loadedboolean loaded()No description in source.
moduleNameString moduleName()No description in source.
openForvoid openFor(String accountHolder)Open an account. Comes with a free pen on a chain you cannot steal.
configurevoid configure(String bank, String routing, String account, int acctType)Point the account at a specific bank + numbers (the grown-up setup).
depositvoid deposit(int cents)Money arrives. A rare and beautiful event.
withdrawboolean withdraw(int cents)Money departs. Returns false if the account politely declines.
closevoid close()Close the account. The pen is yours to keep. It was always yours.
openboolean open()No description in source.
balanceint balance()No description in source.
routingString routing()No description in source.
accountString account()No description in source.
institutionString institution()No description in source.
fedDistrictint fedDistrict()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.
ynString yn(boolean b)No description in source.
describeString describe()No description in source.

BrokerageModel #sleela 2.5 (lib/citizen/character/BrokerageModel.sleela)

BrokerageModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
tradesint tradestrades executed this month
feePerTradeCentsint feePerTradeCentscommission per trade
clearingCostCentsint clearingCostCentsclearing/settlement cost per trade
complianceCentsint complianceCentsmonthly fixed compliance overhead

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int executed, int feePerTrade, int clearingCost, int compliance)No description in source.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

BusinessModel #sleela 2.5 (lib/citizen/character/BusinessModel.sleela)

BusinessModel class

Defines BusinessModel, the language-neutral base contract a

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
MODULEstatic final String MODULE = "BusinessModel"No description in source.
KIND_NONEstatic final int KIND_NONE = 0Model archetypes, so a Character can say what it is without a pitch deck.
KIND_SUBSCRIPTIONstatic final int KIND_SUBSCRIPTION = 1No description in source.
KIND_FREEMIUMstatic final int KIND_FREEMIUM = 2No description in source.
KIND_MARKETPLACEstatic final int KIND_MARKETPLACE = 3No description in source.
KIND_ADVERTISINGstatic final int KIND_ADVERTISING = 4No description in source.
KIND_RETAILstatic final int KIND_RETAIL = 5No description in source.
KIND_WHOLESALEstatic final int KIND_WHOLESALE = 6No description in source.
KIND_FRANCHISEstatic final int KIND_FRANCHISE = 7No description in source.
KIND_LICENSINGstatic final int KIND_LICENSING = 8No description in source.
KIND_SAASstatic final int KIND_SAAS = 9No description in source.
KIND_CONSULTINGstatic final int KIND_CONSULTING = 10No description in source.
KIND_MANUFACTURINGstatic final int KIND_MANUFACTURING = 11No description in source.
KIND_BROKERAGEstatic final int KIND_BROKERAGE = 12No description in source.
loadedFlagint loadedFlag1 once the module is loaded
modelNameString modelNamehuman-readable, e.g. "Subscription"
kindint kindone of KIND_*
unitsCentsint unitsCentsthe model's primary quantity (seats, items, listings)
configuredboolean configuredtrue once a subclass has declared identity

Methods — the actions this unit can perform.

MethodSignatureWhat it does
loadvoid load()--- loadable-module contract ------------------------------------------
loadedboolean loaded()No description in source.
moduleNameString moduleName()No description in source.
configurevoid configure(String name, int modelKind)A subclass calls this from its own setup to declare identity. Mirrors the declare()/configure() pattern used by the lib/compiler front ends.
setUnitsvoid setUnits(int n)The model's primary driver — seats, items sold, listings, billable hours. Expressed as a plain count; subclasses decide what it means.
monthlyRevenueint monthlyRevenue()--- revenue hooks. Base implementations report "nothing yet"; a concrete model overrides these with its own economics. All amounts are whole cents.
monthlyCostint monthlyCost()No description in source.
monthlyProfitint monthlyProfit()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.
profitableboolean profitable()No description in source.
readyboolean ready()No description in source.
modelKindint modelKind()No description in source.
nameString name()No description in source.
unitsint units()No description in source.
ynString yn(boolean b)Render a boolean as a word so describe() concatenates only Strings/ints, matching the proven /lib describe() idiom.
describeString describe()No description in source.

Character #sleela 2.5 (lib/citizen/character/Character.sleela)

Character class

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
MODULEstatic final String MODULE = "Character"No description in source.
loadedFlagint loadedFlag1 once the module is loaded
nameString namewho this Character is
taglineString taglinetheir elevator pitch, mercifully short
gritint grit0..100 — how many bad months they can stomach
reputationint reputation0..100 — grows with profit, bruises with loss
cashCentsint cashCentsrunning cash on hand
modelBusinessModel modelthe one model they live by (any concrete subclass)

Methods — the actions this unit can perform.

MethodSignatureWhat it does
loadvoid load()--- loadable-module contract ------------------------------------------
loadedboolean loaded()No description in source.
moduleNameString moduleName()No description in source.
introducevoid introduce(String who, String pitch, int startingGrit, int startingCash)Introduce the Character and give them a little personality.
adoptvoid adopt(BusinessModel chosen)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.
hasModelboolean hasModel()No description in source.
liveAMonthint liveAMonth()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.
runMonthsint runMonths(int months)Run several months and report the total profit realized.
stillStandingboolean stillStanding()The question every Character secretly asks at 3am.
thrivingboolean thriving()No description in source.
cashint cash()No description in source.
reputationScoreint reputationScore()No description in source.
gritScoreint gritScore()No description in source.
characterNameString characterName()No description in source.
modelKindint modelKind()No description in source.
modelNameString modelName()No description in source.
clampint clamp(int v)No description in source.
ynString yn(boolean b)No description in source.
describeString describe()No description in source.

Citizen #sleela 2.5 (lib/citizen/Citizen.sleela)

Citizen class

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
MODULEstatic final String MODULE = "Citizen"No description in source.
STAGE_UNBORNstatic final int STAGE_UNBORN = 0Life stages, because every bureaucracy loves an enum it can't spell. a gleam in the census-taker's eye
STAGE_MINORstatic final int STAGE_MINOR = 1all rights, none of the taxes
STAGE_WORKINGstatic final int STAGE_WORKING = 2the golden, caffeinated years
STAGE_RETIREDstatic final int STAGE_RETIRED = 3emeritus citizen, senior discount
STAGE_DECEASEDstatic final int STAGE_DECEASED = 4files one final, very late return
loadedFlagint loadedFlag1 once the module is loaded
legalNameString legalNamethe name on the forms nobody reads
nicknameString nicknamethe name their friends actually use
ageint agein laps around a medium yellow star
stageint stageone of STAGE_*
moodOutOf100int moodOutOf1000 = DMV queue, 100 = Friday 5pm
industryIndustry industrywhat they claim at parties
bankBankAccount bankthe sad truth of what they can afford
fedIdFederalReserveID fedIdhow the central bank addresses the holiday card

Methods — the actions this unit can perform.

MethodSignatureWhat it does
loadvoid load()--- loadable-module contract ------------------------------------------
loadedboolean loaded()No description in source.
moduleNameString moduleName()No description in source.
beBornvoid beBorn(String name)A citizen is born. Congratulations, you now owe the system a resume.
haveABirthdayvoid haveABirthday()Time, that undefeated opponent, advances exactly one year.
getAJobvoid getAJob(int sector, int wageCents)Pick a trade. The Industry class judges you so this class doesn't have to.
getPaidint getPaid()Payday. The one unambiguously good day of the fortnight.
payTaxesint payTaxes(int ratePercent)Taxes. A citizen is, after all, defined by their relationship with Form 1040.
treatYourselfboolean treatYourself(int cents)Spend some money on something frivolous. Highly recommended for morale.
retirevoid retire()Gracefully exit the workforce; keep the opinions.
passAwayvoid passAway()The final, non-negotiable withdrawal.
aliveboolean alive()--- queries ------------------------------------------------------------
employedboolean employed()No description in source.
solventboolean solvent()No description in source.
isAbleboolean isAble()The whole point: a Citizen is able. This proves it.
netWorthCentsint netWorthCents()No description in source.
lifeStageint lifeStage()No description in source.
happinessint happiness()No description in source.
nameString name()No description in source.
fedNumberString fedNumber()No description in source.
clampMoodvoid clampMood()No description in source.
ynString yn(boolean b)Render a boolean as a word, so describe() concatenates only Strings/ints — the exact idiom the shipped /lib describe() methods already use.
describeString describe()No description in source.

CitizenCommunityRelationshipsAndCivicParticipationStats #sleela 2.5 (lib/citizen/CitizenCommunityRelationshipsAndCivicParticipationStats.sleela)

CitizenCommunityRelationshipsAndCivicParticipationStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
socialConnectionint socialConnectionNo description in source.
familySupportint familySupportNo description in source.
friendNetworkSizeint friendNetworkSizeNo description in source.
communityBelongingint communityBelongingNo description in source.
socialTrustint socialTrustNo description in source.
institutionalTrustint institutionalTrustNo description in source.
volunteerHoursPerMonthint volunteerHoursPerMonthNo description in source.
communityServiceHoursint communityServiceHoursNo description in source.
civicParticipationint civicParticipationNo description in source.
votingParticipationint votingParticipationNo description in source.
publicMeetingParticipationint publicMeetingParticipationNo description in source.
localOrganizationMembershipsint localOrganizationMembershipsNo description in source.
charitableGivingCentsPerYearint charitableGivingCentsPerYearNo description in source.
neighborlinessint neighborlinessNo description in source.
socialIsolationRiskint socialIsolationRiskNo description in source.
discriminationExposureint discriminationExposureNo description in source.
inclusionAccessint inclusionAccessNo description in source.
culturalParticipationint culturalParticipationNo description in source.
recreationHoursPerWeekint recreationHoursPerWeekNo description in source.
libraryUseint libraryUseNo description in source.
publicServiceSatisfactionint publicServiceSatisfactionNo description in source.
communityContributionint communityContributionNo description in source.

CitizenDemo #sleela 2.5 (lib/citizen/seem/CitizenDemo.sleela)

CitizenDemo class

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.

Carries the standard Metadata Class record — 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.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
mainvoid main()No description in source.

CitizenDigitalAccessAndSafetyStats #sleela 2.5 (lib/citizen/CitizenDigitalAccessAndSafetyStats.sleela)

CitizenDigitalAccessAndSafetyStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
deviceAccessint deviceAccessNo description in source.
computerAccessint computerAccessNo description in source.
broadbandQualityint broadbandQualityNo description in source.
onlineServiceUseint onlineServiceUseNo description in source.
cybersecurityAwarenessint cybersecurityAwarenessNo description in source.
digitalPrivacyAwarenessint digitalPrivacyAwarenessNo description in source.
accessibilityTechnologyAccessint accessibilityTechnologyAccessNo description in source.
digitalSkillsint digitalSkillsNo description in source.
digitalExclusionRiskint digitalExclusionRiskNo description in source.
telehealthCapabilityint telehealthCapabilityNo description in source.

CitizenEducationAndKnowledgeStats #sleela 2.5 (lib/citizen/CitizenEducationAndKnowledgeStats.sleela)

CitizenEducationAndKnowledgeStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
educationLevelint educationLevelNo description in source.
yearsOfEducationint yearsOfEducationNo description in source.
literacyint literacyNo description in source.
numeracyint numeracyNo description in source.
digitalLiteracyint digitalLiteracyNo description in source.
financialLiteracyint financialLiteracyNo description in source.
civicLiteracyint civicLiteracyNo description in source.
scientificLiteracyint scientificLiteracyNo description in source.
highestQualificationint highestQualificationNo description in source.
schoolAttendanceRateint schoolAttendanceRateNo description in source.
academicPerformanceint academicPerformanceNo description in source.
vocationalTrainingint vocationalTrainingNo description in source.
apprenticeshipProgressint apprenticeshipProgressNo description in source.
certificationsint certificationsNo description in source.
skillsCountint skillsCountNo description in source.
languagesSpokenint languagesSpokenNo description in source.
readingProficiencyint readingProficiencyNo description in source.
writingProficiencyint writingProficiencyNo description in source.
mathematicsProficiencyint mathematicsProficiencyNo description in source.
researchSkillint researchSkillNo description in source.
teachingSkillint teachingSkillNo description in source.
lifelongLearningint lifelongLearningNo description in source.
educationDebtCentsint educationDebtCentsNo description in source.

CitizenEmploymentWorkAndProfessionalLifeStats #sleela 2.5 (lib/citizen/CitizenEmploymentWorkAndProfessionalLifeStats.sleela)

CitizenEmploymentWorkAndProfessionalLifeStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
employerIdstring employerIdNo description in source.
occupationCodestring occupationCodeNo description in source.
industryCodestring industryCodeNo description in source.
employmentStatusstring employmentStatusNo description in source.
employedint employedNo description in source.
selfEmployedint selfEmployedNo description in source.
seekingWorkint seekingWorkNo description in source.
workExperienceYearsint workExperienceYearsNo description in source.
tenureMonthsint tenureMonthsNo description in source.
hoursWorkedPerWeekint hoursWorkedPerWeekNo description in source.
contractedHoursPerWeekint contractedHoursPerWeekNo description in source.
productivityint productivityNo description in source.
workQualityint workQualityNo description in source.
attendanceReliabilityint attendanceReliabilityNo description in source.
jobSatisfactionint jobSatisfactionNo description in source.
careerProgressint careerProgressNo description in source.
leadershipAtWorkint leadershipAtWorkNo description in source.
workplaceSafetyint workplaceSafetyNo description in source.
remoteWorkCapabilityint remoteWorkCapabilityNo description in source.
unionMembershipint unionMembershipNo description in source.
unemploymentMonthsint unemploymentMonthsNo description in source.
grossIncomeCentsPerMonthlong grossIncomeCentsPerMonthNo description in source.
netIncomeCentsPerMonthlong netIncomeCentsPerMonthNo description in source.
annualIncomeCentslong annualIncomeCentsNo description in source.
benefitsValueCentsPerMonthlong benefitsValueCentsPerMonthNo description in source.
pensionContributionCentsPerMonthlong pensionContributionCentsPerMonthNo description in source.
incomeStabilityint incomeStabilityNo description in source.
jobSecurityint jobSecurityNo description in source.
workLifeBalanceint workLifeBalanceNo description in source.

CitizenHousingUtilitiesAndHouseholdServicesStats #sleela 2.5 (lib/citizen/CitizenHousingUtilitiesAndHouseholdServicesStats.sleela)

CitizenHousingUtilitiesAndHouseholdServicesStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
housingTypestring housingTypeNo description in source.
tenureTypestring tenureTypeNo description in source.
housingQualityint housingQualityNo description in source.
housingSecurityint housingSecurityNo description in source.
roomsInHomeint roomsInHomeNo description in source.
peoplePerRoomint peoplePerRoomNo description in source.
overcrowdingRiskint overcrowdingRiskNo description in source.
homelessnessRiskint homelessnessRiskNo description in source.
waterAccessint waterAccessNo description in source.
sanitationAccessint sanitationAccessNo description in source.
electricityAccessint electricityAccessNo description in source.
heatingAccessint heatingAccessNo description in source.
coolingAccessint coolingAccessNo description in source.
internetAccessint internetAccessNo description in source.
phoneAccessint phoneAccessNo description in source.
wasteCollectionAccessint wasteCollectionAccessNo description in source.
publicTransportAccessint publicTransportAccessNo description in source.
distanceToHealthcareint distanceToHealthcareNo description in source.
distanceToSchoolint distanceToSchoolNo description in source.
neighborhoodSafetyint neighborhoodSafetyNo description in source.
neighborhoodQualityint neighborhoodQualityNo description in source.
environmentalQualityint environmentalQualityNo description in source.
householdEnergyUseint householdEnergyUseNo description in source.
householdWaterUseint householdWaterUseNo description in source.
housingAssistanceint housingAssistanceNo description in source.

CitizenIdentityAndDemographicProfileStats #sleela 2.5 (lib/citizen/CitizenIdentityAndDemographicProfileStats.sleela)

CitizenIdentityAndDemographicProfileStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
citizenIdstring citizenIdNo description in source.
legalNamestring legalNameNo description in source.
preferredNamestring preferredNameNo description in source.
householdIdstring householdIdNo description in source.
familyIdstring familyIdNo description in source.
citizenshipCodestring citizenshipCodeNo description in source.
residencyCodestring residencyCodeNo description in source.
birthPlacestring birthPlaceNo description in source.
currentAddressstring currentAddressNo description in source.
postalCodestring postalCodeNo description in source.
municipalitystring municipalityNo description in source.
regionstring regionNo description in source.
countryCodestring countryCodeNo description in source.
primaryLanguagestring primaryLanguageNo description in source.
ageYearsint ageYearsNo description in source.
ageMonthsint ageMonthsNo description in source.
birthYearint birthYearNo description in source.
birthMonthint birthMonthNo description in source.
birthDayint birthDayNo description in source.
lifeExpectancyYearsint lifeExpectancyYearsNo description in source.
householdSizeint householdSizeNo description in source.
dependentsint dependentsNo description in source.
isAliveint isAliveNo description in source.
isResidentint isResidentNo description in source.
isCitizenint isCitizenNo description in source.
isRegisteredVoterint isRegisteredVoterNo description in source.
isEmancipatedint isEmancipatedNo description in source.
hasDisabilityint hasDisabilityNo description in source.
accessibilityNeedsint accessibilityNeedsNo description in source.

CitizenLegalAndAdministrativeStandingStats #sleela 2.5 (lib/citizen/CitizenLegalAndAdministrativeStandingStats.sleela)

CitizenLegalAndAdministrativeStandingStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
civilStatusstring civilStatusNo description in source.
residencyStatusstring residencyStatusNo description in source.
voterRegistrationStatusstring voterRegistrationStatusNo description in source.
taxAccountIdstring taxAccountIdNo description in source.
identityVerifiedint identityVerifiedNo description in source.
addressVerifiedint addressVerifiedNo description in source.
permitsHeldint permitsHeldNo description in source.
licensesHeldint licensesHeldNo description in source.
legalCaseCountint legalCaseCountNo description in source.
unresolvedLegalCasesint unresolvedLegalCasesNo description in source.
fineBalanceCentsint fineBalanceCentsNo description in source.
complianceScoreint complianceScoreNo description in source.
civicObligationsCompleteint civicObligationsCompleteNo description in source.
juryServiceEligibleint juryServiceEligibleNo description in source.
juryServiceCompletedint juryServiceCompletedNo description in source.
publicRecordsConsentint publicRecordsConsentNo description in source.
privacyPreferenceLevelint privacyPreferenceLevelNo description in source.

CitizenLifeStageGoalsAndPersonalStatusStats #sleela 2.5 (lib/citizen/CitizenLifeStageGoalsAndPersonalStatusStats.sleela)

CitizenLifeStageGoalsAndPersonalStatusStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
lifeSatisfactionint lifeSatisfactionNo description in source.
happinessint happinessNo description in source.
moraleint moraleNo description in source.
motivationint motivationNo description in source.
futureOutlookint futureOutlookNo description in source.
personalGoalProgressint personalGoalProgressNo description in source.
retirementStatusint retirementStatusNo description in source.
caregiverStatusint caregiverStatusNo description in source.
parentingStatusint parentingStatusNo description in source.
studentStatusint studentStatusNo description in source.
veteranStatusint veteranStatusNo description in source.
newcomerStatusint newcomerStatusNo description in source.
displacedStatusint displacedStatusNo description in source.
disasterExposureint disasterExposureNo description in source.
emergencyPreparednessint emergencyPreparednessNo description in source.
resilienceAfterCrisisint resilienceAfterCrisisNo description in source.
lastSurveyYearint lastSurveyYearNo description in source.
dataCompletenessint dataCompletenessNo description in source.
dataConfidenceint dataConfidenceNo description in source.

CitizenMobilityTransportAndEnvironmentalImpactStats #sleela 2.5 (lib/citizen/CitizenMobilityTransportAndEnvironmentalImpactStats.sleela)

CitizenMobilityTransportAndEnvironmentalImpactStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
primaryTransportModestring primaryTransportModeNo description in source.
hasDrivingLicenseint hasDrivingLicenseNo description in source.
hasVehicleint hasVehicleNo description in source.
commuteMinutesint commuteMinutesNo description in source.
commuteDistanceMetersint commuteDistanceMetersNo description in source.
walkingAbilityint walkingAbilityNo description in source.
cyclingAbilityint cyclingAbilityNo description in source.
transitUseDaysPerWeekint transitUseDaysPerWeekNo description in source.
transportReliabilityint transportReliabilityNo description in source.
mobilityAccessint mobilityAccessNo description in source.
travelIndependenceint travelIndependenceNo description in source.
estimatedCarbonKgPerMonthint estimatedCarbonKgPerMonthNo description in source.
energyConservationint energyConservationNo description in source.
recyclingParticipationint recyclingParticipationNo description in source.
environmentalStewardshipint environmentalStewardshipNo description in source.

CitizenPersonalFinanceAndEconomicResilienceStats #sleela 2.5 (lib/citizen/CitizenPersonalFinanceAndEconomicResilienceStats.sleela)

CitizenPersonalFinanceAndEconomicResilienceStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
cashBalanceCentslong cashBalanceCentsNo description in source.
bankBalanceCentslong bankBalanceCentsNo description in source.
savingsCentslong savingsCentsNo description in source.
investmentValueCentslong investmentValueCentsNo description in source.
debtBalanceCentslong debtBalanceCentsNo description in source.
monthlyDebtPaymentCentslong monthlyDebtPaymentCentsNo description in source.
monthlyExpensesCentslong monthlyExpensesCentsNo description in source.
monthlyHousingCostCentslong monthlyHousingCostCentsNo description in source.
monthlyFoodCostCentslong monthlyFoodCostCentsNo description in source.
monthlyTransportCostCentslong monthlyTransportCostCentsNo description in source.
monthlyHealthcareCostCentslong monthlyHealthcareCostCentsNo description in source.
monthlyUtilityCostCentslong monthlyUtilityCostCentsNo description in source.
creditLimitCentslong creditLimitCentsNo description in source.
creditScoreint creditScoreNo description in source.
financialStressint financialStressNo description in source.
emergencyFundMonthsint emergencyFundMonthsNo description in source.
povertyRiskint povertyRiskNo description in source.
foodSecurityint foodSecurityNo description in source.
economicResilienceint economicResilienceNo description in source.
taxComplianceint taxComplianceNo description in source.
taxBracketint taxBracketNo description in source.
taxRateBasisPointsint taxRateBasisPointsNo description in source.
receivesPublicBenefitsint receivesPublicBenefitsNo description in source.
publicBenefitsCentsPerMonthlong publicBenefitsCentsPerMonthNo description in source.
pensionEligibilityint pensionEligibilityNo description in source.
retirementReadinessint retirementReadinessNo description in source.
financialDependentsint financialDependentsNo description in source.

CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats #sleela 2.5 (lib/citizen/CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats.sleela)

CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
INTint INTNo description in source.
CONint CONNo description in source.
WISint WISNo description in source.
CHAint CHANo description in source.
STRint STRNo description in source.
DEXint DEXNo description in source.
EMPint EMPNo description in source.
WILLint WILLNo description in source.
LCKint LCKNo description in source.
creativityint creativityNo description in source.
adaptabilityint adaptabilityNo description in source.
reliabilityint reliabilityNo description in source.
conscientiousnessint conscientiousnessNo description in source.
curiosityint curiosityNo description in source.
patienceint patienceNo description in source.
emotionalStabilityint emotionalStabilityNo description in source.
conflictResolutionint conflictResolutionNo description in source.
civicMindednessint civicMindednessNo description in source.
trustworthinessint trustworthinessNo description in source.
riskToleranceint riskToleranceNo description in source.
leadershipint leadershipNo description in source.
teamworkint teamworkNo description in source.
communicationint communicationNo description in source.
negotiationint negotiationNo description in source.
problemSolvingint problemSolvingNo description in source.

CitizenPhysicalHealthAndDailyWellbeingStats #sleela 2.5 (lib/citizen/CitizenPhysicalHealthAndDailyWellbeingStats.sleela)

CitizenPhysicalHealthAndDailyWellbeingStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
healthScoreint healthScoreNo description in source.
maxHealthScoreint maxHealthScoreNo description in source.
fitnessint fitnessNo description in source.
mobilityint mobilityNo description in source.
visionint visionNo description in source.
hearingint hearingNo description in source.
speechint speechNo description in source.
nutritionint nutritionNo description in source.
hydrationint hydrationNo description in source.
sleepQualityint sleepQualityNo description in source.
stressLevelint stressLevelNo description in source.
mentalWellbeingint mentalWellbeingNo description in source.
physicalWellbeingint physicalWellbeingNo description in source.
chronicConditionCountint chronicConditionCountNo description in source.
acuteConditionSeverityint acuteConditionSeverityNo description in source.
injurySeverityint injurySeverityNo description in source.
infectionRiskint infectionRiskNo description in source.
vaccinationStatusint vaccinationStatusNo description in source.
healthcareAccessint healthcareAccessNo description in source.
healthInsuranceCoverageint healthInsuranceCoverageNo description in source.
medicationAdherenceint medicationAdherenceNo description in source.
substanceRiskint substanceRiskNo description in source.
disabilitySupportLevelint disabilitySupportLevelNo description in source.

CitizenSchemaAndRulesMetadataStats #sleela 2.5 (lib/citizen/CitizenSchemaAndRulesMetadataStats.sleela)

CitizenSchemaAndRulesMetadataStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
schemaVersionint schemaVersionNo description in source.
rulesetIdint rulesetIdNo description in source.

CitizenStats #sleela 2.5 (lib/citizen/seem/CitizenStats.sleela)

CitizenStats class

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
citizenIdstring citizenIdIdentity and demographic profile
legalNamestring legalNameNo description in source.
preferredNamestring preferredNameNo description in source.
householdIdstring householdIdNo description in source.
familyIdstring familyIdNo description in source.
citizenshipCodestring citizenshipCodeNo description in source.
residencyCodestring residencyCodeNo description in source.
birthPlacestring birthPlaceNo description in source.
currentAddressstring currentAddressNo description in source.
postalCodestring postalCodeNo description in source.
municipalitystring municipalityNo description in source.
regionstring regionNo description in source.
countryCodestring countryCodeNo description in source.
primaryLanguagestring primaryLanguageNo description in source.
ageYearsint ageYearsNo description in source.
ageMonthsint ageMonthsNo description in source.
birthYearint birthYearNo description in source.
birthMonthint birthMonthNo description in source.
birthDayint birthDayNo description in source.
lifeExpectancyYearsint lifeExpectancyYearsNo description in source.
householdSizeint householdSizeNo description in source.
dependentsint dependentsNo description in source.
isAliveint isAliveNo description in source.
isResidentint isResidentNo description in source.
isCitizenint isCitizenNo description in source.
isRegisteredVoterint isRegisteredVoterNo description in source.
isEmancipatedint isEmancipatedNo description in source.
hasDisabilityint hasDisabilityNo description in source.
accessibilityNeedsint accessibilityNeedsNo description in source.
healthScoreint healthScorePhysical health and daily wellbeing (game-defined scales)
maxHealthScoreint maxHealthScoreNo description in source.
fitnessint fitnessNo description in source.
mobilityint mobilityNo description in source.
visionint visionNo description in source.
hearingint hearingNo description in source.
speechint speechNo description in source.
nutritionint nutritionNo description in source.
hydrationint hydrationNo description in source.
sleepQualityint sleepQualityNo description in source.
stressLevelint stressLevelNo description in source.
mentalWellbeingint mentalWellbeingNo description in source.
physicalWellbeingint physicalWellbeingNo description in source.
chronicConditionCountint chronicConditionCountNo description in source.
acuteConditionSeverityint acuteConditionSeverityNo description in source.
injurySeverityint injurySeverityNo description in source.
infectionRiskint infectionRiskNo description in source.
vaccinationStatusint vaccinationStatusNo description in source.
healthcareAccessint healthcareAccessNo description in source.
healthInsuranceCoverageint healthInsuranceCoverageNo description in source.
medicationAdherenceint medicationAdherenceNo description in source.
substanceRiskint substanceRiskNo description in source.
disabilitySupportLevelint disabilitySupportLevelNo description in source.
creativityint creativityNo description in source.
adaptabilityint adaptabilityNo description in source.
reliabilityint reliabilityNo description in source.
conscientiousnessint conscientiousnessNo description in source.
curiosityint curiosityNo description in source.
patienceint patienceNo description in source.
emotionalStabilityint emotionalStabilityNo description in source.
conflictResolutionint conflictResolutionNo description in source.
civicMindednessint civicMindednessNo description in source.
trustworthinessint trustworthinessNo description in source.
riskToleranceint riskToleranceNo description in source.
leadershipint leadershipNo description in source.
teamworkint teamworkNo description in source.
communicationint communicationNo description in source.
negotiationint negotiationNo description in source.
problemSolvingint problemSolvingNo description in source.
educationLevelint educationLevelEducation and knowledge
yearsOfEducationint yearsOfEducationNo description in source.
literacyint literacyNo description in source.
numeracyint numeracyNo description in source.
digitalLiteracyint digitalLiteracyNo description in source.
financialLiteracyint financialLiteracyNo description in source.
civicLiteracyint civicLiteracyNo description in source.
scientificLiteracyint scientificLiteracyNo description in source.
highestQualificationint highestQualificationNo description in source.
schoolAttendanceRateint schoolAttendanceRateNo description in source.
academicPerformanceint academicPerformanceNo description in source.
vocationalTrainingint vocationalTrainingNo description in source.
apprenticeshipProgressint apprenticeshipProgressNo description in source.
certificationsint certificationsNo description in source.
skillsCountint skillsCountNo description in source.
languagesSpokenint languagesSpokenNo description in source.
readingProficiencyint readingProficiencyNo description in source.
writingProficiencyint writingProficiencyNo description in source.
mathematicsProficiencyint mathematicsProficiencyNo description in source.
researchSkillint researchSkillNo description in source.
teachingSkillint teachingSkillNo description in source.
lifelongLearningint lifelongLearningNo description in source.
educationDebtCentsint educationDebtCentsNo description in source.
employerIdstring employerIdEmployment, work, and professional life
occupationCodestring occupationCodeNo description in source.
industryCodestring industryCodeNo description in source.
employmentStatusstring employmentStatusNo description in source.
employedint employedNo description in source.
selfEmployedint selfEmployedNo description in source.
seekingWorkint seekingWorkNo description in source.
workExperienceYearsint workExperienceYearsNo description in source.
tenureMonthsint tenureMonthsNo description in source.
hoursWorkedPerWeekint hoursWorkedPerWeekNo description in source.
contractedHoursPerWeekint contractedHoursPerWeekNo description in source.
productivityint productivityNo description in source.
workQualityint workQualityNo description in source.
attendanceReliabilityint attendanceReliabilityNo description in source.
jobSatisfactionint jobSatisfactionNo description in source.
careerProgressint careerProgressNo description in source.
leadershipAtWorkint leadershipAtWorkNo description in source.
workplaceSafetyint workplaceSafetyNo description in source.
remoteWorkCapabilityint remoteWorkCapabilityNo description in source.
unionMembershipint unionMembershipNo description in source.
unemploymentMonthsint unemploymentMonthsNo description in source.
grossIncomeCentsPerMonthint grossIncomeCentsPerMonthNo description in source.
netIncomeCentsPerMonthint netIncomeCentsPerMonthNo description in source.
annualIncomeCentsint annualIncomeCentsNo description in source.
benefitsValueCentsPerMonthint benefitsValueCentsPerMonthNo description in source.
pensionContributionCentsPerMonthint pensionContributionCentsPerMonthNo description in source.
incomeStabilityint incomeStabilityNo description in source.
jobSecurityint jobSecurityNo description in source.
workLifeBalanceint workLifeBalanceNo description in source.
cashBalanceCentsint cashBalanceCentsPersonal finance and economic resilience
bankBalanceCentsint bankBalanceCentsNo description in source.
savingsCentsint savingsCentsNo description in source.
investmentValueCentsint investmentValueCentsNo description in source.
debtBalanceCentsint debtBalanceCentsNo description in source.
monthlyDebtPaymentCentsint monthlyDebtPaymentCentsNo description in source.
monthlyExpensesCentsint monthlyExpensesCentsNo description in source.
monthlyHousingCostCentsint monthlyHousingCostCentsNo description in source.
monthlyFoodCostCentsint monthlyFoodCostCentsNo description in source.
monthlyTransportCostCentsint monthlyTransportCostCentsNo description in source.
monthlyHealthcareCostCentsint monthlyHealthcareCostCentsNo description in source.
monthlyUtilityCostCentsint monthlyUtilityCostCentsNo description in source.
creditLimitCentsint creditLimitCentsNo description in source.
creditScoreint creditScoreNo description in source.
financialStressint financialStressNo description in source.
emergencyFundMonthsint emergencyFundMonthsNo description in source.
povertyRiskint povertyRiskNo description in source.
foodSecurityint foodSecurityNo description in source.
economicResilienceint economicResilienceNo description in source.
taxComplianceint taxComplianceNo description in source.
taxBracketint taxBracketNo description in source.
taxRateBasisPointsint taxRateBasisPointsNo description in source.
receivesPublicBenefitsint receivesPublicBenefitsNo description in source.
publicBenefitsCentsPerMonthint publicBenefitsCentsPerMonthNo description in source.
pensionEligibilityint pensionEligibilityNo description in source.
retirementReadinessint retirementReadinessNo description in source.
financialDependentsint financialDependentsNo description in source.
housingTypestring housingTypeHousing, utilities, and household services
tenureTypestring tenureTypeNo description in source.
housingQualityint housingQualityNo description in source.
housingSecurityint housingSecurityNo description in source.
roomsInHomeint roomsInHomeNo description in source.
peoplePerRoomint peoplePerRoomNo description in source.
overcrowdingRiskint overcrowdingRiskNo description in source.
homelessnessRiskint homelessnessRiskNo description in source.
waterAccessint waterAccessNo description in source.
sanitationAccessint sanitationAccessNo description in source.
electricityAccessint electricityAccessNo description in source.
heatingAccessint heatingAccessNo description in source.
coolingAccessint coolingAccessNo description in source.
internetAccessint internetAccessNo description in source.
phoneAccessint phoneAccessNo description in source.
wasteCollectionAccessint wasteCollectionAccessNo description in source.
publicTransportAccessint publicTransportAccessNo description in source.
distanceToHealthcareint distanceToHealthcareNo description in source.
distanceToSchoolint distanceToSchoolNo description in source.
neighborhoodSafetyint neighborhoodSafetyNo description in source.
neighborhoodQualityint neighborhoodQualityNo description in source.
environmentalQualityint environmentalQualityNo description in source.
householdEnergyUseint householdEnergyUseNo description in source.
householdWaterUseint householdWaterUseNo description in source.
housingAssistanceint housingAssistanceNo description in source.
socialConnectionint socialConnectionCommunity, relationships, and civic participation
familySupportint familySupportNo description in source.
friendNetworkSizeint friendNetworkSizeNo description in source.
communityBelongingint communityBelongingNo description in source.
socialTrustint socialTrustNo description in source.
institutionalTrustint institutionalTrustNo description in source.
volunteerHoursPerMonthint volunteerHoursPerMonthNo description in source.
communityServiceHoursint communityServiceHoursNo description in source.
civicParticipationint civicParticipationNo description in source.
votingParticipationint votingParticipationNo description in source.
publicMeetingParticipationint publicMeetingParticipationNo description in source.
localOrganizationMembershipsint localOrganizationMembershipsNo description in source.
charitableGivingCentsPerYearint charitableGivingCentsPerYearNo description in source.
neighborlinessint neighborlinessNo description in source.
socialIsolationRiskint socialIsolationRiskNo description in source.
discriminationExposureint discriminationExposureNo description in source.
inclusionAccessint inclusionAccessNo description in source.
culturalParticipationint culturalParticipationNo description in source.
recreationHoursPerWeekint recreationHoursPerWeekNo description in source.
libraryUseint libraryUseNo description in source.
publicServiceSatisfactionint publicServiceSatisfactionNo description in source.
communityContributionint communityContributionNo description in source.
civilStatusstring civilStatusLegal and administrative standing
residencyStatusstring residencyStatusNo description in source.
voterRegistrationStatusstring voterRegistrationStatusNo description in source.
taxAccountIdstring taxAccountIdNo description in source.
identityVerifiedint identityVerifiedNo description in source.
addressVerifiedint addressVerifiedNo description in source.
permitsHeldint permitsHeldNo description in source.
licensesHeldint licensesHeldNo description in source.
legalCaseCountint legalCaseCountNo description in source.
unresolvedLegalCasesint unresolvedLegalCasesNo description in source.
fineBalanceCentsint fineBalanceCentsNo description in source.
complianceScoreint complianceScoreNo description in source.
civicObligationsCompleteint civicObligationsCompleteNo description in source.
juryServiceEligibleint juryServiceEligibleNo description in source.
juryServiceCompletedint juryServiceCompletedNo description in source.
publicRecordsConsentint publicRecordsConsentNo description in source.
privacyPreferenceLevelint privacyPreferenceLevelNo description in source.
primaryTransportModestring primaryTransportModeMobility, transport, and environmental impact
hasDrivingLicenseint hasDrivingLicenseNo description in source.
hasVehicleint hasVehicleNo description in source.
commuteMinutesint commuteMinutesNo description in source.
commuteDistanceMetersint commuteDistanceMetersNo description in source.
walkingAbilityint walkingAbilityNo description in source.
cyclingAbilityint cyclingAbilityNo description in source.
transitUseDaysPerWeekint transitUseDaysPerWeekNo description in source.
transportReliabilityint transportReliabilityNo description in source.
mobilityAccessint mobilityAccessNo description in source.
travelIndependenceint travelIndependenceNo description in source.
estimatedCarbonKgPerMonthint estimatedCarbonKgPerMonthNo description in source.
energyConservationint energyConservationNo description in source.
recyclingParticipationint recyclingParticipationNo description in source.
environmentalStewardshipint environmentalStewardshipNo description in source.
deviceAccessint deviceAccessDigital access and safety
computerAccessint computerAccessNo description in source.
broadbandQualityint broadbandQualityNo description in source.
onlineServiceUseint onlineServiceUseNo description in source.
cybersecurityAwarenessint cybersecurityAwarenessNo description in source.
digitalPrivacyAwarenessint digitalPrivacyAwarenessNo description in source.
accessibilityTechnologyAccessint accessibilityTechnologyAccessNo description in source.
digitalSkillsint digitalSkillsNo description in source.
digitalExclusionRiskint digitalExclusionRiskNo description in source.
telehealthCapabilityint telehealthCapabilityNo description in source.
lifeSatisfactionint lifeSatisfactionLife stage, goals, and personal status
happinessint happinessNo description in source.
moraleint moraleNo description in source.
motivationint motivationNo description in source.
futureOutlookint futureOutlookNo description in source.
personalGoalProgressint personalGoalProgressNo description in source.
retirementStatusint retirementStatusNo description in source.
caregiverStatusint caregiverStatusNo description in source.
parentingStatusint parentingStatusNo description in source.
studentStatusint studentStatusNo description in source.
veteranStatusint veteranStatusNo description in source.
newcomerStatusint newcomerStatusNo description in source.
displacedStatusint displacedStatusNo description in source.
disasterExposureint disasterExposureNo description in source.
emergencyPreparednessint emergencyPreparednessNo description in source.
resilienceAfterCrisisint resilienceAfterCrisisNo description in source.
lastSurveyYearint lastSurveyYearNo description in source.
dataCompletenessint dataCompletenessNo description in source.
dataConfidenceint dataConfidenceNo description in source.
schemaVersionint schemaVersionSchema and rules metadata
rulesetIdint rulesetIdNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
isAdultint isAdult()No description in source.
isWorkingAgeint isWorkingAge()No description in source.
isEmployedint isEmployed()No description in source.
isFinanciallyStableint isFinanciallyStable()No description in source.
hasBasicUtilitiesint hasBasicUtilities()No description in source.
hasDigitalAccessint hasDigitalAccess()No description in source.
canParticipateCivicallyint canParticipateCivically()No description in source.
adjustHealthint adjustHealth(int delta)No description in source.
setAgeint setAge(int years, int months)No description in source.
normalizeint normalize()No description in source.

ConsultingModel #sleela 2.5 (lib/citizen/character/ConsultingModel.sleela)

ConsultingModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
consultantsint consultantspeople who can bill
billableHoursint billableHourstotal hours actually billed this month
rateCentsint rateCentsbilling rate per hour
salaryPerHeadCentsint salaryPerHeadCentsmonthly salary cost per consultant

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int heads, int hours, int rate, int salaryPerHead)No description in source.
utilizationPercentint utilizationPercent()Utilization as a percent of a nominal 160-hour month across all heads.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

FederalReserveID #sleela 2.5 (lib/citizen/FederalReserveID.sleela)

FederalReserveID class

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
MODULEstatic final String MODULE = "FederalReserveID"No description in source.
DISTRICT_BOSTONstatic final int DISTRICT_BOSTON = 1The twelve Federal Reserve Districts. Yes, there are exactly twelve. No, nobody remembers why Missouri got two.
DISTRICT_NEW_YORKstatic final int DISTRICT_NEW_YORK = 2No description in source.
DISTRICT_PHILADELPHIAstatic final int DISTRICT_PHILADELPHIA = 3No description in source.
DISTRICT_CLEVELANDstatic final int DISTRICT_CLEVELAND = 4No description in source.
DISTRICT_RICHMONDstatic final int DISTRICT_RICHMOND = 5No description in source.
DISTRICT_ATLANTAstatic final int DISTRICT_ATLANTA = 6No description in source.
DISTRICT_CHICAGOstatic final int DISTRICT_CHICAGO = 7No description in source.
DISTRICT_ST_LOUISstatic final int DISTRICT_ST_LOUIS = 8No description in source.
DISTRICT_MINNEAPOLISstatic final int DISTRICT_MINNEAPOLIS = 9No description in source.
DISTRICT_KANSAS_CITYstatic final int DISTRICT_KANSAS_CITY = 10No description in source.
DISTRICT_DALLASstatic final int DISTRICT_DALLAS = 11No description in source.
DISTRICT_SAN_FRANCISCOstatic final int DISTRICT_SAN_FRANCISCO = 12No description in source.
DISTRICT_COUNTstatic final int DISTRICT_COUNT = 12No description in source.
loadedFlagint loadedFlagNo description in source.
issuedboolean issuedNo description in source.
idNumberString idNumbersynthetic clearing ID: FRS-<district>-<serial>
districtint districtone of DISTRICT_*
serialint serialthe citizen's spot in a very long, patient line

Methods — the actions this unit can perform.

MethodSignatureWhat it does
loadvoid load()No description in source.
loadedboolean loaded()No description in source.
moduleNameString moduleName()No description in source.
issuevoid issue(String legalName)Issue a Fed clearing ID to a named citizen. Deterministic + fake on purpose.
assignDistrictvoid assignDistrict(int whichDistrict)Re-home the citizen to a specific District (e.g. they moved to Dallas).
districtOfRoutingint districtOfRouting(String routing)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.
districtNameString districtName()A friendly name for the District, for forms and small talk alike.
validboolean valid()No description in source.
numberString number()No description in source.
currentDistrictint currentDistrict()No description in source.
routingPrefixint routingPrefix(String routing)Turn the first two characters of the routing string into an int 0..99.
nameSerialint nameSerial(String legalName)Fold a name into a stable 6-digit serial. Not secure; delightfully not.
digitValueint digitValue(String c)Map a single-character String to its digit value 0..9, or -1 if not a digit.
charWeightint charWeight(String c)A stable per-character weight for serial folding. Digits use their value; everything else gets a constant nudge so names still spread out nicely.
describeString describe()No description in source.

FranchiseModel #sleela 2.5 (lib/citizen/character/FranchiseModel.sleela)

FranchiseModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
outletsint outletsfranchised locations
avgOutletSalesCentsint avgOutletSalesCentsaverage monthly sales per outlet
royaltyPercentint royaltyPercentthe franchisor's royalty (0..100)
supportCostCentsint supportCostCentsmonthly cost to support one outlet

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int locations, int avgSales, int royalty, int supportCost)No description in source.
networkSalesint networkSales()Total sales across the whole brand this month.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

FreemiumModel #sleela 2.5 (lib/citizen/character/FreemiumModel.sleela)

FreemiumModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
freeUsersint freeUsersthe generous majority
conversionPercentint conversionPercentshare of free users who go paid (0..100)
priceCentsint priceCentsmonthly price for a converted user
serveCostCentsint serveCostCentscost to serve ONE user (free or paid) per month

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int free, int conversion, int price, int serveCost)No description in source.
paidUsersint paidUsers()No description in source.
totalUsersint totalUsers()No description in source.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

Industry #sleela 2.5 (lib/citizen/Industry.sleela)

Industry class

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
MODULEstatic final String MODULE = "Industry"No description in source.
SECTOR_NONEstatic final int SECTOR_NONE = 0The whole economy, abridged to fit on one business card. between jobs; "consulting"
SECTOR_AGRICULTUREstatic final int SECTOR_AGRICULTURE = 1feeds everyone, thanked by few
SECTOR_MININGstatic final int SECTOR_MINING = 2digs up tomorrow's shortage
SECTOR_MANUFACTURINGstatic final int SECTOR_MANUFACTURING = 3makes the thing in the box
SECTOR_ENERGYstatic final int SECTOR_ENERGY = 4keeps the lights, bills on
SECTOR_CONSTRUCTIONstatic final int SECTOR_CONSTRUCTION = 5runs 3 weeks over, always
SECTOR_RETAILstatic final int SECTOR_RETAIL = 6"did you find everything okay?"
SECTOR_TRANSPORTstatic final int SECTOR_TRANSPORT = 7the box, now moving
SECTOR_FINANCEstatic final int SECTOR_FINANCE = 8moves money, keeps a slice
SECTOR_HEALTHCAREstatic final int SECTOR_HEALTHCARE = 9the only sector that bills you
SECTOR_EDUCATIONstatic final int SECTOR_EDUCATION = 10for existing near it underpaid, over-caffeinated
SECTOR_TECHNOLOGYstatic final int SECTOR_TECHNOLOGY = 11"we've gone fully remote"
SECTOR_GOVERNMENTstatic final int SECTOR_GOVERNMENT = 12the sector that counts the rest
SECTOR_COUNTstatic final int SECTOR_COUNT = 13No description in source.
loadedFlagint loadedFlagNo description in source.
sectorint sectorone of SECTOR_*
wageCentsint wageCentspay per cycle, in cents, so nobody loses a penny
onPayrollboolean onPayrollwhether the machine currently remembers your name

Methods — the actions this unit can perform.

MethodSignatureWhat it does
loadvoid load()No description in source.
loadedboolean loaded()No description in source.
moduleNameString moduleName()No description in source.
employvoid employ(int whichSector, int cents)Join the workforce in a given sector at a given wage. Welcome aboard.
layOffvoid layOff()"We're going in a different direction." Famous last words of a Friday.
giveRaisevoid giveRaise(int cents)A modest raise. The economy's rare act of kindness.
employedboolean employed()No description in source.
wageint wage()No description in source.
currentSectorint currentSector()No description in source.
sectorNameString sectorName()A human-readable job title, because SECTOR_8 impresses no one at dinner.
ynString yn(boolean b)No description in source.
describeString describe()No description in source.

LicensingModel #sleela 2.5 (lib/citizen/character/LicensingModel.sleela)

LicensingModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
licensedUnitsint licensedUnitsunits the licensees sold this month
royaltyPerUnitCentsint royaltyPerUnitCentsroyalty collected per licensed unit
ipUpkeepCentsint ipUpkeepCentsmonthly cost to maintain/defend the IP

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int unitsLicensed, int royaltyPerUnit, int ipUpkeep)No description in source.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

ManufacturingModel #sleela 2.5 (lib/citizen/character/ManufacturingModel.sleela)

ManufacturingModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
unitsProducedint unitsProducedunits shipped this month
wholesalePriceCentsint wholesalePriceCentsprice per unit to the buyer
variableCostCentsint variableCostCentsmaterial + labor per unit
fixedPlantCentsint fixedPlantCentsmonthly fixed factory cost (regardless of volume)

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int produced, int wholesalePrice, int variableCost, int fixedPlant)No description in source.
breakEvenUnitsint breakEvenUnits()Break-even volume: units needed to cover the fixed plant cost alone.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

MarketplaceModel #sleela 2.5 (lib/citizen/character/MarketplaceModel.sleela)

MarketplaceModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
transactionsint transactionsdeals brokered this month
avgOrderCentsint avgOrderCentsaverage value of one order
takeRatePercentint takeRatePercentthe house's cut (0..100)
opCostCentsint opCostCentsoperating cost per transaction (support, fraud, etc.)

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int txns, int avgOrder, int takeRate, int opCost)No description in source.
gmvint gmv()Gross merchandise value: everything that flowed through the marketplace.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

RetailModel #sleela 2.5 (lib/citizen/character/RetailModel.sleela)

RetailModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
unitsSoldint unitsSolditems sold this month
retailPriceCentsint retailPriceCentsprice on the shelf
unitCostCentsint unitCostCentswhat the item cost to acquire
overheadCentsint overheadCentsmonthly rent/staff/lights

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int sold, int retailPrice, int unitCost, int overhead)No description in source.
unitMarginint unitMargin()Margin per unit, in case anyone asks how thin it really is.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

SaaSModel #sleela 2.5 (lib/citizen/character/SaaSModel.sleela)

SaaSModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
basicSeatsint basicSeatsseats on the basic tier
premiumSeatsint premiumSeatsseats on the premium tier
basicPriceCentsint basicPriceCentsmonthly price per basic seat
premiumPriceCentsint premiumPriceCentsmonthly price per premium seat
infraCostPerSeatCentsint infraCostPerSeatCentscloud/infra cost per seat per month

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int basic, int premium, int basicPrice, int premiumPrice, int infraPerSeat)No description in source.
totalSeatsint totalSeats()No description in source.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

SLPackage #sleela 2.5 (lib/citizen/SLPackage.sleela)

SLPackage class

Defines the SLeeLa standard-library package for citizen.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
packageNameString packageNameNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String name)No description in source.
nameString name()No description in source.
availableboolean available()No description in source.

SubscriptionModel #sleela 2.5 (lib/citizen/character/SubscriptionModel.sleela)

SubscriptionModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
subscribersint subscriberspaying seats right now
priceCentsint priceCentsmonthly price per subscriber
churnPercentint churnPercentshare who cancel each month (0..100)
serviceCostCentsint serviceCostCentscost to serve one subscriber per month

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int seats, int price, int churn, int serviceCost)No description in source.
retainedint retained()Subscribers who are still around after this month's churn pay full price.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.

WholesaleModel #sleela 2.5 (lib/citizen/character/WholesaleModel.sleela)

WholesaleModel class extends BusinessModel

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.

Carries the standard Metadata Class record — 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.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
casesint casescases moved this month
casePriceCentsint casePriceCentsprice per case to the retailer
caseCostCentsint caseCostCentscost per case from the manufacturer
logisticsCentsint logisticsCentsmonthly warehouse + freight overhead

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setUpvoid setUp(int casesSold, int casePrice, int caseCost, int logistics)No description in source.
monthlyRevenueint monthlyRevenue()No description in source.
monthlyCostint monthlyCost()No description in source.