hub/city_model_structure/building_demand/usage_zone.py

"""
UsageZone module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
Contributors Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
"""
import uuid
from typing import List, TypeVar

InternalGains = TypeVar('InternalGains')
Occupants = TypeVar('Occupants')
Polyhedron = TypeVar('Polyhedron')


class UsageZone:
  """
  UsageZone class
  """
  def __init__(self):
    self._id = None
    self._usage = None
    self._internal_gains = None
    self._heating_setpoint = None
    self._heating_setback = None
    self._cooling_setpoint = None
    self._occupancy_density = None
    self._hours_day = None
    self._days_year = None
    self._dhw_average_volume_pers_day = None
    self._dhw_preparation_temperature = None
    self._electrical_app_average_consumption_sqm_year = None
    self._mechanical_air_change = None
    self._occupants = None
    self._heating_schedule = None
    self._cooling_schedule = None
    self._ventilation_schedule = None
    self._schedules = None
    self._volume = None
    self._volume_geometry = None

  @property
  def id(self):
    """
    Get usage zone id, an universally unique identifier randomly generated
    :return: str
    """
    if self._id is None:
      self._id = uuid.uuid4()
    return self._id

  @property
  def internal_gains(self) -> List[InternalGains]:
    """
    Get usage zone internal gains
    :return: [InternalGains]
    """
    return self._internal_gains

  @internal_gains.setter
  def internal_gains(self, value):
    """
    Set usage zone internal gains
    :param value: [InternalGains]
    """
    self._internal_gains = value

  @property
  def heating_setpoint(self):
    """
    Get usage zone heating set point in celsius grads
    :return: float
    """
    return self._heating_setpoint

  @heating_setpoint.setter
  def heating_setpoint(self, value):
    """
    Set usage zone heating set point in celsius grads
    :param value: float
    """
    self._heating_setpoint = value

  @property
  def heating_setback(self):
    """
    Get usage zone heating setback in celsius grads
    :return: float
    """
    return self._heating_setback

  @heating_setback.setter
  def heating_setback(self, value):
    """
    Set usage zone heating setback in celsius grads
    :param value: float
    """
    self._heating_setback = value

  @property
  def cooling_setpoint(self):
    """
    Get usage zone cooling setpoint in celsius grads
    :return: float
    """
    return self._cooling_setpoint

  @cooling_setpoint.setter
  def cooling_setpoint(self, value):
    """
    Set usage zone cooling setpoint in celsius grads
    :param value: float
    """
    self._cooling_setpoint = value

  @property
  def hours_day(self):
    """
    Get usage zone usage hours per day
    :return: float
    """
    return self._hours_day

  @hours_day.setter
  def hours_day(self, value):
    """
    Set usage zone usage hours per day
    :param value: float
    """
    self._hours_day = value

  @property
  def days_year(self):
    """
    Get usage zone usage days per year
    :return: float
    """
    return self._days_year

  @days_year.setter
  def days_year(self, value):
    """
    Set usage zone usage days per year
    :param value: float
    """
    self._days_year = value

  @property
  def mechanical_air_change(self):
    """
    Set usage zone mechanical air change in air change per hour (ACH)
    :return: float
    """
    return self._mechanical_air_change

  @mechanical_air_change.setter
  def mechanical_air_change(self, value):
    """
    Get usage zone mechanical air change in air change per hour (ACH)
    :param value: float
    """
    self._mechanical_air_change = value

  @property
  def usage(self):
    """
    Get usage zone usage
    :return: str
    """
    return self._usage

  @usage.setter
  def usage(self, value):
    """
    Get usage zone usage
    :param value: str
    """
    self._usage = value

  @property
  def occupants(self) -> List[Occupants]:
    """
    Get occupants data
    :return: [Occupants]
    """
    return self._occupants

  @occupants.setter
  def occupants(self, values):
    """
    Set occupants data
    :param values: [Occupants]
    """
    self._occupants = values

  @property
  def heating_schedule(self) -> dict:
    """
    Get heating schedules: list of 0, 1 that define whether the heating system should be OFF or ON
    :return: dict{DataFrame(int)}
    """
    return self._heating_schedule

  @heating_schedule.setter
  def heating_schedule(self, values):
    """
    heating schedules
    :param values: dict{DataFrame(int)}
    """
    self._heating_schedule = values

  @property
  def cooling_schedule(self) -> dict:
    """
    Get cooling schedules: list of 0, 1 that define whether the cooling system should be OFF or ON
    :return: dict{DataFrame(int)}
    """
    return self._cooling_schedule

  @cooling_schedule.setter
  def cooling_schedule(self, values):
    """
    cooling schedules
    :param values: dict{DataFrame(int)}
    """
    self._cooling_schedule = values

  @property
  def ventilation_schedule(self) -> dict:
    """
    Get ventilation schedules: list of 0, 1 that define whether the ventilation system should be OFF or ON
    :return: dict{DataFrame(int)}
    """
    return self._ventilation_schedule

  @ventilation_schedule.setter
  def ventilation_schedule(self, values):
    """
    ventilation_schedule schedules
    :param values: dict{DataFrame(int)}
    """
    self._ventilation_schedule = values

  @property
  def schedules(self) -> dict:
    """
    Get schedules of diverse issues in a dictionary
    :return: dict()
    """
    return self._schedules

  @schedules.setter
  def schedules(self, values):
    """
    Set schedules of diverse issues in a dictionary
    :param values: dict()
    """
    self._schedules = values

  @property
  def occupancy_density(self):
    """
    Get schedules density in persons per m2
    :return: float
    """
    return self._occupancy_density

  @occupancy_density.setter
  def occupancy_density(self, values):
    """
    schedules density in persons per m2
    :param values: float
    """
    self._occupancy_density = values

  @property
  def dhw_average_volume_pers_day(self):
    """
    Get average DHW consumption in m3 per person per day
    :return: float
    """
    return self._dhw_average_volume_pers_day

  @dhw_average_volume_pers_day.setter
  def dhw_average_volume_pers_day(self, values):
    """
    average DHW consumption in m3 per person per day
    :param values: float
    """
    self._dhw_average_volume_pers_day = values

  @property
  def dhw_preparation_temperature(self):
    """
    Get preparation temperature of the DHW in degree Celsius
    :return: float
    """
    return self._dhw_preparation_temperature

  @dhw_preparation_temperature.setter
  def dhw_preparation_temperature(self, values):
    """
    preparation temperature of the DHW in degree Celsius
    :param values: float
    """
    self._dhw_preparation_temperature = values

  @property
  def electrical_app_average_consumption_sqm_year(self):
    """
    Get average consumption of electrical appliances in Joules hour per m2 and year (J/m2yr)
    :return: float
    """
    return self._electrical_app_average_consumption_sqm_year

  @electrical_app_average_consumption_sqm_year.setter
  def electrical_app_average_consumption_sqm_year(self, values):
    """
    average consumption of electrical appliances in Joules per m2 and year (J/m2yr)
    :param values: float
    """
    self._electrical_app_average_consumption_sqm_year = values

  @property
  def volume_geometry(self) -> Polyhedron:
    """
    Get the polyhedron defined by the usage zone
    :return: Polyhedron
    """
    return self._volume_geometry

  @property
  def volume(self):
    """
    Get the volume in m3
    :return: float
    """
    return self._volume

  @volume.setter
  def volume(self, value):
    """
    Volume in m3 setter
    :param value: float
    """
    self._volume = value