|
| 1 | +""" |
| 2 | +Data Model Enumerated Variables |
| 3 | +
|
| 4 | +Instructions: modify these enumerated variables as needed for your ActivitySim implementation. |
| 5 | +""" |
| 6 | +from enum import IntEnum |
| 7 | + |
| 8 | + |
| 9 | +class PersonType(IntEnum): |
| 10 | + """ |
| 11 | + Provides integer mapping to the person type variable. A person type is |
| 12 | + used as a co-variate in numerous ActivitySim modules to explain behavior. |
| 13 | + """ |
| 14 | + |
| 15 | + FULL_TIME_WORKER = 1 |
| 16 | + PART_TIME_WORKER = 2 |
| 17 | + ADULT_STUDENT = 3 |
| 18 | + NON_WORKING_ADULT = 4 |
| 19 | + RETIRED = 5 |
| 20 | + SECONDARY_SCHOOL_STUDENT = 6 |
| 21 | + PRIMARY_SCHOOL_STUDENT = 7 |
| 22 | + PRE_SCHOOL_CHILD = 8 |
| 23 | + |
| 24 | + |
| 25 | +class Gender(IntEnum): |
| 26 | + """ |
| 27 | + Provides an integer mapping for gender. |
| 28 | + """ |
| 29 | + |
| 30 | + MALE = 1 |
| 31 | + FEMALE = 2 |
| 32 | + OTHER = 3 |
| 33 | + |
| 34 | + |
| 35 | +class Occupation(IntEnum): |
| 36 | + """ |
| 37 | + Provides an integer mapping for a persons occupation. |
| 38 | + """ |
| 39 | + |
| 40 | + WHITE_COLLAR = 1 |
| 41 | + SERVICES = 2 |
| 42 | + HEALTH = 3 |
| 43 | + RETAIL = 4 |
| 44 | + BLUE_COLLAR = 5 |
| 45 | + NOT_EMPLOYED = 6 |
| 46 | + |
| 47 | + |
| 48 | +class DailyActivityPattern(IntEnum): |
| 49 | + """ |
| 50 | + Provides an integer mapping to the daily activity pattern variable. |
| 51 | + """ |
| 52 | + |
| 53 | + MANDATORY = 1 |
| 54 | + NON_MANDATORY = 2 |
| 55 | + HOME = 3 |
| 56 | + |
| 57 | + |
| 58 | +class Purpose(IntEnum): |
| 59 | + """ |
| 60 | + Provides an integer mapping for trip and tour purpose. |
| 61 | + """ |
| 62 | + |
| 63 | + WORK = 1 |
| 64 | + ADULT_SCHOOL = 2 |
| 65 | + CHILD_SCHOOL = 3 |
| 66 | + SHOPPING = 4 |
| 67 | + ESCORT = 5 |
| 68 | + MAINTENANCE = 6 |
| 69 | + DISCRETIONARY = 7 |
| 70 | + |
| 71 | + |
| 72 | +class AreaType(IntEnum): |
| 73 | + """ |
| 74 | + Provide an integer mapping for area type, which serves as a proxy for urban form. |
| 75 | + """ |
| 76 | + |
| 77 | + REGIONAL_CORE = 0 |
| 78 | + CBD = 1 |
| 79 | + URBAN_BUSINESS = 2 |
| 80 | + URBAN = 3 |
| 81 | + SUBURBAN = 4 |
| 82 | + RURAL = 5 |
| 83 | + |
| 84 | + |
| 85 | +class County(IntEnum): |
| 86 | + """ |
| 87 | + Provide an integer mapping for county in which a landuse zone resides. |
| 88 | + """ |
| 89 | + |
| 90 | + SAN_FRANSISCO = 1 |
| 91 | + SAN_MATEO = 2 |
| 92 | + SANTA_CLARA = 3 |
| 93 | + ALAMEDA = 4 |
| 94 | + CONTRA_COSTA = 5 |
| 95 | + SOLANO = 6 |
| 96 | + NAPA = 7 |
| 97 | + SONOMA = 8 |
| 98 | + MARIN = 9 |
| 99 | + |
| 100 | + |
| 101 | +class HHT(IntEnum): |
| 102 | + """ |
| 103 | + Provide an integer mapping for household/family type. |
| 104 | + """ |
| 105 | + |
| 106 | + GROUP_QUARTERS = 0 |
| 107 | + FAMILY_MARRIED_COUPLE = 1 |
| 108 | + FAMILY_MALE_HOUSEHOLDER_NO_WIFE = 2 |
| 109 | + FAMILY_FEMANLE_HOUSEHOLDER_NO_HUSBAND = 3 |
| 110 | + NON_FAMILY_MALE_ALONE = 4 |
| 111 | + NON_FAMILY_MALE_NOT_ALONE = 5 |
| 112 | + NON_FAMILY_FEMALE_ALONE = 6 |
| 113 | + NON_FAMILY_FEMALE_NOT_ALONE = 7 |
| 114 | + |
| 115 | + |
| 116 | +class Mode(IntEnum): |
| 117 | + """ |
| 118 | + Provides an integer mapping for travel mode. |
| 119 | + """ |
| 120 | + |
| 121 | + DRIVE_ALONE_FREE = 1 |
| 122 | + DRIVE_ALONE_PAY = 2 |
| 123 | + SHARED_RIDE_2_FREE = 3 |
| 124 | + SHARED_RIDE_2_PAY = 4 |
| 125 | + SHARED_RIDE_3_FREE = 5 |
| 126 | + SHARED_RIDE_3_PAY = 6 |
| 127 | + WALK = 7 |
| 128 | + BICYCLE = 8 |
| 129 | + WALK_TO_TRANSIT_ALL = 9 |
| 130 | + WALK_TO_TRANSIT_PREMIUM_ONLY = 10 |
| 131 | + PARK_AND_RIDE_TRANSIT_ALL = 11 |
| 132 | + PARK_AND_RIDE_TRANSIT_PREMIUM_ONLY = 12 |
| 133 | + KISS_AND_RIDE_TRANSIT_ALL = 13 |
| 134 | + KISS_AND_RIDE_TRANSIT_PREMIUM_ONLY = 14 |
| 135 | + SCHOOL_BUS = 15 |
| 136 | + |
| 137 | + |
| 138 | +class ModelTime(IntEnum): |
| 139 | + """ |
| 140 | + Provides an integer mapping from military time to model time interval index. |
| 141 | + The name represents the starting point of the interval. So the interval from |
| 142 | + 3:00 am to 3:30 am is represented by index 1, which is named `ZERO_THREE`. |
| 143 | + """ |
| 144 | + |
| 145 | + ZERO_THREE = 1 |
| 146 | + ZERO_THREE_THIRTY = 2 |
| 147 | + ZERO_FOUR = 3 |
| 148 | + ZERO_FOUR_THIRTY = 4 |
| 149 | + ZERO_FIVE = 5 |
| 150 | + ZERO_FIVE_THIRTY = 6 |
| 151 | + ZERO_SIX = 7 |
| 152 | + ZERO_SIX_THIRTY = 8 |
| 153 | + ZERO_SEVEN = 9 |
| 154 | + ZERO_SEVEN_THIRTY = 10 |
| 155 | + ZERO_EIGHT = 11 |
| 156 | + ZERO_EIGHT_THIRTY = 12 |
| 157 | + ZERO_NINE = 13 |
| 158 | + ZERO_NINE_THIRTY = 14 |
| 159 | + TEN = 15 |
| 160 | + TEN_THIRTY = 16 |
| 161 | + ELEVEN = 17 |
| 162 | + ELEVEN_THIRTY = 18 |
| 163 | + TWELVE = 19 |
| 164 | + TWELVE_THIRTY = 20 |
| 165 | + THIRTEEN = 21 |
| 166 | + THIRTEEN_THIRTY = 22 |
| 167 | + FOURTEEN = 23 |
| 168 | + FOURTEEN_THIRTY = 24 |
| 169 | + FIFTEEN = 25 |
| 170 | + FIFTEEN_THIRTY = 26 |
| 171 | + SIXTEEN = 27 |
| 172 | + SIXTEEN_THIRTY = 28 |
| 173 | + SEVENTEEN = 29 |
| 174 | + SEVENTEEN_THIRTY = 30 |
| 175 | + EIGHTEEN = 31 |
| 176 | + EIGHTEEN_THIRTY = 32 |
| 177 | + NINETEEN = 33 |
| 178 | + NINETEEN_THIRTY = 34 |
| 179 | + TWENTY = 35 |
| 180 | + TWENTY_THIRTY = 36 |
| 181 | + TWENTY_ONE = 37 |
| 182 | + TWENTY_ONE_THIRTY = 38 |
| 183 | + TWENTY_TWO = 39 |
| 184 | + TWENTY_TWO_THIRTY = 40 |
| 185 | + TWENTY_THREE = 41 |
| 186 | + TWENTY_THREE_THIRTY = 42 |
0 commit comments