Add new BO Zaehlzeitdefinition

Author: lord-haffi

src/bo4e/bo/zaehlzeitdefinition.py

@@ -0,0 +1,49 @@
+"""
+Contains Zaehlzeitdefinition class
+"""
+
+# pylint: disable=unused-argument
+# pylint: disable=no-name-in-module
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
+
+from pydantic import Field
+
+from ..enum.botyp import BoTyp
+from ..utils import postprocess_docstring
+from .geschaeftsobjekt import Geschaeftsobjekt
+
+if TYPE_CHECKING:
+    from ..com.umschaltzeit import Umschaltzeit
+    from ..enum.wiederholungstyp import Wiederholungstyp
+
+# pylint: disable=too-many-instance-attributes, too-few-public-methods
+
+
+@postprocess_docstring
+class Zaehlzeitdefinition(Geschaeftsobjekt):
+    """
+    Beinhaltet Informationen zu welchen Zeiten welche Register zählen.
+
+    .. raw:: html
+
+        <object data="../_static/images/bo4e/bo/Zaehlzeitdefinition.svg" type="image/svg+xml"></object>
+
+    .. HINT::
+        `Zaehlzeitdefinition JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/bo/Zaehlzeitdefinition.json>`_
+
+    """
+
+    typ: Annotated[Literal[BoTyp.ZAEHLZEITDEFINITION], Field(alias="_typ")] = BoTyp.ZAEHLZEITDEFINITION
+
+    wiederholend: Optional["Wiederholungstyp"] = None
+    """Dieses Feld gibt an, an welchen Tagen das Schaltschema gilt, das durch die Umschaltzeiten definiert ist."""
+    umschaltzeiten: Optional[list["Umschaltzeit"]] = None
+    """
+    Die einzelnen Umschaltzeiten in dieser Liste definieren, zu welchen Uhrzeiten welches Register zählt.
+
+    Die Liste füllt stets einen ganzen Tag vollständig und überlappungsfrei aus. Die jeweilige Umschaltzeit in jedem
+    Objekt der Liste ergibt (wenn der Größe nach sortiert) ein entsprechendes Schema, wobei die untere Grenze (inklusiv)
+    als 00:00 Uhr und die obere Grenze (exklusiv) als 24:00 Uhr definiert ist.
+
+    Anmerkung: Die Umschaltzeiten sollten sich natürlich niemals doppeln.
+    """

src/bo4e/com/umschaltzeit.py

@@ -0,0 +1,37 @@
+"""
+Contains Umschaltzeit class
+"""
+
+from datetime import time
+
+# pylint: disable=too-few-public-methods
+# pylint: disable=no-name-in-module
+from typing import Annotated, Literal, Optional
+
+from pydantic import Field
+
+from ..enum.comtyp import ComTyp
+from ..utils import postprocess_docstring
+from .com import COM
+
+
+@postprocess_docstring
+class Umschaltzeit(COM):
+    """
+    Modelliert eine Umschaltzeit, wann auf ein bestimmtes Register geschaltet werden soll.
+
+    .. raw:: html
+
+        <object data="../_static/images/bo4e/com/Umschaltzeit.svg" type="image/svg+xml"></object>
+
+    .. HINT::
+        `Umschaltzeit JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/com/Umschaltzeit.json>`_
+
+    """
+
+    typ: Annotated[Literal[ComTyp.UMSCHALTZEIT], Field(alias="_typ")] = ComTyp.UMSCHALTZEIT
+
+    umschaltzeit: Optional[time] = None
+    """Definiert den Zeitpunkt ab dem auf das Register geschaltet wird, das im Feld `registercode` spezifiziert ist."""
+    registercode: Optional[str] = None
+    """Ein Code, der ein Register spezifiziert. Typischerweise eine 3-stellige Zeichenkette."""

src/bo4e/enum/botyp.py

@@ -50,5 +50,6 @@ class BoTyp(StrEnum):
     TARIFPREISBLATT = "TARIFPREISBLATT"
     VERTRAG = "VERTRAG"
     ZAEHLER = "ZAEHLER"
+    ZAEHLZEITDEFINITION = "ZAEHLZEITDEFINITION"
     ZEITREIHE = "ZEITREIHE"
     LOKATIONSZUORDNUNG = "LOKATIONSZUORDNUNG"

src/bo4e/enum/comtyp.py

@@ -63,6 +63,7 @@ class ComTyp(StrEnum):
     TARIFPREISPOSITION = "TARIFPREISPOSITION"
     TARIFPREISPOSITIONPROORT = "TARIFPREISPOSITIONPROORT"
     TARIFPREISSTAFFELPROORT = "TARIFPREISSTAFFELPROORT"
+    UMSCHALTZEIT = "UMSCHALTZEIT"
     UNTERSCHRIFT = "UNTERSCHRIFT"
     VERBRAUCH = "VERBRAUCH"
     VERTRAGSKONDITIONEN = "VERTRAGSKONDITIONEN"

src/bo4e/enum/wiederholungstyp.py

@@ -0,0 +1,21 @@
+# pylint: disable=missing-module-docstring
+from bo4e.enum.strenum import StrEnum
+
+
+class Wiederholungstyp(StrEnum):
+    """
+    Gibt an zu welchen Tagen etwas wiederholt werden soll.
+    """
+
+    TAEGLICH = "TAEGLICH"
+    WERKTAGS = "WERKTAGS"
+    WOCHENENDE = "WOCHENENDE"
+    FEIERTAGS = "FEIERTAGS"
+
+    MONTAGS = "MONTAGS"
+    DIENSTAGS = "DIENSTAGS"
+    MITTWOCHS = "MITTWOCHS"
+    DONNERTAGS = "DONNERTAGS"
+    FREITAGS = "FREITAGS"
+    SAMSTAGS = "SAMSTAGS"
+    SONNTAGS = "SONNTAGS"