hub/city_model_structure/material.py

"""
LifeCycleAssessment retrieve the specific Life Cycle Assessment module for the given region
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Atiya
"""

class Material:
  """
  LCA Material class
  """

  def __init__(self, type, material_id, material_name, density, density_unit, embodied_carbon, embodied_carbon_unit, recycling_ratio,
               onsite_recycling_ratio, company_recycling_ratio, landfilling_ratio, cost, cost_unit):
    self._type = type
    self._material_id = material_id
    self._material_name = material_name
    self._density = density
    self._density_unit = density_unit
    self._embodied_carbon = embodied_carbon
    self._embodied_carbon_unit = embodied_carbon_unit
    self._recycling_ratio = recycling_ratio
    self._onsite_recycling_ratio = onsite_recycling_ratio
    self._company_recycling_ratio = company_recycling_ratio
    self._landfilling_ratio = landfilling_ratio
    self._cost = cost
    self._cost_unit = cost_unit

  @property
  def material_name(self) -> str:
    """
    Get material name
    :return: str
    """
    return self._material_name

  @property
  def id(self) -> int:
    """
    Get material id
    :return: int
    """
    return self._material_id

  @property
  def type(self) -> str:
    """
    Get material type
    :return: str
    """
    return self._type

  @property
  def density(self) -> float:
    """
    Get material density
    :return: float
    """
    return self._density

  @property
  def density_unit(self) -> str:
    """
    Get material density unit
    :return: str
    """
    return self._density_unit

  @property
  def embodied_carbon(self) -> float:
    """
    Get material embodied carbon
    :return: float
    """
    return self._embodied_carbon

  @property
  def embodied_carbon_unit(self) -> str:
    """
    Get material embodied carbon unit
    :return: str
    """
    return self._embodied_carbon_unit

  @property
  def recycling_ratio(self) -> float:
    """
    Get material recycling ratio
    :return: float
    """
    return self._recycling_ratio

  @property
  def onsite_recycling_ratio(self) -> float:
    """
    Get material onsite recycling ratio
    :return: float
    """
    return self._onsite_recycling_ratio

  @property
  def company_recycling_ratio(self) -> float:
    """
    Get material company recycling ratio
    :return: float
    """
    return self._company_recycling_ratio

  @property
  def landfilling_ratio(self) -> float:
    """
    Get material landfilling ratio
    :return: float
    """
    return self._landfilling_ratio

  @property
  def cost(self) -> float:
    """
    Get material cost
    :return: float
    """
    return self._cost

  @property
  def cost_unit(self) -> str:
    """
    Get material cost unit
    :return: str
    """
    return self._cost_unit