chore(webapp): update documentation with class diagram

This commit is contained in:
fastium
2025-06-23 19:53:01 +02:00
parent 7e76712e33
commit 550d6fd776
4 changed files with 51 additions and 47 deletions

View File

@@ -1,66 +1,69 @@
@startuml web-app @startuml web-app
skinparam linetype ortho skinparam linetype ortho
skinparam nodesep 50
class App { class App {
' principale vuejs component ' principale vuejs component
} }
class Client { class ChartComponent {
+getValues()
+getNewValue()
}
class SeriesManager {
' get data, put data in graphs, ask new measure
+getNewValue()
+getAllValue()
}
class SerieConverter {
' convert timeseries from backend for graphs
+jsonToSerie()
}
class TimeSeries {
' simplify the duplication of series in graphs
-Series
}
class Button {
' vue js component ' vue js component
' ask new measure scatter
} }
class ControlPanel {
' vue js component
action-button
refresh-button
user-multiselect
room-multiselect
device-multiselect
}
class Client {
+isconnected()
+getValues(user, room, device)
+getNewValue()
-ping()
-getAuthHeader()
}
class TimeSeriesManager {
' get data, put data in graphs, ask new measure
+selected_user
+selected_room
+selected_device
+series
+getTimeSeriesData()
+getNewValue()
}
class Serie { class Serie {
' contains table of measure ' contains table of measure
' convert the table to graphs format ' convert the table to graphs format
-type -type
-values -data
-numberOfLastValus -user
-id -room
-place -device
-name
+getGraphFormat() +getLabel()
' needs to limit the number of value +getSerie()
+addNewValue()
}
class Plot {
} }
App *-r- SeriesManager
App *-r- TimeSeriesManager
App *-u- Client App *-u- Client
SeriesManager *-r- TimeSeries App *-d- ChartComponent
Plot -l-* TimeSeries App *-d- ControlPanel
Serie -u-* TimeSeries TimeSeriesManager *---r--- Serie
Serie *-- Button
SerieConverter .u.> SeriesManager
@enduml @enduml

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 15 KiB

View File

@@ -60,6 +60,11 @@ npm run serve
npm run build npm run build
``` ```
## Documentation
### Class diagram
<p align="center"> ![Class Diagram](docs/class-diagramm-web-app.svg)
### Links ### Links
See [Configuration Reference](https://cli.vuejs.org/config/).\ See [Configuration Reference](https://cli.vuejs.org/config/).\
See [Vue.js](https://vuejs.org/guide/introduction.html).\ See [Vue.js](https://vuejs.org/guide/introduction.html).\

View File

@@ -1,5 +0,0 @@
{
"name": "Using fixtures to represent data",
"email": "hello@cypress.io",
"body": "Fixtures are a great way to mock data for responses to routes"
}