hgps::SimulationDefinition Struct Reference

Simulation experiment definition data type. More...

#include <simulation_definition.h>

Public Member Functions
	SimulationDefinition ()=delete
	SimulationDefinition (ModelInput &inputs, std::unique_ptr< Scenario > scenario, std::unique_ptr< RandomBitGenerator > generator)
	Initialises a new instance of the SimulationDefinition structure. More...
const ModelInput &	inputs () const noexcept
	Gets a read-only reference to the model inputs definition. More...
Scenario &	scenario () noexcept
	Gets a reference to the simulation scenario instance. More...
RandomBitGenerator &	rnd () noexcept
	Gets a reference to the pseudo-random number generator instance. More...
const std::string &	identifier () const noexcept
	Gets the simulation scenario identifier. More...

Detailed Description

Simulation experiment definition data type.

Constructor & Destructor Documentation

SimulationDefinition() [1/2]

hgps::SimulationDefinition::SimulationDefinition ( )

delete

SimulationDefinition() [2/2]

hgps::SimulationDefinition::SimulationDefinition	(	ModelInput &	inputs,
		std::unique_ptr< Scenario >	scenario,
		std::unique_ptr< RandomBitGenerator >	generator
	)

Initialises a new instance of the SimulationDefinition structure.

Parameters

inputs	The simulation model inputs
scenario	The scenario to simulate
generator	The pseudo-random number generator instance

Member Function Documentation

identifier()

const std::string & hgps::SimulationDefinition::identifier ( ) const

noexcept

Gets the simulation scenario identifier.

Returns

The simulation identifier

Here is the caller graph for this function:

inputs()

const ModelInput & hgps::SimulationDefinition::inputs ( ) const

noexcept

Gets a read-only reference to the model inputs definition.

Returns

The model inputs reference

Here is the caller graph for this function:

rnd()

RandomBitGenerator & hgps::SimulationDefinition::rnd ( )

noexcept

Gets a reference to the pseudo-random number generator instance.

Returns

Pseudo-random number generator reference

Here is the caller graph for this function:

scenario()

Scenario & hgps::SimulationDefinition::scenario ( )

noexcept

Gets a reference to the simulation scenario instance.

Returns

Experiment Scenario reference

Here is the caller graph for this function:

---

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

• HealthGPS/simulation_definition.h
• HealthGPS/simulation_definition.cpp