Stride Reference Manual  - generated for commit 9643b11
stride Namespace Reference

Namespace for the simulator and related classes. More...

Namespaces

 AgeBrackets
 AgeBrackets that determine participation in type of ContactPool.
 
 ContactLogMode
 Enum specifiying the level of logging required:
 
 ContactType
 Namespace to manage types of ContactPool.
 
 output
 Utilities for the output files.
 
 RNEngineType
 Namespace to manage types of random engines.
 
 sim_event
 Namespace to manage events signalled by the SimRunner.
 
 util
 Utilities for the project.
 
 viewers
 Namespace for MVC-viewers that may be registered with SimRunner.
 

Classes

class  AbstractPopBuilder
 Base Class for PopBuilders. More...
 
class  AgeContactProfile
 Contact rates as a function of age. More...
 
class  Calendar
 Class that keeps track of the 'state' of simulated world. More...
 
class  ContactHandler
 Processes the contacts between persons and determines whether transmission occurs. More...
 
class  ContactPool
 A group of Persons that potentially have contacts with one another. More...
 
class  ContactPoolSys
 ContactPoolSys contains for each of the type of pools (Household, K12School, ...) a vector of with all of the contact pools of the type. More...
 
class  ControlHelper
 Controls a simulation run initiated with the command line interface (cli). More...
 
class  DaysOffAll
 No days off work or school. More...
 
class  DaysOffInterface
 Interface definition. More...
 
class  DaysOffNone
 No days off work or school. More...
 
class  DaysOffSchool
 Schools closed. More...
 
class  DaysOffStandard
 Standard situation for days off from work and school. More...
 
class  DefaultPopBuilder
 Initializes Population objects. More...
 
class  DiseaseSeeder
 Seeds population w.r.t immunity (natural immunity, vaccination, ...) and infection. More...
 
class  GenPopController
 Controls a geo-population generation run initiated with the command line interface (cli). More...
 
class  GeoPopBuilder
 Builds poulation of a geographic grid. More...
 
class  Health
 Holds a person's health data. More...
 
class  HealthSeeder
 Seeds the population with Health data. More...
 
class  Immunizer
 Deals with immunization strategies. More...
 
class  ImportPopBuilder
 Initializes Population objects. More...
 
class  Infector
 Actual contacts and transmission in contactpool (primary template). More...
 
class  Infector< LL, TIC, true >
 Time-optimized version (For NoLocalInformation && (None || Transmission logging)). More...
 
class  InfectorMap
 Mechanism to select the appropriate Infector template to execute. More...
 
class  Person
 Store and handle person data. More...
 
class  Population
 Key Data structure: container for (a) all individuals in the population (b) the ContactPoolSys wchich is used to loop over ContactPools of each type (c) (if present) GeoGrid of Locations, each having an index of ContactPools at that location. More...
 
class  PublicHealthAgency
 
class  Sim
 Simulator can time step and reveal some of the key data. More...
 
class  SimBuilder
 Builds a simulator based a configuration property tree. More...
 
class  SimController
 Controls a simulation run initiated with the command line interface (cli). More...
 
class  SimRunner
 The simulation runner drive simulator throufgh time steps. More...
 
class  StanController
 Runs a simulation multiple times, with different random engine seeds. More...
 
class  SurveySeeder
 Seeds the population with survey participants. More...
 
class  TransmissionProfile
 Transmission probabilities from disease data. More...
 

Typedefs

using AgeContactProfiles = ContactType::IdSubscriptArray< AgeContactProfile >
 
typedef void( InfectorExec) (ContactPool &pool, const AgeContactProfile &profile, const TransmissionProfile &trans_profile, ContactHandler &c_handler, unsigned short int sim_day, std::shared_ptr< spdlog::logger > c_logger)
 For use in the InfectorMap and Sim; executes infector. More...
 

Enumerations

enum  HealthStatus : unsigned short int {
  HealthStatus::Susceptible = 0U, HealthStatus::Exposed = 1U, HealthStatus::Infectious = 2U, HealthStatus::Symptomatic = 3U,
  HealthStatus::InfectiousAndSymptomatic = 4U, HealthStatus::Recovered = 5U, HealthStatus::Immune = 6U
}
 Enumerate the various health states with respect to the infection. More...
 

Functions

date::year_month_day ConvertFromString (const string &day)
 
constexpr unsigned int MaximumAge ()
 Maximum age for Persons. More...
 
constexpr unsigned int MinAdultAge ()
 Maximum age for Person's. More...
 
unsigned int EffectiveAge (unsigned int age)
 Effective age (topping of at maximum). More...
 

Detailed Description

Namespace for the simulator and related classes.

Typedef Documentation

typedef void( stride::InfectorExec) (ContactPool &pool, const AgeContactProfile &profile, const TransmissionProfile &trans_profile, ContactHandler &c_handler, unsigned short int sim_day, std::shared_ptr< spdlog::logger > c_logger)

For use in the InfectorMap and Sim; executes infector.

Definition at line 33 of file InfectorExec.h.

Enumeration Type Documentation

enum stride::HealthStatus : unsigned short int
strong

Enumerate the various health states with respect to the infection.

Enumerator
Susceptible 
Exposed 
Infectious 
Symptomatic 
InfectiousAndSymptomatic 
Recovered 
Immune 

Definition at line 26 of file Health.h.

Function Documentation

date::year_month_day stride::ConvertFromString ( const string &  day)

Definition at line 97 of file Calendar.cpp.

Referenced by stride::Calendar::Calendar(), and stride::Calendar::InitializeHolidays().

Here is the caller graph for this function:

constexpr unsigned int stride::MaximumAge ( )
inline

Maximum age for Persons.

Definition at line 26 of file Age.h.

Referenced by EffectiveAge().

Here is the caller graph for this function:

constexpr unsigned int stride::MinAdultAge ( )
inline

Maximum age for Person's.

Definition at line 29 of file Age.h.

Referenced by stride::Person::Update().

Here is the caller graph for this function:

unsigned int stride::EffectiveAge ( unsigned int  age)
inline

Effective age (topping of at maximum).

Definition at line 32 of file Age.h.

References MaximumAge().

Here is the call graph for this function: