Stride Reference Manual  - generated for commit 9643b11
geopop::GeoGridConfig Class Reference

Configuration data mostly for generating a population, but also for computing the required number of schools, workplaces, communities etc. More...

#include <GeoGridConfig.h>

Collaboration diagram for geopop::GeoGridConfig:
Collaboration graph

Public Member Functions

 GeoGridConfig ()
 Default constructor needed in test code. More...
 
 GeoGridConfig (const boost::property_tree::ptree &configPt)
 Constructor that configures input data. More...
 
void SetData (const std::string &householdsFileName)
 Read the househould data file, parse it and set data. More...
 

Public Attributes

stride::ContactType::IdSubscriptArray< unsigned int > people {0U, 500U, 3000U, 20U, 2000U, 2000U}
 People per unit (= Household, K12School, College, etc.) for each of the ContactTypes. More...
 
stride::ContactType::IdSubscriptArray< unsigned int > pools {1U, 25U, 20U, 1U, 1U, 1U}
 Pools per unit (= Household, K12School, College, etc.) for each of the ContactTypes. More...
 
struct {
   double   participation_college
 Participation of college (fraction of people of college age going to college). More...
 
   double   particpation_workplace
 Participation of workplace (fraction of people of work age and not going to college and having employment). More...
 
   double   fraction_college_commuters
 Fraction of college students that commute. More...
 
   double   fraction_workplace_commuters
 Fraction of people in the workplace that commute. More...
 
   unsigned int   pop_size
 Target population size for the generated population. More...
 
param
 
struct {
   unsigned int   person_count = 0U
 Number of persons in the reference household set. More...
 
   std::vector< std::vector< unsigned int > >   ages {}
 Age profile per reference household. More...
 
refHH
 
struct {
   unsigned int   popcount_k12school
 Numbers of individuals in K12School. More...
 
   unsigned int   popcount_college
 Number of individuals in College. More...
 
   unsigned int   popcount_workplace
 Number of individuals in Workplace. More...
 
   unsigned int   count_households
 The number of households. More...
 
info
 

Detailed Description

Configuration data mostly for generating a population, but also for computing the required number of schools, workplaces, communities etc.

for that population.

Definition at line 35 of file GeoGridConfig.h.

Constructor & Destructor Documentation

geopop::GeoGridConfig::GeoGridConfig ( )

Default constructor needed in test code.

Definition at line 36 of file GeoGridConfig.cpp.

References info, param, people, pools, and refHH.

geopop::GeoGridConfig::GeoGridConfig ( const boost::property_tree::ptree &  configPt)
explicit

Constructor that configures input data.

Member Function Documentation

void geopop::GeoGridConfig::SetData ( const std::string &  householdsFileName)

Read the househould data file, parse it and set data.

Definition at line 57 of file GeoGridConfig.cpp.

References geopop::ReaderFactory::CreateHouseholdReader(), stride::AgeBrackets::K12School::HasAge(), stride::AgeBrackets::College::HasAge(), stride::AgeBrackets::Workplace::HasAge(), info, param, and refHH.

Referenced by stride::GeoPopBuilder::Build().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

stride::ContactType::IdSubscriptArray<unsigned int> geopop::GeoGridConfig::people {0U, 500U, 3000U, 20U, 2000U, 2000U}

People per unit (= Household, K12School, College, etc.) for each of the ContactTypes.

Default initialization. Order in which contacttypes are listed in the definition of the enumeration must be respected!

Definition at line 47 of file GeoGridConfig.h.

Referenced by geopop::Generator< ID >::Apply(), and GeoGridConfig().

stride::ContactType::IdSubscriptArray<unsigned int> geopop::GeoGridConfig::pools {1U, 25U, 20U, 1U, 1U, 1U}

Pools per unit (= Household, K12School, College, etc.) for each of the ContactTypes.

Default initialization. Order in which contacttypes are listed in the definition of the enumeration must be respected!

Definition at line 52 of file GeoGridConfig.h.

Referenced by geopop::Generator< ID >::AddPools(), and GeoGridConfig().

double geopop::GeoGridConfig::participation_college

Participation of college (fraction of people of college age going to college).

Definition at line 60 of file GeoGridConfig.h.

Referenced by geopop::Populator< ID >::Apply(), and geopop::operator<<().

double geopop::GeoGridConfig::particpation_workplace

Participation of workplace (fraction of people of work age and not going to college and having employment).

Definition at line 64 of file GeoGridConfig.h.

Referenced by geopop::Generator< ID >::Apply(), geopop::Populator< ID >::Apply(), and geopop::operator<<().

double geopop::GeoGridConfig::fraction_college_commuters

Fraction of college students that commute.

Definition at line 67 of file GeoGridConfig.h.

Referenced by geopop::Populator< ID >::Apply(), and geopop::operator<<().

double geopop::GeoGridConfig::fraction_workplace_commuters

Fraction of people in the workplace that commute.

Definition at line 70 of file GeoGridConfig.h.

Referenced by geopop::Generator< ID >::Apply(), geopop::Populator< ID >::Apply(), and geopop::operator<<().

unsigned int geopop::GeoGridConfig::pop_size

Target population size for the generated population.

Definition at line 73 of file GeoGridConfig.h.

Referenced by geopop::Generator< ID >::Apply(), stride::GeoPopBuilder::MakeLocations(), and geopop::operator<<().

unsigned int geopop::GeoGridConfig::person_count = 0U

Number of persons in the reference household set.

Definition at line 82 of file GeoGridConfig.h.

std::vector<std::vector<unsigned int> > geopop::GeoGridConfig::ages {}

Age profile per reference household.

Definition at line 85 of file GeoGridConfig.h.

Referenced by geopop::Populator< ID >::Apply().

struct { ... } geopop::GeoGridConfig::refHH
unsigned int geopop::GeoGridConfig::popcount_k12school

Numbers of individuals in K12School.

Definition at line 98 of file GeoGridConfig.h.

Referenced by geopop::Generator< ID >::Apply(), and geopop::operator<<().

unsigned int geopop::GeoGridConfig::popcount_college

Number of individuals in College.

Definition at line 101 of file GeoGridConfig.h.

Referenced by geopop::Generator< ID >::Apply(), geopop::Populator< ID >::Apply(), and geopop::operator<<().

unsigned int geopop::GeoGridConfig::popcount_workplace

Number of individuals in Workplace.

Definition at line 104 of file GeoGridConfig.h.

Referenced by geopop::Generator< ID >::Apply(), geopop::Populator< ID >::Apply(), and geopop::operator<<().

unsigned int geopop::GeoGridConfig::count_households

The number of households.

Definition at line 107 of file GeoGridConfig.h.

Referenced by geopop::Generator< ID >::Apply().

struct { ... } geopop::GeoGridConfig::info

The documentation for this class was generated from the following files: