Enumerations - ptidejteam/tools4cities-metamenth GitHub Wiki

MetamEnTh uses enumerations to define attributes that must be assigned values from a predefined set of string values. These enumerations serve as controlled vocabularies, ensuring that specific attributes are only assigned valid values from this restricted pool. For example, the PowerState enumeration provides a predefined set of strings that represent the possible power states for HVAC entities, such as On, Off, and Standby. In cases where none of the predefined values are suitable, users can select the Other option. While users cannot directly assign values to the Other option, they have the ability to extend the enumeration programmatically by adding new custom values to the list, allowing for greater flexibility and adaptability in modelling diverse scenarios.

All enumerations inherit from the AbstractEnum class. AbstractEnum has one method get_enum_type(value: str) which returns the type of enumeration given the string value of the enumeration.

AirVolumeType

• CONSTANT_AIR_VOLUME
• VARIABLE_AIR_VOLUME

ApplianceCategory

• HOME
• OFFICE
• OTHER
• NONE
• SMART

ApplianceType

• AIR_CONDITIONER
• AIR_PURIFIER
• BLENDER
• CAMERA
• COFFEE_MAKER
• DESKTOP_COMPUTER
• DEHUMIDIFIER
• DISHWASHER
• DOOR_BELL
• DRYER
• ELECTRIC_FAN
• FREEZER
• HUMIDIFIER
• INSTANT_POT
• KETTLE
• LAPTOP
• LAMINATOR
• LIGHT_BULB
• LOCK
• MICROWAVE
• NOTEBOOK
• OVEN
• PAPER_SHREDDER
• PHOTOCOPIER
• PLUG
• POWER_STRIP
• PRINTER
• PROJECTOR
• REFRIGERATOR
• RICE_COOKER
• SCANNER
• SECURITY_CAMERA
• SMOKE_DETECTOR
• SPEAKER
• STOVE
• SWITCH
• TELEVISION
• THERMOSTAT
• TOASTER
• VACUUM_CLEANER
• WASHING_MACHINE
• WHITEBOARD
• OTHER

ATSOperationMode

• AUTOMATIC
• MANUAL
• NON_AUTOMATIC

ATSPowerSourceType

• GENERATOR_GENERATOR
• OTHER
• UTILITY_GENERATOR_GENERATOR
• UTILITY_GENERATOR
• UTILITY_UTILITY
• UTILITY_UTILITY_GENERATOR

ATSSwitchingMechanism

• CONTRACTOR
• MOLDED_CASE
• POWER_FRAME

ATSTransitionType

• CLOSE
• OPEN

BatteryTech

• LITHIUM
• NICKEL
• OTHER
• RUTHENIUM

BoilerCategory

• BIOMASS
• ELECTRICAL
• LPG
• NATURAL_GAS
• OIL_FIRED
• WOOD_CHIPS
• OTHER

BuildingEntity

• ADJACENT_SPACE
• ADJACENT_ZONE
• APPLIANCE
• BUILDING
• ENERGY_SYSTEM
• FLOOR
• FLOOR_SPACE
• HVAC_COMPONENT
• METER
• OPEN_SPACE
• ROOM
• SCHEDULE
• SPACE
• SUBSYSTEM
• TRANSDUCER
• WEATHER_STATION
• ZONE
• OVERLAPPING_ZONE

BuildingOrientation

• EAST
• NORTH
• SOUTH
• TOP
• WEST

BuildingType

• COMMERCIAL
• NON_COMMERCIAL
• RESIDENTIAL

CapacitorTech

• LEAD_BATTERY
• LITHIUM_IRON
• NICKEL

CellType

• AMORPHOUS
• MONOCRYSTALLINE
• POLYCRYSTALLINE
• OTHER

ChillerType

• AIR_COOLED
• WATER_COOLED
• OTHER

CirculationPumpType

• CENTRIFUGAL
• CONSTANT_PRESSURE
• OTHER

CoilMaterial

• ALUMINUM
• COPPER
• STEEL
• OTHER

CompressorType

• CENTRIFUGAL
• RECIPROCATING_HERMETIC
• RECIPROCATING_OPEN
• RECIPROCATING_SEMI_HERMETIC
• ROTARY_VANE
• SCROLL
• SCREW
• OTHER

CoverType

• DOOR
• FLOOR
• ROOF
• WALL
• WINDOW

DamperType

• BACK_DRAFT
• BASIC_MANUAL_VOLUME
• BIOMETRIC_BYPASS
• MANUAL_VOLUME
• OTHER

DataMeasurementType

• CONSUMED_ELECTRICITY
• DIFFUSE_HORIZONTAL_IRRADIANCE
• DIRECT_NOMINAL_IRRADIANCE
• EXPORTED_ELECTRICITY
• GLOBAL_HORIZONTAL_IRRADIANCE
• GLOBAL_NOMINAL_IRRADIANCE
• HUMIDITY
• IMPORTED_ELECTRICITY
• MOISTURE_CONTENT
• OUTSIDE_TEMPERATURE
• PRECIPITATION
• PRESSURE
• RELATIVE_HUMIDITY
• SOLAR_RADIATION
• WIND_DIRECTION
• WIND_SPEED

DuctConnectionEntityType

• DESTINATION
• SOURCE

DuctSubType

• COLD_WATER
• FRESH_AIR
• GLYCOL
• HOT_AND_COLD_WATER
• HOT_WATER
• OTHER
• RETURN_AIR

DuctType

• AIR
• DHN
• OTHER
• WATER
• WATER_WITH_ANTI_FREEZE

EnergySource

• GRID
• RENEWABLE

EngineMode

• CO_GENERATION
• ELECTRICITY
• FUEL
• HEATING
• OTHER

EngineSubType

• BIO_DIESEL
• BIOMASS
• CHARCOAL
• COAL
• DIESEL
• ETHANOL
• GASOLINE
• GEO_THERMAL
• HYDROGEN
• JETFUEL
• NATURAL_GAS
• OIL
• PEAT
• PETROL
• PROPANE
• WOOD
• NONE
• OTHER

EngineType

• ELECTROLYSER
• ELECTRICITY
• FUEL_CELL
• INTERNAL_COMBUSTION
• MICRO_TURBINE
• STEAM
• STIRLING
• OTHER

FCUPipeSystem

• TWO_PIPE
• FOUR_PIPE

FCUType

• CEILING_MOUNTED
• STANDALONE

FilterType

• FIBREGLASS
• PLEATED
• HIGH_EFFICIENCY_PARTICULAR_AIR
• ELECTROSTATIC
• CARBON
• ULTRAVIOLET_GERMICIDAL_IRRADIATION
• MEDIA
• OTHER

FloorType

• REGULAR
• BASEMENT
• ROOFTOP

HeatExchangerFlowType

• PARALLEL
• COUNTER
• OTHER

HeatExchangerType

• PLATE
• SHELL_AND_TUBE
• FIN_TUBE
• PLATED_FIN
• OTHER

HeatSource

• AMBIENT_AIR
• EXHAUST_AIR
• HORIZONTAL_GROUND_COLLECTOR
• VERTICAL_GROUND_COLLECTOR
• WATER_WITH_ANTIFREEZE
• AQUIFER
• OTHER

HeatingType

• ELECTRIC
• HYDRONIC
• DIMPLEX
• OTHER

HVACType

• PERIMETER
• INTERIOR
• NONE

LayerRoughness

• VERY_ROUGH
• MEDIUM_ROUGH
• ROUGH
• SMOOTH
• VERY_SMOOTH

MaterialType

• AIR_GAP
• ALUMINIUM
• BAMBOO
• BRICK
• BUTYL_RUBBER
• CELLULOSE
• CERAMIC_TILE
• CONCRETE
• CONCRETE_BLOCK
• CONCRETE_TILE
• COPPER
• CORK
• CRUSHED_STONE_BALLAST
• ETHYLENE_PROPYLENE_DIENE_MONOMER
• EXPANDED_POLYSTYRENE
• EXTRUDED_POLYSTYRENE
• FIBRE_CEMENT
• FIBREGLASS
• FIBREGLASS_INSULATION
• FIRE_PROOF_GYPSUM_BOARD
• GLASS
• GLAZING
• GREEN
• GYPSUM_BOARD
• INSULATION
• LINOLEUM
• METALLIC_STUD
• METAL_SHINGLES
• MINERAL_WOOL
• NATURAL_STONE
• ORDINARY_GYPSUM_BOARD
• OTHER
• POLYISOCYANURATE
• POLYVINYL_CHLORIDE
• RIGID_INSULATION
• RUBBER
• RUBBER_MEMBRANE
• SEMI_RIGID_INSULATION
• SPRAY_FOAM
• STAINLESS_STEEL
• STEEL
• STONE_COATED_STEEL
• THERMOPLASTIC_POLYOLEFIN
• TIN
• VARnISHED_CONCRETE_BLOCK
• VEGETATION
• VINYL
• WINDOW_GAS
• WOOD
• ZINC

MeasurementUnit

• AMPERE
• CALORIES_PER_GRAM_PER_DEGREE_CELSIUS
• CANDELA_PER_SQUARE_METER
• CENTIMETERS
• CUBIC_CENTIMETER
• CUBIC_FEET
• CUBIC_FEET_PER_MINUTE
• CUBIC_METER
• CUBIC_METER_PER_SECOND
• CUBIC_METERS_PER_HOUR
• DECIBELS
• DEGREE_CELSIUS
• DEGREES
• FEET_PER_SECOND
• GALLONS_PER_SECOND
• GRAM_PER_CUBIC_METER
• GRAM_PER_KILOGRAM
• JOULES_PER_KELVIN
• JOULES_PER_KILOGRAM_PER_DEGREE_CELSIUS
• KILOGRAMS
• KILOGRAM_PER_CUBIC_METER
• KILOWATTS
• KILOWATTS_PER_HOUR
• KILOWATTS_PER_SQUARE_METER
• LITER
• LITERS_PER_SECOND
• LUX
• MEGAWATTS
• METERS
• METERS_PER_SECOND
• MILLIMETERS
• MILLI_AMPERE
• MICRO_AMPERE
• MICROGRAM_PER_CUBIC_METER
• NITS
• PARTS_PER_MILLION
• PASCAL
• PERCENTAGE
• POUNDS_PER_CUBIC_FOOT
• PRESENCE
• R_VALUE
• RELATIVE_HUMIDITY
• REVOLUTIONS_PER_MINUTE
• SQUARE_FEET
• SQUARE_METERS
• SQUARE_METERS_KELVIN_PER_WATTS
• VOLT
• WATTS
• WATTS_PER_METER_KELVIN
• WATTS_PER_METER_SQUARE
• WATTS_PER_SQUARE_METER_KELVIN
• WATTS_PER_SQUARE_METER_PER_DEGREE_CELSIUS

MeterAccumulationFrequency

• DAILY
• WEEKLY
• MONTHLY
• QUARTERLY
• YEARLY
• NONE

MeterMeasureMode

• MANUAL
• AUTOMATIC

MeterType

• ELECTRICITY
• POWER
• FLOW
• HEAT
• GAS

OpenSpaceType

• PARKING_GARAGE
• POOL_AREA
• OPEN_OFFICE
• HALL
• CORRIDOR
• STAIR_AREA
• DINING_AREA
• ESCALATOR_AREA
• RECEPTION_AREA
• TODDLERS_AREA
• OPEN_AREA
• SITTING_AREA
• OTHER

OperationType

• CHARGING
• DISCHARGING

PowerState

• ON
• OFF
• STANDBY
• OUT_OF_SERVICE
• VARIABLE_SPEED
• INTERMITTENT
• BOOST
• NIGHT_MODE
• NONE
• OTHER

PumpType

• CENTRIFUGAL
• OFF
• CIRCULATOR
• CONDENSER
• BOOSTER
• CONDENSATE
• OTHER

RadiantSlabType

• ELECTRIC
• AIR_HEATED
• HYDRONIC
• OTHER

RecordingTypes

• BINARY
• LINEAR
• CONTINUOUS
• EXPONENTIAL

RefrigerantType

• R134A
• R410A
• R22
• R404A
• R1234YF
• R1234ZE

RoomType

• OFFICE
• KITCHEN
• BEDROOM
• LIVING
• DINNING
• PANTRY
• STORAGE
• LIBRARY
• WASHROOM
• RESEARCH_LAB
• COMPUTER_LAB
• LAUNDRY
• GARAGE
• INDOOR_PARKING
• DATA_CENTER
• MECHANICAL
• CLASSROOM
• COMMON
• LAVATORY
• HOUSE_KEEPING
• MAINTENANCE
• CAFETERIA
• FILE
• LOUNGE
• SUPPORT_SPACE
• STAFF
• ENTERTAINMENT
• CONCIERGE
• FIRE
• ELECTRIC
• MULTIFUNCTIONAL
• TRIAGE
• LOCKER
• JANITOR_CLOSET
• PHOTO
• READING
• COMPUTER_SERVICE
• COMMUNITY_SERVICE
• CONSULTATION
• SEMINAR
• SPECIALISED_CLASSROOM
• MAIL_ROOM
• BOOKSTORE
• STUDY_ROOM
• OTHER

SensorLogType

• POLLING
• CHANGE_OF_VALUE

SensorMeasure

• TEMPERATURE
• PRESSURE
• GAS_VELOCITY
• LIQUID_VELOCITY
• LUMINANCE
• CARBON_DIOXIDE
• NOISE
• CURRENT
• VOLTAGE
• GLOBAL_RADIATION
• DIRECT_RADIATION
• SMOKE
• OCCUPANCY
• DAYLIGHT
• AIR_VOLUME
• HUMIDITY
• OTHER

SensorMeasureType

• THERMO_COUPLE_TYPE_A
• THERMO_COUPLE_TYPE_B
• THERMO_COUPLE_TYPE_C
• THERMO_COUPLE_TYPE_D
• THERMO_COUPLE_TYPE_E
• THERMO_COUPLE_TYPE_F
• PT_100
• PIEZO_RESISTIVE_PRESSURE
• ANALOGUE_PRESSURE
• PASSIVE_INFRARED

SensorPVType

• BUILDING_INTEGRATED_PHOTOVOLTAIC
• BUILDING_INTEGRATED_PHOTOVOLTAIC_THERMAL
• OTHER

SolarDistributionType

• FULL_EXTERIOR
• MINIMAL_SHADOWING
• FULL_INTERIOR_AND_EXTERIOR
• FULL_EXTERIOR_WITH_REFLECTIONS
• FULL_INTERIOR_AND_EXTERIOR_WITH_REFLECTIONS

TriggerType

• ON
• OFF
• OPEN
• CLOSE
• OPEN_CLOSE

TerrainType

• SUBURBS
• COUNTRY
• CITY
• OCEAN
• URBAN

UPSPhase

• SINGLE
• THREE
• SPLIT

V2GMode

• FREQUENCY_REGULATION
• PEAK_SHAVING
• ENERGY_ARBITRAGE
• OTHER

VentilationType

• AIR_HANDLING_UNIT

WaveForm

• SINUSOIDAL = "Sinusoidal"
• SQUARE = "Square"
• MODIFIED_SINE = "ModifiedSine"
• OTHER = "Other"

WindTurbineType

• VERTICAL_AXIS_WIND_TURBINE_ON_SHORE = "VAWTOnShore"
• HORIZONTAL_AXIS_WIND_TURBINE_ON_SHORE = "HAWTOnShore"
• VERTICAL_AXIS_WIND_TURBINE_OFF_SHORE = "VAWTOffShore"
• HORIZONTAL_AXIS_WIND_TURBINE_OFF_SHORE = "HAWTOffShore"
• OTHER = "Other"

ZoneType

• HVAC = "HVAC"
• LIGHTING = "Lighting"