Skip to content

Commit 06e8a8e

Browse files
committed
Model new COM Regionszeitscheibe
1 parent c39961a commit 06e8a8e

2 files changed

Lines changed: 44 additions & 0 deletions

File tree

src/bo4e/com/regionszeitscheibe.py

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
"""
2+
Contains Regionszeitscheibe class
3+
"""
4+
5+
from decimal import Decimal
6+
from typing import TYPE_CHECKING, Annotated, Literal, Optional
7+
8+
from pydantic import Field
9+
10+
from ..enum.comtyp import ComTyp
11+
from ..utils import postprocess_docstring
12+
from .com import COM
13+
14+
if TYPE_CHECKING:
15+
from ..bo.region import Region
16+
from .zeitraum import Zeitraum
17+
18+
19+
# pylint: disable=too-few-public-methods
20+
21+
22+
@postprocess_docstring
23+
class Regionszeitscheibe(COM):
24+
"""
25+
Komponente zur Abbildung einer Region mit einer Zeitscheibe.
26+
27+
.. raw:: html
28+
29+
<object data="../_static/images/bo4e/com/Regionszeitscheibe.svg" type="image/svg+xml"></object>
30+
31+
.. HINT::
32+
`Regionszeitscheibe JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/com/Regionszeitscheibe.json>`_
33+
34+
"""
35+
36+
typ: Annotated[Literal[ComTyp.REGIONSZEITSCHEIBE], Field(alias="_typ")] = ComTyp.REGIONSZEITSCHEIBE
37+
38+
region: Optional["Region"] = None
39+
"""Die Region wird durch das Feld `zeitscheibengueltigkeit ` mit einer Zeitscheibe versehen."""
40+
zeitscheibengueltigkeit: Optional["Zeitraum"] = None
41+
"""
42+
Versieht die Region mit einer Zeitscheibe. Der Start- und Endzeitpunkt sollte durch das Objekt ermittelbar sein.
43+
"""

src/bo4e/enum/comtyp.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ class ComTyp(StrEnum):
5050
REGIONALERAUFABSCHLAG = "REGIONALERAUFABSCHLAG"
5151
REGIONALETARIFPREISPOSITION = "REGIONALETARIFPREISPOSITION"
5252
REGIONSOPERATION = "REGIONSOPERATION"
53+
REGIONSZEITSCHEIBE = "REGIONSZEITSCHEIBE"
5354
SIGMOIDPARAMETER = "SIGMOIDPARAMETER"
5455
STANDORTEIGENSCHAFTENGAS = "STANDORTEIGENSCHAFTENGAS"
5556
STANDORTEIGENSCHAFTENSTROM = "STANDORTEIGENSCHAFTENSTROM"

0 commit comments

Comments
 (0)