docs: dokumentiere gisLines und gisLinesStatus Services in Markdown
- erstellt fetchGisLinesService.md (Liniengeometrien aus Datenbank) - erstellt fetchGisLinesStatusService.md (Linienstatus aus WebService) - beschreibt Unterschiede zwischen beiden Datenquellen - verbessert Entwicklerverständnis und Wartbarkeit
This commit is contained in:
@@ -1,2 +1,2 @@
|
||||
// /config/appVersion
|
||||
export const APP_VERSION = "1.1.145";
|
||||
export const APP_VERSION = "1.1.146";
|
||||
|
||||
65
docs/frontend/services/database/fetchGisLinesService.md
Normal file
65
docs/frontend/services/database/fetchGisLinesService.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# fetchGisLinesService
|
||||
|
||||
Lädt Linien-Geometriedaten über die interne Datenbank-API.
|
||||
|
||||
---
|
||||
|
||||
## 📁 URL-Aufbau
|
||||
|
||||
```
|
||||
/api/talas_v5_DB/gisLines/readGisLines
|
||||
```
|
||||
|
||||
- Die Daten werden nicht über einen WebService geladen, sondern über einen internen Datenbank-Endpunkt im Backend (API Route).
|
||||
- Es handelt sich um Polyline-Daten (z. B. Kabelverbindungen).
|
||||
|
||||
---
|
||||
|
||||
## ✅ Rückgabe
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"idLD": 12345,
|
||||
"idModul": 6,
|
||||
"points": [
|
||||
{ "x": 8.123, "y": 53.456 },
|
||||
{ "x": 8.124, "y": 53.457 }
|
||||
]
|
||||
},
|
||||
...
|
||||
]
|
||||
```
|
||||
|
||||
- `points[]` enthält die Koordinaten der Liniensegmente
|
||||
- Die Struktur ist geeignet für Leaflet-Polyline-Rendering
|
||||
|
||||
---
|
||||
|
||||
## ❗ Unterschied zu `gisLinesStatusSlice` (WebService)
|
||||
|
||||
| Eigenschaft | `gisLines` (Datenbank) | `gisLinesStatus` (WebService) |
|
||||
| ----------- | -------------------------------- | ----------------------------------- |
|
||||
| Quelle | `/api/talas_v5_DB/gisLines` | `WebServiceMap.asmx/GisLinesStatus` |
|
||||
| Daten | Liniengeometrien (`points`) | Status, Meldungen, Farben, Werte |
|
||||
| Typ | Polyline-Rendering | Statusanzeige für Linien |
|
||||
| Nutzung | Anzeige der Linien auf der Karte | Visualisierung von Fehlern/Farben |
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Verwendung im Frontend
|
||||
|
||||
- Daten werden über `fetchGisLinesThunk` geladen.
|
||||
- Sie landen im Redux Slice `gisLinesSlice`.
|
||||
- Zugriff über: `selectGisLines(state)`
|
||||
|
||||
---
|
||||
|
||||
## 📁 Zugehörige Dateien
|
||||
|
||||
| Datei | Zweck |
|
||||
| ------------------------- | --------------------------- |
|
||||
| `fetchGisLinesService.js` | Datenbank-Aufruf für Linien |
|
||||
| `fetchGisLinesThunk.js` | Redux Thunk |
|
||||
| `gisLinesSlice.js` | Redux Slice |
|
||||
| `store.js` | Integration des Slices |
|
||||
@@ -0,0 +1,58 @@
|
||||
# fetchGisLinesStatusService
|
||||
|
||||
Lädt Linienstatus-Daten über den TALAS WebService.
|
||||
|
||||
---
|
||||
|
||||
## 📁 URL-Aufbau
|
||||
|
||||
```
|
||||
/ClientData/WebServiceMap.asmx/GisLinesStatus?idMap={idMap}
|
||||
```
|
||||
|
||||
* Die `idMap` wird automatisch aus der URL (`?m=...`) gelesen.
|
||||
* Diese WebService-Antwort enthält ein Objekt mit dem Feld `Statis[]`.
|
||||
|
||||
---
|
||||
|
||||
## ✅ Rückgabe
|
||||
|
||||
```json
|
||||
{
|
||||
"Name": "...",
|
||||
"Statis": [ ... ]
|
||||
}
|
||||
```
|
||||
|
||||
* `Statis[]` enthält Statusinformationen zu Linien (Farben, Meldungen, Werte).
|
||||
* Diese Daten sind **nicht identisch** mit `gisLines.data` aus der Datenbank.
|
||||
|
||||
---
|
||||
|
||||
## ❗ Unterschied zu `gisLinesSlice` (aus der Datenbank)
|
||||
|
||||
| Eigenschaft | `gisLines` (DB) | `gisLinesStatus` (WebService) |
|
||||
| ----------- | --------------------------- | ----------------------------------- |
|
||||
| Quelle | `api/talas_v5_DB/gisLines` | `WebServiceMap.asmx/GisLinesStatus` |
|
||||
| Daten | Liniengeometrien (`points`) | Status, Meldungen, Farben, Werte |
|
||||
| Typ | `PolyLine-Daten` | `Statusanzeige` für Linien |
|
||||
| Nutzung | Layer-Rendering | Farbliche Darstellung / Tooltip |
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Verwendung im Frontend
|
||||
|
||||
* Die Daten werden über `fetchGisLinesStatusThunk` geladen.
|
||||
* Sie landen im Redux Slice `gisLinesStatusSlice`.
|
||||
* Zugriff über: `selectGisLinesStatus(state)` → enthält `.data`, `.status`, `.error`
|
||||
|
||||
---
|
||||
|
||||
## 📁 Zugehörige Dateien
|
||||
|
||||
| Datei | Zweck |
|
||||
| ------------------------------- | ---------------------- |
|
||||
| `fetchGisLinesStatusService.js` | WebService-Aufruf |
|
||||
| `fetchGisLinesStatusThunk.js` | Redux Thunk |
|
||||
| `gisLinesStatusSlice.js` | Redux Slice |
|
||||
| `store.js` | Integration des Slices |
|
||||
@@ -1,6 +0,0 @@
|
||||
# fetchGisStatusStationsService
|
||||
|
||||
Lädt GIS-Statusdaten mit Timeout.
|
||||
|
||||
- Erwartet `idMap` und `idUser` als Parameter.
|
||||
- Nutzt `fetchWithTimeout` mit 5s-Abbruchlogik.
|
||||
Reference in New Issue
Block a user