Stride Reference Manual  1.0
stride Namespace Reference

Time Dependent Person DataType. More...

Namespaces

 output
 Utilities for the output files.
 
 pop
 
 popgen
 Population Generator.
 
 run
 
 util
 Utilities for the project.
 

Classes

class  _PopulationIterator
 
class  AsyncSimulator
 
class  Calendar
 Class that keeps track of the 'state' of simulated world. More...
 
struct  CalendarDataType
 
class  Cluster
 Represents a location for social contacts, an group of people. More...
 
class  ClusterCalculator
 
class  ClusterCalculator< ClusterType::Household >
 
class  ClusterCalculator< ClusterType::PrimaryCommunity >
 
class  ClusterCalculator< ClusterType::School >
 
class  ClusterCalculator< ClusterType::SecondaryCommunity >
 
class  ClusterCalculator< ClusterType::Work >
 
class  ClusterSaver
 
struct  ConfigDataType
 
class  ConstPopulationIterator
 
class  ContactProfile
 
class  Coordinator
 
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  DiseaseProfile
 
class  District
 A district is either a city or a village (currently, there is no difference between city and village) More...
 
class  HBM
 
class  HBMData
 
class  Hdf5Loader
 
class  Hdf5Saver
 
class  Health
 
class  Infector
 Actual contacts and transmission in cluster (primary template). More...
 
class  Infector< log_level, track_index_case, NoLocalInformation >
 Actual contacts and transmissions in cluster (specialization for NoLocalInformation policy) More...
 
class  Infector< LogMode::Contacts, track_index_case, NoLocalInformation >
 Actual contacts and transmission in cluster (specialization for logging all contacts, and with NoLocalInformation policy). More...
 
class  Influence
 
class  InformationPolicy
 
class  LocalDiscussion
 
class  LocalSimulatorAdapter
 
class  NoBehaviour
 
class  NoBelief
 
class  NoGlobalInformation
 
class  NoLocalInformation
 
class  Nothing
 
class  Person
 Forward declaration of class Person. More...
 
struct  PersonTDDataType
 
struct  PersonTIDataType
 
class  Population
 Container for persons in population. More...
 
class  PopulationBuilder
 Initializes Population objects. More...
 
class  PopulationIterator
 
class  RemoteSimulatorReceiver
 
class  RemoteSimulatorSender
 
class  RNG
 
class  Simulator
 Main class that contains and direct the virtual world. More...
 
class  SimulatorBuilder
 Main class that contains and direct the virtual world. More...
 
class  SimulatorRunMode
 
class  SimulatorSetup
 
struct  SimulatorStatus
 
class  Threshold
 
class  ThresholdData
 
class  Traveller
 
struct  TravellerDataType
 

Typedefs

using uint = unsigned int
 
using _PopIter = _PopulationIterator< Population, Population::PlannerType::Agenda::iterator >
 
using _ConstPopIter = _PopulationIterator< const Population, Population::PlannerType::Agenda::const_iterator >
 
using Parallel = unipar::Parallel
 

Enumerations

enum  VariableState { VariableState::Low = 0U, VariableState::High = 1U }
 
enum  ClusterType {
  ClusterType::Household, ClusterType::School, ClusterType::Work, ClusterType::PrimaryCommunity,
  ClusterType::SecondaryCommunity, ClusterType::Null
}
 Enumerates the cluster types. More...
 
enum  HealthStatus {
  HealthStatus::Susceptible = 0U, HealthStatus::Exposed = 1U, HealthStatus::Infectious = 2U, HealthStatus::Symptomatic = 3U,
  HealthStatus::InfectiousAndSymptomatic = 4U, HealthStatus::Recovered = 5U, HealthStatus::Immune = 6U, HealthStatus::Null
}
 
enum  LogMode { LogMode::None = 0U, LogMode::Transmissions = 1U, LogMode::Contacts = 2U, LogMode::Null }
 Enum specifiying the level of logging required: More...
 
enum  RunMode { Initial = 0U, Extend = 1U, Replay = 2U, Extract = 3U }
 

Functions

string toString (ClusterType w)
 Converts a ClusterType value to corresponding name. More...
 
bool isClusterType (const std::string &s)
 Check whether string is name of a ClusterType value. More...
 
ClusterType toClusterType (const std::string &s)
 Converts a string with name to ClusterType value. More...
 
constexpr unsigned int numOfClusterTypes ()
 Number of Cluster types (not including Null type). More...
 
std::size_t toSizeType (ClusterType c)
 Cast for array access. More...
 
string toString (LogMode w)
 Converts a LogMode value to corresponding name. More...
 
bool isLogMode (const std::string &s)
 Check whether string is name of LogMode value. More...
 
LogMode toLogMode (const std::string &s)
 Converts a string with name to LogMode value. More...
 
constexpr unsigned int maximumAge ()
 Maximum age for Person's. 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

Time Dependent Person DataType.

Main namespace for the project.

Traveller data (multi region extension)

Time Independent Person DataType.

Typedef Documentation

typedef unsigned int stride::uint

Definition at line 17 of file Influence.h.

using stride::_PopIter = typedef _PopulationIterator<Population, Population::PlannerType::Agenda::iterator>

Definition at line 172 of file Population.h.

using stride::_ConstPopIter = typedef _PopulationIterator<const Population, Population::PlannerType::Agenda::const_iterator>

Definition at line 184 of file Population.h.

using stride::Parallel = typedef unipar::Parallel

Definition at line 16 of file unipar.h.

Enumeration Type Documentation

enum stride::VariableState
strong
Enumerator
Low 
High 

Definition at line 12 of file HBMData.h.

enum stride::ClusterType
strong

Enumerates the cluster types.

Enumerator
Household 
School 
Work 
PrimaryCommunity 
SecondaryCommunity 
Null 

Definition at line 28 of file ClusterType.h.

enum stride::HealthStatus
strong
Enumerator
Susceptible 
Exposed 
Infectious 
Symptomatic 
InfectiousAndSymptomatic 
Recovered 
Immune 
Null 

Definition at line 19 of file Health.h.

enum stride::LogMode
strong

Enum specifiying the level of logging required:

  • none at all
  • only contacts where transimission occurs
  • all contacts.
Enumerator
None 
Transmissions 
Contacts 
Null 

Definition at line 32 of file LogMode.h.

Enumerator
Initial 
Extend 
Replay 
Extract 

Definition at line 15 of file SimulatorRunMode.h.

Function Documentation

bool stride::isClusterType ( const string &  s)

Check whether string is name of a ClusterType value.

Definition at line 58 of file ClusterType.cpp.

Referenced by toSizeType().

ClusterType stride::toClusterType ( const string &  s)

Converts a string with name to ClusterType value.

Definition at line 64 of file ClusterType.cpp.

Referenced by stride::SimulatorBuilder::initializeLocations(), and toSizeType().

constexpr unsigned int stride::numOfClusterTypes ( )
inline

Number of Cluster types (not including Null type).

Definition at line 33 of file ClusterType.h.

std::size_t stride::toSizeType ( ClusterType  c)
inline

Cast for array access.

Definition at line 36 of file ClusterType.h.

References isClusterType(), toClusterType(), and toString().

Referenced by stride::Cluster::addContactProfile(), and stride::Cluster::getContactRate().

std::string stride::toString ( LogMode  l)

Converts a LogMode value to corresponding name.

Definition at line 50 of file LogMode.cpp.

bool stride::isLogMode ( const string &  s)

Check whether string is name of LogMode value.

Definition at line 54 of file LogMode.cpp.

LogMode stride::toLogMode ( const string &  s)

Converts a string with name to LogMode value.

Definition at line 60 of file LogMode.cpp.

constexpr unsigned int stride::maximumAge ( )
inline

Maximum age for Person's.

Definition at line 27 of file Age.h.

Referenced by effectiveAge().

constexpr unsigned int stride::minAdultAge ( )
inline

Maximum age for Person's.

Definition at line 30 of file Age.h.

Referenced by stride::Person< BehaviourPolicy, BeliefPolicy >::update().

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

Effective age (topping of at maximum).

Definition at line 33 of file Age.h.

References maximumAge().

Referenced by stride::Cluster::getContactRate().