mio::abm::Household Class Reference

A Household represented by a vector with HouseholdMembers. More...

#include <household.h>

Public Member Functions
void	add_members (HouseholdMember household_member, int number_of_members)
	Adds a number of the same HouseholdMembers to a Household. More...
const std::vector< std::tuple< HouseholdMember, int > > &	get_members () const
	Get the HouseholdMembers of the Household. More...
int	get_space_per_member () const
	Get the space per member of the Household, measured in cubic meters. More...
int	get_total_number_of_members () const
	Returns the number of members, i.e. Persons in the Household. More...
	Household ()
	Constructs a new Household. More...
void	set_space_per_member (int space_per_member)
	Set the space per member for the computation of the LocationCapacity of the Household. More...

Private Attributes
std::vector< std::tuple< HouseholdMember, int > >	m_household_member_list
	HouseholdMembers of the Household and the respective number of Persons. More...
int	m_number_of_members
	Total number of Persons in the Household. More...
int	m_space_per_member
	Space per Person in cubic meters (constant maximal capacity over time). More...

Detailed Description

A Household represented by a vector with HouseholdMembers.

The Household may contain multiple members of the same type.

Constructor & Destructor Documentation

Household()

mio::abm::Household::Household ( )

inline

Constructs a new Household.

Member Function Documentation

add_members()

void mio::abm::Household::add_members	(	HouseholdMember	household_member,
		int	number_of_members
	)

Adds a number of the same HouseholdMembers to a Household.

Parameters

[in]	household_member	A HouseholdMember.
[in]	number_of_members	The amount of members to be added.

get_members()

const std::vector<std::tuple<HouseholdMember, int> >& mio::abm::Household::get_members ( ) const

inline

Get the HouseholdMembers of the Household.

get_space_per_member()

int mio::abm::Household::get_space_per_member ( ) const

inline

Get the space per member of the Household, measured in cubic meters.

get_total_number_of_members()

int mio::abm::Household::get_total_number_of_members ( ) const

inline

Returns the number of members, i.e. Persons in the Household.

set_space_per_member()

void mio::abm::Household::set_space_per_member ( int  space_per_member )

inline

Set the space per member for the computation of the LocationCapacity of the Household.

Parameters

[in]

space_per_member

Space per member in cubic meters.

Member Data Documentation

m_household_member_list

std::vector<std::tuple<HouseholdMember, int> > mio::abm::Household::m_household_member_list

private

HouseholdMembers of the Household and the respective number of Persons.

m_number_of_members

int mio::abm::Household::m_number_of_members

private

Total number of Persons in the Household.

m_space_per_member

int mio::abm::Household::m_space_per_member

private

Space per Person in cubic meters (constant maximal capacity over time).