Health-GPS 3.0.0.0
Global Health Policy Simulation model (Health-GPS)
Loading...
Searching...
No Matches
hgps::MappingEntry Class Reference

Defines risk factor mapping entry data type. More...

#include <mapping.h>

Public Member Functions

 MappingEntry ()=delete
 
 MappingEntry (std::string name, int level, OptionalInterval range={})
 Initialises a new instance of the MappingEntry class.
 
const std::string & name () const noexcept
 Gets the factor name.
 
int level () const noexcept
 Gets the factor hierarchical level.
 
const core::Identifierkey () const noexcept
 Gets the factor unique identification.
 
const OptionalIntervalrange () const noexcept
 Gets the factor allowed values range.
 
double get_bounded_value (double value) const noexcept
 Adjusts a value to the factor range, if provided.
 

Detailed Description

Defines risk factor mapping entry data type.

Single risk factor definition, the dynamic factor is included only in the dynamic risk factor model hierarchy, never in the static model.

Constructor & Destructor Documentation

◆ MappingEntry() [1/2]

hgps::MappingEntry::MappingEntry ( )
delete

◆ MappingEntry() [2/2]

hgps::MappingEntry::MappingEntry ( std::string  name,
int  level,
OptionalInterval  range = {} 
)

Initialises a new instance of the MappingEntry class.

Parameters
nameRisk factor name
levelThe hierarchical level
rangeThe factor range

Member Function Documentation

◆ get_bounded_value()

double hgps::MappingEntry::get_bounded_value ( double  value) const
noexcept

Adjusts a value to the factor range, if provided.

Parameters
valueThe value to adjust
Returns
The bounded value

◆ key()

const core::Identifier & hgps::MappingEntry::key ( ) const
noexcept

Gets the factor unique identification.

Returns
Factor identification

◆ level()

int hgps::MappingEntry::level ( ) const
noexcept

Gets the factor hierarchical level.

Returns
Factor level
Here is the caller graph for this function:

◆ name()

const std::string & hgps::MappingEntry::name ( ) const
noexcept

Gets the factor name.

Returns
Factor name
Here is the caller graph for this function:

◆ range()

const OptionalInterval & hgps::MappingEntry::range ( ) const
noexcept

Gets the factor allowed values range.

Returns
Factor values range
Here is the caller graph for this function:

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