Virtual Belgium  2.0
A micro-simulation platform for the Belgian population
 All Classes Namespaces Files Functions Variables Typedefs Enumerator Friends Macros Pages
HouseholdPackage Struct Reference

The package structure for Household agents. More...

#include <Household.hpp>

Public Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 Serializing procedure of the package. More...
 
 HouseholdPackage ()
 
 HouseholdPackage (int aId, int aInitProc, int aAgentType, int aCurProc, int aIns, std::vector< repast::AgentId > aListInd, std::string aType, int aNChildren, int aNAdults, long aHouse)
 
repast::AgentId getId () const
 Return household's agent id. More...
 

Public Attributes

int id
 id of the household More...
 
int init_proc
 initial household process More...
 
int agent_type
 household agent type More...
 
int cur_proc
 current household process More...
 
int ins
 ins code of the household's municipality More...
 
std::vector< repast::AgentId > list_ind
 ids of households' members More...
 
std::string type
 household type More...
 
int n_children
 number of children More...
 
int n_adults
 number of additional adults More...
 
long house
 household's housing unit node id More...
 

Friends

class boost::serialization::access
 

Detailed Description

The package structure for Household agents.

A structure used for passing households agents from one process to another.

Constructor & Destructor Documentation

HouseholdPackage::HouseholdPackage ( )
HouseholdPackage::HouseholdPackage ( int  aId,
int  aInitProc,
int  aAgentType,
int  aCurProc,
int  aIns,
std::vector< repast::AgentId >  aListInd,
std::string  aType,
int  aNChildren,
int  aNAdults,
long  aHouse 
)

Member Function Documentation

repast::AgentId HouseholdPackage::getId ( ) const
inline

Return household's agent id.

Returns
an household agent id
template<class Archive >
void HouseholdPackage::serialize ( Archive &  ar,
const unsigned int  version 
)
inline

Serializing procedure of the package.

Parameters
aran Archive in which the household will be stored
versionversion of the package

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Member Data Documentation

int HouseholdPackage::agent_type

household agent type

int HouseholdPackage::cur_proc

current household process

long HouseholdPackage::house

household's housing unit node id

int HouseholdPackage::id

id of the household

int HouseholdPackage::init_proc

initial household process

int HouseholdPackage::ins

ins code of the household's municipality

std::vector<repast::AgentId> HouseholdPackage::list_ind

ids of households' members

int HouseholdPackage::n_adults

number of additional adults

int HouseholdPackage::n_children

number of children

std::string HouseholdPackage::type

household type


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