hgps::SimulationModuleFactory Class Reference

Defines the SimulationModule factory data type. More...

#include <modulefactory.h>

Public Types
using	ModuleType = std::shared_ptr< SimulationModule >
	Base module type. More...
using	ConcreteBuilder = ModuleType(*)(Repository &, const ModelInput &)
	Concrete module builder function signature. More...

Public Member Functions
	SimulationModuleFactory ()=delete
	SimulationModuleFactory (Repository &data_repository)
	Initialises a new instance of the SimulationModuleFactory class. More...
std::size_t	size () const noexcept
	Gets the number of registered module instance. More...
bool	contains (const SimulationModuleType type) const noexcept
	Determine whether the factory contains an instance of a module type. More...
void	register_builder (const SimulationModuleType type, const ConcreteBuilder builder)
	Registers a simulation module type builder function. More...
ModuleType	create (const SimulationModuleType type, const ModelInput &config)
	Create a polymorphic SimulationModule instance. More...

Detailed Description

Defines the SimulationModule factory data type.

The module factory is used to assemble the concrete modules implementation to compose the Health-GPS microsimulation instance. The simulation engine will request an instance of each of the SimulationModuleType enumeration module at construction.

The concrete builder function receives an instance of the back-end data storage and the user simulation inputs to create the respective module type instance for use by the microsimulation algorithm.

Member Typedef Documentation

ConcreteBuilder

using hgps::SimulationModuleFactory::ConcreteBuilder = ModuleType (*)(Repository &, const ModelInput &)

Concrete module builder function signature.

ModuleType

using hgps::SimulationModuleFactory::ModuleType = std::shared_ptr<SimulationModule>

Base module type.

Constructor & Destructor Documentation

SimulationModuleFactory() [1/2]

hgps::SimulationModuleFactory::SimulationModuleFactory ( )

delete

SimulationModuleFactory() [2/2]

hgps::SimulationModuleFactory::SimulationModuleFactory

(

Repository &

data_repository

)

Initialises a new instance of the SimulationModuleFactory class.

Parameters

data_repository

The back-end data repository instance to use

Member Function Documentation

contains()

bool hgps::SimulationModuleFactory::contains ( const SimulationModuleType  type ) const

noexcept

Determine whether the factory contains an instance of a module type.

Parameters

type	The simulation module type

Returns

true, if the factory contains a instance; otherwise, false

create()

SimulationModuleFactory::ModuleType hgps::SimulationModuleFactory::create	(	const SimulationModuleType	type,
		const ModelInput &	config
	)

Create a polymorphic SimulationModule instance.

Parameters

type	The simulation module type
config	The simulation model inputs definition

Returns

A new SimulationModule instance

Here is the caller graph for this function:

register_builder()

void hgps::SimulationModuleFactory::register_builder	(	const SimulationModuleType	type,
		const ConcreteBuilder	builder
	)

Registers a simulation module type builder function.

Parameters

type	The simulation module type
builder	The module type instance builder function

size()

std::size_t hgps::SimulationModuleFactory::size ( ) const

noexcept

Gets the number of registered module instance.

Returns

NUmber of registered modules

---

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

• HealthGPS/modulefactory.h
• HealthGPS/modulefactory.cpp