gabm.abm.attributes.employment module

Employment module for GABM.

class gabm.abm.attributes.employment.Employment(employment_id: EmploymentID, description: str)

Bases: GABMAttribute

Employment class.

Attributes:: id (EmploymentID): Unique identifier for the employment. description (str): The description of the employment.

class gabm.abm.attributes.employment.EmploymentID(employment_id: int)

Bases: GABMAttributeID

A unique identifier for an Employment attribute.

Attributes:: id (int): The unique identifier for the employment class instance.

ECONOMICALLY_INACTIVE = EmploymentID(6)

EMPLOYED_FULL_TIME = EmploymentID(1)

EMPLOYED_PART_TIME = EmploymentID(2)

RETIRED = EmploymentID(5)

STUDENT = EmploymentID(4)

UNEMPLOYED = EmploymentID(3)

UNKNOWN = EmploymentID(0)

class gabm.abm.attributes.employment.EmploymentMap

Bases: GABMAttributeMap

A mapping of EmploymentIds to Employment.

By default, the map is initialized as follows:

items = {
    EmploymentID.UNKNOWN: Employment(EmploymentID.UNKNOWN, "unknown"),
    EmploymentID.EMPLOYED_FULL_TIME: Employment(EmploymentID.EMPLOYED_FULL_TIME, "employed full time"),
    EmploymentID.EMPLOYED_PART_TIME: Employment(EmploymentID.EMPLOYED_PART_TIME, "employed part time"),
    EmploymentID.UNEMPLOYED: Employment(EmploymentID.UNEMPLOYED, "unemployed"),
    EmploymentID.STUDENT: Employment(EmploymentID.STUDENT, "student"),
    EmploymentID.RETIRED: Employment(EmploymentID.RETIRED, "retired"),
    EmploymentID.ECONOMICALLY_INACTIVE: Employment(EmploymentID.ECONOMICALLY_INACTIVE, "economically inactive")
}
super().__init__(items)