Individuals

Individual

A type to represent individuals that act as agents inside the simulation.

Fields

• General

  • id::Int32: Unique identifier of the individual
  • sex::Int8: Sex (Female (1), Male(2), Diverse (3))
  • age::Int8: Age
  • occupation::Int16: Occupation class (i.e. manual labour, office job, etc...)
  • education::Int8: Education class (i.e. highest degree)

• Comorbidities

  • comorbidities::UInt16: Bitmask indicating prevalence of certain health conditions

• Behaviour

  • social_factor::Float32: Parameter for risk-willingness (-1 to 1)
  • mandate_compliance::Float32: Probability of complying to mandates (-1 to 1)

• Associated Settings

  • household::Int32: Reference to household id
  • office::Int32: Reference to office id
  • schoolclass::Int32: Reference to schoolclass id
  • municipality::Int32: Reference to municipality id

• Bookkeeping

  • needs_immunity_update::Bool: Flag for deferred immunity calculations
  • number_of_infections::Int8: Lifetime infection count
  • disease_flags::UInt8: Bitpacked disease-state flags (infected/infectious/symptomatic/severe/critical/dead), accessed via the is_*/*! accessors
  • killing_pathogen_id::Int8: Pathogen credited for the host death (set when death is scheduled, read by the death logger)

• Interventions

  • detected_mask::UInt32: Bitmask of pathogens for which an infection is detected
  • quarantine_tick::Int16: Start tick of quarantine
  • quarantine_release_tick::Int16: End tick of quarantine
  • quarantine_status::Int8: Status indicator (none, household, etc.)

• Host Care State (current occupancy only; pending transitions live in the Simulation's HealthSchedule)

  • hospital_demands::Int16: Count of active care contributions demanding a hospital bed. The host occupies the level while the count is above zero.
  • icu_demands::Int16: Count of active care contributions demanding ICU.
  • ventilation_demands::Int16: Count of active care contributions demanding ventilation.
  • death::Int16: Tick of host death

• Pathogen

  • infection_cache::NTuple{N, InfectionState}: Fixed-size cache of current infections
  • infection_head::Int32: Pointer to the first overflow node in the InfectionRegistry
  • active_pathogens_mask::UInt32: Bitmask of currently active pathogen types

• Immunity

  • immunity_cache::NTuple{N, ImmunityState}: Fixed-size cache of pathogen immunities
  • immunity_head::Int32: Pointer to the first overflow node in the ImmunityRegistry

• Extensions

  • extensions::Any: Optional container for dynamically added per-individual attributes (nothing when unused)

Individual(properties::Dict)

Create an individual with the provided properties. Properties must have at least keys id, sex, age.

Individual(properties::DataFrameRow)

Create an individual with the provided properties. Properties must have at least keys id, sex, age.

age(individual::Individual)

Return an individual's age.

class_id(individual::Individual)

Returns an individual's associated class's ID.

comorbidities(individual::Individual)

Returns an individual's comorbidities.

death(individual::Individual)

Returns the tick the individual is scheduled to die at, DEFAULT_TICK if none.

education(individual::Individual)

Return an individual's education class

end_quarantine!(individual::Individual)

Ends an individuals quarantine.

has_municipality(individual::Individual)

Returns true if individual is assigned to an instance of type Municipality.

home_quarantine!(individual::Individual)

Quarantines an individual in their household.

household_id(individual::Individual)

Returns an individual's associated household's ID.

id(individual::Individual)

Return the unique identifier of the individual.

is_dead(individual::Individual)
isdead(individual::Individual)
dead(individual::Individual)

Returns true if the individual is dead.

is_detected(individual::Individual)

Returns true if the individual has been detected for any currently active pathogen.

is_exposed(individual::Individual)
isexposed(individual::Individual)
exposed(individual::Individual)

Returns true if the individual is exposed at the current tick. Exposed means infected but not yet infectious.

is_hospitalized(individual::Individual)
ishospitalized(individual::Individual)
hospitalized(individual::Individual)

Returns true if the individual is currently in hospital. Care state is realized as the simulation runs, so there is no timeline to query at an arbitrary tick; use health_episodes for past occupancy.

is_icu(individual::Individual)
isicu(individual::Individual)
icu(individual::Individual)

Returns true if the individual is currently in the ICU.

is_infected(individual::Individual)
isinfected(individual::Individual)
infected(individual::Individual)

Returns the infected flag of the individual.

is_infectious(individual::Individual)
isinfectious(individual::Individual)
infectious(individual::Individual)

Returns true iff the individual currently has nonzero shedding for at least one of their active pathogens.

is_severe(individual::Individual)
issevere(individual::Individual)
severe(individual::Individual)

Returns the severe flag of the individual.

is_student(individual::Individual)

Returns true if individual is assigned to an instance of type SchoolClass.

is_symptomatic(individual::Individual)
issymptomatic(individual::Individual)
symptomatic(individual::Individual)

Returns the symptomatic flag of the individual.

is_ventilated(individual::Individual)
isventilated(individual::Individual)
ventilated(individual::Individual)

Returns true if the individual is currently on a ventilator.

is_working(individual::Individual)

Returns true if individual is assigned to an instance of type Office.

mandate_compliance(individual::Individual)

Return an individual's mandate_compliance value.

municipality(i::Individual, sim::Simulation)::Municipality

Returns the Municipality instance referenced in an individual.

municipality_id(individual::Individual)

Returns an individual's associated municipalities ID.

num_of_infected(individuals::Vector{Individual})

Takes a vector of individuals and returns the number of infected individuals.

number_of_infections(individual::Individual)

Returns an individual's number of infections (currently infected).

occupation(individual::Individual)

Returns an individual's occupation class.

office(i::Individual, sim::Simulation)::Office

Returns the Office instance referenced in an individual.

office_id(individual::Individual)

Returns an individual's associated office's ID.

quarantine_release_tick(individual::Individual)

Returns an individual's quarantine release tick.

quarantine_status(individual::Individual)

Returns an individuals quarantine status.

quarantine_tick(individual::Individual)

Returns an individual's quarantine tick.

sex(individual::Individual)

Return an individual's sex.

social_factor(individual::Individual)

Returns an individual's social_factor value.