Resolve: updated with new diagrams. - [merged]

[fgardt]

In GitLab by @Shiroen95 on Jun 1, 2023, 14:41

Merges docs/update-software-design-document -> master

What this MR does / why we need it:

Updates the current SDD to the current design.

Which issue this MR fixes (optional)

Closes #40

CHANGELOG/Release Notes (optional)

_{*For more information check out the wiki : https://gitlab.uni-ulm.de/groups/se-anwendungsprojekt-22-23/-/wikis/Convention#documentation}

[fgardt]

In GitLab by @Shiroen95 on Jun 1, 2023, 14:41

requested review from @Merseleo

[fgardt]

In GitLab by @Shiroen95 on Jun 1, 2023, 14:42

The SensorManager must still be updated.

[fgardt]

In GitLab by @Shiroen95 on Jun 1, 2023, 14:54

added 1 commit

• b0332fca - fix: reverted old wording.

Compare with previous version

[fgardt]

In GitLab by @Merseleo on Jun 5, 2023, 13:01

Commented on Software design document/design_doc.tex line 132

This doesn't work on my device and why are using hyperref? (same on some links below)

[fgardt]

In GitLab by @Merseleo on Jun 5, 2023, 13:01

Commented on Software design document/design_doc.tex line 251

The MultiFilterTools extend the \hyperref[sec:FilterTools]{FilterTools} and was added with Verison 1.1. It added the functionality to create a query on multiple sensors simultaneously. 

[fgardt]

In GitLab by @Merseleo on Jun 5, 2023, 13:01

Commented on Software design document/design_doc.tex line 261

The device information manager was added with Version 1.1. It added the functionality to read current device information, like current OS or free space.

[fgardt]

In GitLab by @Merseleo on Jun 5, 2023, 13:01

Commented on Software design document/design_doc.tex line 251

The MultiFilterTools extend the \hyperref[sec:FilterTools]{FilterTools} and was added with Version 1.1. It added the functionality to create a query on multiple sensors. 

[fgardt]

In GitLab by @Merseleo on Jun 5, 2023, 13:01

Commented on Software design document/design_doc.tex line 242

The updated version represents the current implementation. It now works with the flutter internal \hyperlink{https://flutterbyexample.com/lesson/cascade-notation}{cascade} function. It also added the functionality to set a specific time interval, in which the data is filtered (eg. the average every day). 

[fgardt]

In GitLab by @Merseleo on Jun 5, 2023, 13:01

Commented on Software design document/design_doc.tex line 272

The SensorDataDTO was added with Verison 1.1. It serves as the SensorData datatype in the database. The reason for the seperation between SensorDataDTO and \hyperref[sec:SensorData]{SensorData} is the mutable state. SensorDataDTO is immutable while \hyperref[sec:SensorData]{SensorData} can get changed (e. g. by the preprocessor) and is therefore mutable. The immutable state is needed for the database. DTO stands for "Data Transfer Object".

[fgardt]

In GitLab by @Merseleo on Jun 5, 2023, 13:01

Commented on Software design document/design_doc.tex line 386

Does this class still exist?

[fgardt]

In GitLab by @Merseleo on Jun 5, 2023, 13:01

In my opinion the sequence diagrams are very good and especially helpful. Mainly some typos left, but one request too: could you check the class diagrams again, because you still have some classes and comments, that could (afaik) be deleted.

[fgardt]

In GitLab by @Shiroen95 on Jun 5, 2023, 21:52

added 21 commits

• b0332fca...7996b69f - 19 commits from branch master
• d878e5d2 - docs: updated with new diagrams.
• 5eb0d748 - fix: reverted old wording.

Compare with previous version

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:15

Commented on Software design document/design_doc.tex line 251

changed this line in version 5 of the diff

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:15

Commented on Software design document/design_doc.tex line 261

changed this line in version 5 of the diff

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:15

Commented on Software design document/design_doc.tex line 251

changed this line in version 5 of the diff

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:15

Commented on Software design document/design_doc.tex line 272

changed this line in version 5 of the diff

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:15

added 4 commits

• 01a18aa1 - docs: updated with new diagrams.
• b0332fca - fix: reverted old wording.
• 6bf1e3bf - chore: rebase
• fca7e123 - chore: typos

Compare with previous version

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:17

Commented on Software design document/design_doc.tex line 132

To link to the corresponding sections. But it should work.

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:17

Commented on Software design document/design_doc.tex line 251

Changed.

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:17

Commented on Software design document/design_doc.tex line 261

Changed.

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:17

Commented on Software design document/design_doc.tex line 251

Changed.

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:17

Commented on Software design document/design_doc.tex line 242

Changed.

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:17

Commented on Software design document/design_doc.tex line 272

Changed.

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:17

Commented on Software design document/design_doc.tex line 386

It exist in form of a map. But the sensor manager architecture is one version older then the currently implemented one.

[fgardt]

In GitLab by @Merseleo on Jun 6, 2023, 17:19

Commented on Software design document/design_doc.tex line 132

Ok I figured it out.

[fgardt]

In GitLab by @Merseleo on Jun 6, 2023, 17:19

Commented on Software design document/design_doc.tex line 251

Perfect.

[fgardt]

In GitLab by @Merseleo on Jun 6, 2023, 17:19

Commented on Software design document/design_doc.tex line 386

Ok, i think this way it should also work out.

[fgardt]

In GitLab by @Merseleo on Jun 6, 2023, 17:19

resolved all threads

[fgardt]

In GitLab by @Merseleo on Jun 6, 2023, 17:19

approved this merge request

[fgardt]

In GitLab by @Merseleo on Jun 6, 2023, 17:19

marked this merge request as ready

[fgardt]

In GitLab by @Shiroen95 on Jun 6, 2023, 17:19

mentioned in commit 426eebaa60a4f4aae4e5026b71fa1112a1b18262