added examples to some docstrings

Hochfrequenz · Mar 4, 2024 · 76cd270 · 76cd270
1 parent f977e95
commit 76cd270
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 3 deletions.
diff --git a/src/migmose/mig/nachrichtenstrukturzeile.py b/src/migmose/mig/nachrichtenstrukturzeile.py
@@ -7,7 +7,18 @@
 
 class NachrichtenstrukturZeile(BaseModel):
     """
-    class for lines in mig tables
+    class for lines in mig tables, e.g. (ORDCHG):
+    {
+        "zaehler": "0010",
+        "nr": "1",
+        "bezeichnung": "UNH",
+        "standard_status": "M",
+        "bdew_status": "M",
+        "standard_maximale_wiederholungen": 1,
+        "bdew_maximale_wiederholungen": 1,
+        "ebene": 0,
+        "inhalt": "Nachrichten-Kopfsegment"
+        }
     """
 
     zaehler: str

diff --git a/src/migmose/mig/segmentgruppe.py b/src/migmose/mig/segmentgruppe.py
@@ -7,8 +7,53 @@
 
 class SegmentGruppe(NachrichtenstrukturZeile):
     """
-    class for structured segmentgroups in mig tables. builds table recursively. inherits from NachrichtenstrukturZeile
+    class for structured segmentgroups in mig tables. Builds table recursively. Inherits from NachrichtenstrukturZeile
+    e.g.(ORDCHG):
+    {
+    "segmente": [
+        {
+        "zaehler": "0160",
+        "nr": "7",
+        "bezeichnung": "NAD",
+        "standard_status": "M",
+        "bdew_status": "M",
+        "standard_maximale_wiederholungen": 1,
+        "bdew_maximale_wiederholungen": 1,
+        "ebene": 1,
+        "inhalt": "MP-ID Absender"
+        }
+        ],
+    "segmentgruppen": [
+    {
+        "segmente": [
+        {
+            "zaehler": "0260",
+            "nr": "8",
+            "bezeichnung": "CTA",
+            "standard_status": "M",
+            "bdew_status": "M",
+            "standard_maximale_wiederholungen": 1,
+            "bdew_maximale_wiederholungen": 1,
+            "ebene": 2,
+            "inhalt": "Ansprechpartner"
+            },
+            {
+            "zaehler": "0270",
+            "nr": "9",
+            "bezeichnung": "COM",
+            "standard_status": "C",
+            "bdew_status": "R",
+            "standard_maximale_wiederholungen": 5,
+            "bdew_maximale_wiederholungen": 5,
+            "ebene": 3,
+            "inhalt": "Kommunikationsverbindung"
+            }
+            ],
+        "segmentgruppen": []
+        }
+        ]
+    }
     """
 
     segmente: list[NachrichtenstrukturZeile]
-    segmentgruppe: list["SegmentGruppe"]
+    segmentgruppen: list["SegmentGruppe"]