Stride Reference Manual  - generated for commit 9643b11
stride::AbstractPopBuilder Class Referenceabstract

Base Class for PopBuilders. More...

#include <AbstractPopBuilder.h>

Inheritance diagram for stride::AbstractPopBuilder:
Inheritance graph
Collaboration diagram for stride::AbstractPopBuilder:
Collaboration graph

Public Member Functions

 AbstractPopBuilder (const boost::property_tree::ptree &config, util::RnMan &rnMan, std::shared_ptr< spdlog::logger > strideLogger=nullptr)
 Initializing constructor. More...
 
virtual ~AbstractPopBuilder ()=default
 Has to be virtual. More...
 
virtual std::shared_ptr< PopulationBuild (std::shared_ptr< Population > pop)=0
 Build Population and return it afterwards. More...
 

Protected Attributes

const boost::property_tree::ptree & m_config
 Configuration property tree. More...
 
util::RnManm_rn_man
 Random number generation management. More...
 
std::shared_ptr< spdlog::logger > m_stride_logger
 

Detailed Description

Base Class for PopBuilders.

Definition at line 38 of file AbstractPopBuilder.h.

Constructor & Destructor Documentation

stride::AbstractPopBuilder::AbstractPopBuilder ( const boost::property_tree::ptree &  config,
util::RnMan rnMan,
std::shared_ptr< spdlog::logger >  strideLogger = nullptr 
)

Initializing constructor.

Parameters
configProperty_tree with general configuration settings.
rnManRandom number manager for pop build process.
strideLoggerLogging.

Definition at line 33 of file AbstractPopBuilder.cpp.

References stride::util::LogUtils::CreateNullLogger(), and m_stride_logger.

Here is the call graph for this function:

virtual stride::AbstractPopBuilder::~AbstractPopBuilder ( )
virtualdefault

Has to be virtual.

Member Function Documentation

virtual std::shared_ptr<Population> stride::AbstractPopBuilder::Build ( std::shared_ptr< Population pop)
pure virtual

Build Population and return it afterwards.

Implemented in stride::GeoPopBuilder, stride::DefaultPopBuilder, and stride::ImportPopBuilder.

Member Data Documentation

const boost::property_tree::ptree& stride::AbstractPopBuilder::m_config
protected

Configuration property tree.

Definition at line 55 of file AbstractPopBuilder.h.

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

util::RnMan& stride::AbstractPopBuilder::m_rn_man
protected

Random number generation management.

Definition at line 56 of file AbstractPopBuilder.h.

Referenced by stride::GeoPopBuilder::MakePersons(), and stride::GeoPopBuilder::MakePools().

std::shared_ptr<spdlog::logger> stride::AbstractPopBuilder::m_stride_logger
protected

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