mio::abm::HouseholdGroup Class Reference

A HouseholdGroup represented by different Households. More...

#include <household.h>

Public Member Functions
void	add_households (Household household, int number_of_households)
	Adds a number of Households of the same kind, e.g. same members, to a HouseholdGroup. More...
const std::vector< std::tuple< Household, int > > &	get_households () const
	Returns the Households of the HouseholdGroup. More...
int	get_total_number_of_households () const
	Returns the number of Households in the HouseholdGroup. More...
	HouseholdGroup ()
	Constructs a new HouseholdGroup. More...

Private Attributes
std::vector< std::tuple< Household, int > >	m_household_list
	A list of types of Households and the amount of times it is in the group. More...
int	m_number_of_households
	Number of Households in this group. More...

Detailed Description

A HouseholdGroup represented by different Households.

The group may contain multiple Households of the same type.

Constructor & Destructor Documentation

HouseholdGroup()

mio::abm::HouseholdGroup::HouseholdGroup ( )

inline

Constructs a new HouseholdGroup.

Member Function Documentation

add_households()

void mio::abm::HouseholdGroup::add_households	(	Household	household,
		int	number_of_households
	)

Adds a number of Households of the same kind, e.g. same members, to a HouseholdGroup.

Parameters

[in]	household	A Household.
[in]	number_of_households	The amount of times that Household is in the group.

get_households()

const std::vector<std::tuple<Household, int> >& mio::abm::HouseholdGroup::get_households ( ) const

inline

Returns the Households of the HouseholdGroup.

Returns

A vector of tuples that contains the Houshold and the amount of times that Household is in the group.

get_total_number_of_households()

int mio::abm::HouseholdGroup::get_total_number_of_households ( ) const

inline

Returns the number of Households in the HouseholdGroup.

Member Data Documentation

m_household_list

std::vector<std::tuple<Household, int> > mio::abm::HouseholdGroup::m_household_list

private

A list of types of Households and the amount of times it is in the group.

m_number_of_households

int mio::abm::HouseholdGroup::m_number_of_households

private

Number of Households in this group.