Define the transfer coefficient data type. More...

#include <food_labelling_scenario.h>

Collaboration diagram for hgps::TransferCoefficient:

Public Member Functions
	TransferCoefficient ()=delete

	TransferCoefficient (std::vector< double > values, unsigned int child_age)
	Initialise a new instance of the TransferCoefficient structure. More...

double	get_value (core::Gender gender, unsigned int age) const noexcept
	Gets the transfer coefficient value for a given gender and age. More...

Public Attributes
DoubleGenderValue	child
	Children transfer coefficient values. More...

DoubleGenderValue	adult
	Adult transfer coefficient values. More...

unsigned int	child_cutoff_age {}
	The child cut-off age (before adult) More...

Detailed Description

Define the transfer coefficient data type.

Constructor & Destructor Documentation

◆ TransferCoefficient() [1/2]

hgps::TransferCoefficient::TransferCoefficient ( )

delete

◆ TransferCoefficient() [2/2]

hgps::TransferCoefficient::TransferCoefficient	(	std::vector< double >	values,
		unsigned int	child_age
	)

inline

Initialise a new instance of the TransferCoefficient structure.

Parameters

values	The transfer coefficient values
child_age	The child cut-off age (before adult)

Exceptions

std::out_of_range for number of transfer coefficients mismatch.

Member Function Documentation

◆ get_value()

double hgps::TransferCoefficient::get_value	(	core::Gender	gender,
		unsigned int	age
	)		const

inlinenoexcept

Gets the transfer coefficient value for a given gender and age.

Parameters

gender	The gender reference
age	The age reference

Returns: The transfer coefficient value

Member Data Documentation

◆ adult

DoubleGenderValue hgps::TransferCoefficient::adult

Adult transfer coefficient values.

◆ child

DoubleGenderValue hgps::TransferCoefficient::child

Children transfer coefficient values.

◆ child_cutoff_age

unsigned int hgps::TransferCoefficient::child_cutoff_age {}

The child cut-off age (before adult)

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

HealthGPS/food_labelling_scenario.h

Public Member Functions

Public Attributes