"""
Contains Marktlokation class
and corresponding marshmallow schema for de-/serialization
"""
# pylint: disable=too-many-instance-attributes, too-few-public-methods
from typing import TYPE_CHECKING, Annotated, Literal, Optional
from pydantic import Field
from ..enum.typ import Typ
from ..utils import postprocess_docstring
from .geschaeftsobjekt import Geschaeftsobjekt
if TYPE_CHECKING:
from ..com.adresse import Adresse
from ..com.geokoordinaten import Geokoordinaten
from ..com.katasteradresse import Katasteradresse
from ..com.verbrauch import Verbrauch
from ..com.zaehlwerk import Zaehlwerk
from ..enum.bilanzierungsmethode import Bilanzierungsmethode
from ..enum.energierichtung import Energierichtung
from ..enum.gasqualitaet import Gasqualitaet
from ..enum.gebiettyp import Gebiettyp
from ..enum.kundentyp import Kundentyp
from ..enum.netzebene import Netzebene
from ..enum.sparte import Sparte
from ..enum.verbrauchsart import Verbrauchsart
from .geschaeftspartner import Geschaeftspartner
from .lokationszuordnung import Lokationszuordnung
# pylint: disable=no-name-in-module
[docs]
@postprocess_docstring
class Marktlokation(Geschaeftsobjekt):
"""
Object containing information about a Marktlokation
.. raw:: html
<object data="../_static/images/bo4e/bo/Marktlokation.svg" type="image/svg+xml"></object>
.. HINT::
`Marktlokation JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/bo/Marktlokation.json>`_
"""
typ: Annotated[Literal[Typ.MARKTLOKATION], Field(alias="_typ")] = Typ.MARKTLOKATION
marktlokations_id: Optional[str] = None
"""Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird."""
sparte: Optional["Sparte"] = None
"""Sparte der Marktlokation, z.B. Gas oder Strom"""
energierichtung: Optional["Energierichtung"] = None
"""Kennzeichnung, ob Energie eingespeist oder entnommen (ausgespeist) wird"""
bilanzierungsmethode: Optional["Bilanzierungsmethode"] = None
"""Die Bilanzierungsmethode, RLM oder SLP"""
netzebene: Optional["Netzebene"] = None
"""
Netzebene, in der der Bezug der Energie erfolgt.
Bei Strom Spannungsebene der Lieferung, bei Gas Druckstufe.
Beispiel Strom: Niederspannung Beispiel Gas: Niederdruck.
"""
verbrauchsart: Optional["Verbrauchsart"] = None
"""Verbrauchsart der Marktlokation."""
ist_unterbrechbar: Optional[bool] = None
"""Gibt an, ob es sich um eine unterbrechbare Belieferung handelt"""
netzbetreibercodenr: Optional[str] = None
"""Codenummer des Netzbetreibers, an dessen Netz diese Marktlokation angeschlossen ist."""
gebietstyp: Optional["Gebiettyp"] = None
"""Typ des Netzgebietes, z.B. Verteilnetz"""
netzgebietsnr: Optional[str] = None
"""Die ID des Gebietes in der ene't-Datenbank""" # todo: rename to "id" (see 2021-12-15 update)
bilanzierungsgebiet: Optional[str] = None
"""Bilanzierungsgebiet, dem das Netzgebiet zugeordnet ist - im Falle eines Strom Netzes"""
grundversorgercodenr: Optional[str] = None
"""Codenummer des Grundversorgers, der für diese Marktlokation zuständig ist"""
gasqualitaet: Optional["Gasqualitaet"] = None
"""Die Gasqualität in diesem Netzgebiet. H-Gas oder L-Gas. Im Falle eines Gas-Netzes"""
endkunde: Optional["Geschaeftspartner"] = None
"""Geschäftspartner, dem diese Marktlokation gehört"""
# only one of the following three optional attributes can be set
lokationsadresse: Optional["Adresse"] = None
"""Die Adresse, an der die Energie-Lieferung oder -Einspeisung erfolgt"""
geoadresse: Optional["Geokoordinaten"] = None
"""
Alternativ zu einer postalischen Adresse kann hier ein Ort mittels Geokoordinaten angegeben werden
(z.B. zur Identifikation von Sendemasten).
"""
katasterinformation: Optional["Katasteradresse"] = None
"""
Alternativ zu einer postalischen Adresse und Geokoordinaten kann hier eine Ortsangabe mittels Gemarkung und
Flurstück erfolgen.
"""
kundengruppen: Optional[list["Kundentyp"]] = None
"""Kundengruppen der Marktlokation"""
regelzone: Optional[str] = None
"""für Strom. Code vom EIC, https://www.entsoe.eu/data/energy-identification-codes-eic/eic-approved-codes/"""
marktgebiet: Optional[str] = None
"""für Gas. Code vom EIC, https://www.entsog.eu/data/data-portal/codes-list"""
zaehlwerke: Optional[list["Zaehlwerk"]] = None
verbrauchsmengen: Optional[list["Verbrauch"]] = None
zaehlwerke_der_beteiligten_marktrolle: Optional[list["Zaehlwerk"]] = None
lokationszuordnungen: Optional[list["Lokationszuordnung"]] = None
"""Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben"""
lokationsbuendel_objektcode: Optional[str] = None
"""Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt."""