Stride Reference Manual  - generated for commit 9643b11
geopop::Populator< ID > Class Template Reference

Populator uses geo & pop data to populate ContactPools in the GeoGrid. More...

#include <Populator.h>

Collaboration diagram for geopop::Populator< ID >:
Collaboration graph

Public Member Functions

 Populator (stride::util::RnMan &rnMan, std::shared_ptr< spdlog::logger > logger=nullptr)
 Construct with a RnMan and a logger. More...
 
 ~Populator ()=default
 Default is OK. More...
 
void Apply (GeoGrid &, const GeoGridConfig &)
 Populate the ContactPools type ID. This is a placeholder for the specializations. More...
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &geoGridConfig)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &geoGridConfig)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &ggConfig)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &ggConfig)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &ggConfig)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &ggConfig)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &ggConfig)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &ggConfig)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &)
 
template<>
void Apply (GeoGrid &geoGrid, const GeoGridConfig &geoGridConfig)
 

Protected Attributes

stride::util::RnManm_rn_man
 RnManager used by populators. More...
 
std::shared_ptr< spdlog::logger > m_logger
 Logger used by populators. More...
 

Detailed Description

template<typename stride::ContactType::Id ID>
class geopop::Populator< ID >

Populator uses geo & pop data to populate ContactPools in the GeoGrid.

Definition at line 36 of file Populator.h.

Constructor & Destructor Documentation

template<typename stride::ContactType::Id ID>
geopop::Populator< ID >::Populator ( stride::util::RnMan rnMan,
std::shared_ptr< spdlog::logger >  logger = nullptr 
)
inlineexplicit

Construct with a RnMan and a logger.

Definition at line 40 of file Populator.h.

References stride::util::LogUtils::CreateNullLogger(), geopop::Populator< ID >::m_logger, and geopop::Populator< ID >::~Populator().

Here is the call graph for this function:

template<typename stride::ContactType::Id ID>
geopop::Populator< ID >::~Populator ( )
default

Default is OK.

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

Here is the caller graph for this function:

Member Function Documentation

template<typename stride::ContactType::Id ID>
void geopop::Populator< ID >::Apply ( GeoGrid ,
const GeoGridConfig  
)
inline

Populate the ContactPools type ID. This is a placeholder for the specializations.

Definition at line 51 of file Populator.h.

template<>
void geopop::Populator< stride::ContactType::Id::Household >::Apply ( GeoGrid geoGrid,
const GeoGridConfig geoGridConfig 
)
template<>
void geopop::Populator< stride::ContactType::Id::K12School >::Apply ( GeoGrid geoGrid,
const GeoGridConfig  
)

Definition at line 31 of file K12SchoolPopulator.cpp.

template<>
void geopop::Populator< stride::ContactType::Id::K12School >::Apply ( GeoGrid geoGrid,
const GeoGridConfig ggConfig 
)
template<>
void geopop::Populator< stride::ContactType::Id::College >::Apply ( GeoGrid geoGrid,
const GeoGridConfig ggConfig 
)
template<>
void geopop::Populator< stride::ContactType::Id::Workplace >::Apply ( GeoGrid geoGrid,
const GeoGridConfig ggConfig 
)
template<>
void geopop::Populator< stride::ContactType::Id::Household >::Apply ( GeoGrid geoGrid,
const GeoGridConfig ggConfig 
)
template<>
void geopop::Populator< stride::ContactType::Id::PrimaryCommunity >::Apply ( GeoGrid geoGrid,
const GeoGridConfig ggConfig 
)
template<>
void geopop::Populator< stride::ContactType::Id::SecondaryCommunity >::Apply ( GeoGrid geoGrid,
const GeoGridConfig ggConfig 
)
template<>
void geopop::Populator< stride::ContactType::Id::PrimaryCommunity >::Apply ( GeoGrid geoGrid,
const GeoGridConfig  
)

Definition at line 29 of file PrimaryCommunityPopulator.cpp.

template<>
void geopop::Populator< stride::ContactType::Id::SecondaryCommunity >::Apply ( GeoGrid geoGrid,
const GeoGridConfig  
)

Definition at line 32 of file SecondaryCommunityPopulator.cpp.

Member Data Documentation

template<typename stride::ContactType::Id ID>
stride::util::RnMan& geopop::Populator< ID >::m_rn_man
protected

RnManager used by populators.

Definition at line 51 of file Populator.h.

template<typename stride::ContactType::Id ID>
std::shared_ptr<spdlog::logger> geopop::Populator< ID >::m_logger
protected

Logger used by populators.

Definition at line 55 of file Populator.h.

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


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