# Spezifikation zum Entwicklungsprojekt "Data Lake Services zur interoperablen Datenverwaltung in Bauprojekten"

## Dokumentversion

| Datum | Änderungsbeschreibung |
| -------- | -------- |
| 08.02.2022 | Stichwortartige Spezifikations nach Meeting mit Entwicklerteam, Kunden und Product Owner |
| 18.02.2022 | Erste Fassung der Spezifikation |

<!--
## Disclaimer
Die in dieser Spezifikation gewählte männliche Form bezieht sich immer - sofern nicht ausdrücklich anders angegeben - zugleich auf weibliche, männliche und diverse Personen. Auf eine Mehrfachbezeichnung wird in der Regel zugunsten einer besseren Lesbarkeit verzichtet.
-->
<!--
Der GitLab Markdown-Interpreter verwendet eine andere Syntax für Links daher müssen diese angepasst werden.
HachMD Interne-Referenz-Synatx: [Title ohne Format](#Link)
Link: Leerzeichen ersetzt durch "-" und sonderzeichen weggelassen
Bsp.: [Architekt/-in](#Architekt/-in)
GitLab-Wiki Interne-Referenz-Syntax: [Title ohne Format](#Link)
Link: Pafad wirdv orran gestellt und Leerzeichen ersetzt durch "-" und sonderzeichen weggelassen
Bsp.: [Architekt/-in](Spezifikatoin/#architekt-in)
-->

## Deadlines
- 2022-03-22: Completed implementation of the functionality
- 2022-03-29: Final presentation

## Projektumgebung
> Shaping the future of architecture and the building industry

Diese Projekt findet im Zusammenhang mit dem Exzellenzcluster IntCDC der Universität Stuttgart. Dieses Exzellenzcluster beinhaltet insgesamt 20 Forschungsprojekte. Diese haben es sich zum Ziel gesetz die Zukunft der Architektur und Bauindustrie zu formen.

## Projektname
Dieses Projekt bestand ursprünglich aus drei Teilprojekten, von denen zwei aufgrund mangelnder Teilnehmerzahl nicht gestartet wurden. Der ursprüngliche Projektname lautet "Data Lake Services zur interoperablen Datenverwaltung in Bauprojekten" und spiegelt das aktuelle Projekt nicht wieder. Da dieses Projekt jedoch unter diesem Namen angemeldet wurde wird dieser beibehalten.

## Projekt-/Aufgabenbeschreibung
Es soll ein Konvertierer entwickelt werden der in der Lage ist automatisiert IFC-Dateien in G-Code zu überführen. Dieser G-Code besteht dabei aus, für CNC-Maschinen ausführbare Prozessanweisungen.
Es soll mindestens der MVP umgesetzt werden.

## Personen im Projekt
- Alexander Reichle (Kunde, Anwender) (hat das Projekt nach einem Monat verlassen)
- Carsten Ellwein (Kunde, Anwender) (hat Alexander Reichle ersetzt)
- Christian Bartsch (Entwickler)
- Christopher Dahl (Entwickler)
- Emil Czychon (Entwickler)
- Nico Lässig (Betreuer, Product Owner)
- Melanie Herschel (Prüferin, Managment)
- Andreas Farley (Scrum Master)
- Jochen Wimpff (Scrum Master)

## Was ist ein Entwicklungsprojekt an der Uni Stuttgart?
Das Entwicklungsprojekt ist ein Pflichtmodul für alle Master Softwaretechnik.
Inhalt:
> Entwicklung oder Änderung und Erweiterung eines Software-Systems, Erarbeitung der Anforderungen zusammen mit einem Kunden, Vollständige Durchführung mehrerer Iterationen, Vertiefung der Erfahrung mit agilen Vorgehensmodellen, insbesondere Scrum

Angestrebte Lernergebnisse:
> Vertiefung ihre Erfahrungen mit den Problemen in der Entwicklung und Wartung von größeren Softwaresystemen

Somit sollte der Prozess zum Endprodukt und nicht das Endprodukt selbst im Vordergrund stehen. Das Endprodukt stellt also eher ein "Proof-of-Conept" dar.

# Vorgehensmodell
Wie bereits im der erweiterten Erklärung zum Entwickungsprojekt beschrieben wird hier das agile Vorgehensmodell Scrum gewählt.
Hier die Aufgaben der unterschiedlichen Rollen im Scrum in Kürze:

## Entwickler/-in
Das Entwickler-Team sollte möglichst interdisziplinär aufgestellt sein. Der einzelne Entwickler hat folgende Aufgaben:
- Lieferung der Produktfunktionalitäten in der vom Product Owner gewünschten Reihenfolge
- Trägt Verantwortung für die Einhaltung der vereinbarten Qualitätsstandards
- Schätzt Umfang der Einträge im Product Backlog
- Teilt Einträge aus dem Product Backlog in Arbeitsschritte, sogenannte Tasks

## Kunde/-in
Gehört zu den drei Stakeholdern und hat folgende Aufgaben:
- Steht für die Dauer des Projekts im engen Austausch mit dem [Product Owner](#Product-Owner)
- Teilt [Product Owner](#Product-Owner) seine Wunschvorstellung für das Produkt mit

## Product Owner
Ist ein sehr wichtiges Bindeglied zwischen Kunden und Entwicklerteam und hat folgende Aufgaben:
- Erarbeitet und erläutert die zu entwickelnden Produkteigenschaften
- Erstellt in Zusammenarbeit mit dem [Entwicklungsteam](#Entwickler-in) und den Stakeholdern die Einträge im Product Backlog
- Ordnet, priorisiert, detailliert und aktualisiert das Product Backlog regelmäßig

## Scrum Master
Der Scrum Master ist dafür verantwortlich, dass Scrum als Rahmenwerk gelingt. Er/Sie tritt als Coach auf und gehört nicht zum [Entwicklungsteam](#Entwickler-in). Er/Sie hat folgende Aufgaben:
- Führt die Scrum-Regeln ein und überprüft deren Einhaltung
- kümmert sich um die Vermeidung und Behebung von Störungen und Hindernissen wie:
- mangelnde Kommunikation und Zusammenarbeit
- persönliche Konflikte im Entwicklungsteam
- Störungen in der Zusammenarbeit zwischen Product Owner und Entwicklungsteam
- Störungen von außen
- moderiert die Sprint Retrospektive und oft auch Sprint Planning und Backlog Refinement

## Management
Gehört zu den drei Stakeholdern und hat folgende Aufgaben:
- Trägt Verantwortung dafür, dass die Rahmenbedingungen stimmen wie:
- Bereitstellung von Räumen und Arbeitsmitteln
- Unterstützung für den eingeschlagenen Kurs des Projekts
- Verantwortlich, das Scrum-Team vor externen Arbeitsanforderungen zu schützen
- Finden von adäquate personelle Besetzungen
- [Scrum Master](#Scrum-Master) dabei zu unterstützen, Hindernisse auszuräumen

## Anwender/-in
Gehört zu den drei Stakeholdern und hat folgende Aufgaben:
- Beurteilt das Produkt aus der Perspektive des Nutzers

# Prototype
In diesem Kapitel soll der Umfang des Projekts genauer erläutert werden.

## Minimum Viable Product (MVP)
Hier werden nun User Stories aufgelistes die das MVP beschreiben:
- Als Bauunternehmer möchte ich, dass Gebäudepläne automatisiert in CNC-Maschinencode übersetzt werden um Personal zu sparen.
- Als Firmeninhaber möchte ich, dass auf meinem Server über Nacht (headless) Gebäudepläne in CNC-Maschinencode übersetzt werden um Zeit zu sparen.
- Als CNC-Maschinist/-in möchte ich, dass Gebäudepläne so in CNC-Maschinencode übersetzt werden das ich 3-Achsige CNC-Maschinen damit arbeiten lassen kann.
- Als CAM-Spezialist/-in möchte ich, dass bereits erstellte CAM-Strategien in einer Datenbank gespeichert werden können um diese wiederverwenden zu können.
- Als CAM-Spezialist/-in möchte ich, dass neue Objekte mit bereits vorhandenen CAM-Strategien verglichen werden um so diese bei großer Ähnlichkein adaptieren zu können und somit die manuelle Erstellung einer CAM-Strategie zu vermeiden
- Als CAM-Spezialist/-in möchte ich, dass ich pro Objekt pro Orientirung Operationen anlegen kann um das Umspannen bei 3-Achsige CNC-Maschinen zu ermöglichen.
- Als Architekt/-in möchte ich, dass [IFC4-Dateien (IFC4 ADD2 TC1)](https://technical.buildingsmart.org/standards/ifc/ifc-schema-specifications/) bzw. IFC-Dateien mit der neusten IFC Version verarbeitet werden können um mich nicht bei der Gestaltung der Gebäude einschränken zu müssen.
- Als CAM-Spezaialist möchte ich, dass Fertigungsgruppen (Wand mit Fenster) als solche markiert werden damit ich dies bei den CAM-Strategien berücksichtigen kann.
- Als CAM-Spezaialist möchte ich, dass zu fertigende Gebäude in einzelne Fertigungsgruppen (Wand mit Fenster) bzw. einzelne Fertigungsobjekte (Kasseten, Balken, Wand, Fenster, etc) zerteilt und mir dann zur Fertigungsplanung vorgelegt werden damit ich die einzelnen CAM-Strategien planen kann.

## Optionale Funktionalität
- Als CNC-Maschinist/-in möchte ich, dass Gebäudepläne so in CNC-Maschinencode übersetzt werden das ich CNC-Maschinen mit mehr als drei Achsen damit arbeiten lassen kann.
- Als IT-Verwalter möchte ich, dass die Datenbank möglichst wenig Speicherplatz benötigen damit die vorhandenen Speicherkapazitäten nicht angepasst werden müssen.
- Als Datenschutzbeauftragter möchte ich, dass die Authorisierung von Datenbankzugriggen geprüft wird um die Datenbank vor unberechtigten Zugriffen zu schützen.
- Als Datenbankspezialist möchte ich, dass Zugriffe auf die Datenbank parallel stattfinden können damit die Datenbank effizienter verwendet werden kann.
- Als CAM-Spezialist/-in möchte ich, dass zusätzliche Logs des Preprozessors, die hilfreich bei der Optimierung von CAM-Strategien hilfreich sein könnten mir zu Verfügung gestellt werden damit ich CAM-Strategien optimieren kann.

## Ausgeschlossene Funktionalität
- Optimale CAM-Strategie für ein gegebenes Objekt. Zur Vorführung reicht auch eine nicht Optimale CAM-Strategie.

## Rollen
In diesem Projekt sind verschiedene Rollen beteiligt die hier beschrieben werden.

### Architekt/-in
Diese Person kommt aus dem Bauswesen und hat Erfahrung in der Planung von Häusern. Er/Sie stellt die IFC-DAtei zu Verfügung. Diese Datei enthält mindest ein herzustellendes Objekt. Der/Die Architekt/-in ist dafür verantwortlich das die Objekte in Form und Anordnung Sinn ergeben.

### CAM-Spezialist/-in
Er/Sie hat Erfahrung in CAM-Strategien und stellt für gegebene CAD-Modelle CAM-Strategien mit allen benötigten Parametern zur Verfügung.
Der/Die CAM-Spezialist/-in kann über den [Rücklauf](#Rückführung) benachrichtigt werden eine CAM-Strategie für ein oder mehrere gegebene Objekte anzufertigen. Ist die geforderte CAM-Strategie erstellt, wird sie in der [Datenbank](#Datenbank) hinterlegt aber auch an die FreeCAD-Internals geschickt um den G-Code für dieses Objekt zu fertigen.

### CNC-Maschinist/-in
Der/Die CNC-Maschinist/-in weiß welche Maschine vor Ort welche Maschinenaufsätze besitzt und stellt aufgrund dessen die Toolbox zur Verfügung. Diese Toolbox muss nur einmal pro Maschine erstellt werden. Diese Toolbox wird vom dem/der CNC-Maschinist/-in aktuell gehalten.

## Shape-Matching
Dies ist der Kern des Projekts. Dies soll über ein Vergleich auf der 3D-Geometrie stattfinden.
Dazu sind wird eine [Datenbank](#Datenbank) im weiteren Sinne benötigt.
Das zu entwickelnde Programm soll die einzelnen Objekte aus der IFC-Datei mit Objekten in der [Datenbank](#Datenbank) vergleichen.
Dabei ist es wichtig eine Ähnlichkeit zu ermitteln, sodass die CAM-Strategie des Objekts aus der Datenbank übernommen werden kann. Es gelten zwei Objekte als ähnlich, wenn Änderungen in der Größe eines Objekts oder einzelner Ebenen(Faces) oder Kanten(Edge) nicht zu einer Änderung der Topologie führen bzw. keine Features hinzukommen.

## Datenbank
Im Zuge dieses Projekts ist es nötig eine Datenbank im weiteren Sinne zu verwenden. Für das [MVP](#Minimum-Viable-Product-MVP) soll dies lokal ohne Datenbankmanagmentsystem umgesetzt werden, beispielsweise als lokaler Dateiordner.
Da somit keine Datenbankverwaltungssystem verwendet wird wird folgendes NICHT unterstützt:
- Optimierung von Zugriffen
- Authorizationsprüfungen
- Paralelle Schreibzugriffe auf die selbe Datei
- Parallele Lesezugriffe auf die selbe Datei
Die Datenbank soll CAM-Strategien enthalten. Die Geometrie der Objekte in diesen CAM-Strategien soll im [Shape-Matching](#Shape-Matching) verglichen werden.

## Rückführung
Kann ein Objekt aus einer IFC-Datei nicht mit einem Objekt in der [Datenbank](#Datenbank) gematched werden soll es einen Rücklauf zum [CAM-Spezialist/-in](#CAM-Spezialist-in) geben. In diesem Fall soll eine Benachrichtigung des [CAM-Spezialist/-in](#CAM-Spezialist-in) im weiteren Sinne ausgeführt werden. In der Benachrichtigung sind die Objekte enthalten die nicht gematched wurden konnten.

## Zerlegung von Gesamtstrukturen in Fertigungsobjekten und -gruppen
In IFC-Files werden häufig ganze Gebäude bzw. Gesamtstrukturen zusammen gespeichert. Diese werden, in den meisten Fällen, aber nicht im ganzen gefertigt. Daher ist eine Zerlegung von Gebäuden in Fertigungsobjekte bzw. -gruppen gefordert.
Sollen Objekte als Gruppe, und nicht einzeln, gefertigt werden so muss dies bereits von dem/der [Architekt/-in](#Architekt/-in) im IFC-File markiert sein.