gabm.abm.attributes.family module

Family module for GABM.

class gabm.abm.attributes.family.Family(family_id: FamilyID, description: str)

Bases: GABMAttribute

A Family.

Attributes:: id (FamilyID): Unique identifier for the family. description (str): The description of the family.

class gabm.abm.attributes.family.FamilyID(family_id: int)

Bases: GABMAttributeID

A unique identifier for a Family attribute.

Attributes:: id (int): The unique identifier for the family.

MARRIED = FamilyID(2)

NOT_MARRIED = FamilyID(1)

UNKNOWN = FamilyID(0)

class gabm.abm.attributes.family.FamilyMap

Bases: GABMAttributeMap

A mapping of FamilyIds to Families.

By default, the map is initialized as follows:

items: Dict[FamilyID, Family] = {
    FamilyID.UNKNOWN: Family(FamilyID.UNKNOWN, "unknown"),
    FamilyID.NOT_MARRIED: Family(FamilyID.NOT_MARRIED, "not married"),
    FamilyID.MARRIED: Family(FamilyID.MARRIED, "married"),
}
super().__init__(items)