chore(webapp): update documentation with class diagram
This commit is contained in:
@@ -1,66 +1,69 @@
|
||||
@startuml web-app
|
||||
|
||||
skinparam linetype ortho
|
||||
skinparam nodesep 50
|
||||
|
||||
class App {
|
||||
' principale vuejs component
|
||||
|
||||
}
|
||||
|
||||
class Client {
|
||||
+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 {
|
||||
class ChartComponent {
|
||||
' 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 {
|
||||
' contains table of measure
|
||||
' convert the table to graphs format
|
||||
-type
|
||||
-values
|
||||
-numberOfLastValus
|
||||
-id
|
||||
-place
|
||||
-name
|
||||
-data
|
||||
-user
|
||||
-room
|
||||
-device
|
||||
|
||||
+getGraphFormat()
|
||||
' needs to limit the number of value
|
||||
+addNewValue()
|
||||
}
|
||||
|
||||
class Plot {
|
||||
+getLabel()
|
||||
+getSerie()
|
||||
|
||||
}
|
||||
|
||||
App *-r- SeriesManager
|
||||
|
||||
App *-r- TimeSeriesManager
|
||||
App *-u- Client
|
||||
SeriesManager *-r- TimeSeries
|
||||
Plot -l-* TimeSeries
|
||||
Serie -u-* TimeSeries
|
||||
Serie *-- Button
|
||||
SerieConverter .u.> SeriesManager
|
||||
App *-d- ChartComponent
|
||||
App *-d- ControlPanel
|
||||
TimeSeriesManager *---r--- Serie
|
||||
|
||||
|
||||
|
||||
|
||||
@enduml
|
||||
1
docs/class-diagramm-web-app.svg
Normal file
1
docs/class-diagramm-web-app.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 15 KiB |
@@ -60,6 +60,11 @@ npm run serve
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Documentation
|
||||
### Class diagram
|
||||
|
||||
<p align="center"> 
|
||||
|
||||
### Links
|
||||
See [Configuration Reference](https://cli.vuejs.org/config/).\
|
||||
See [Vue.js](https://vuejs.org/guide/introduction.html).\
|
||||
|
||||
@@ -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"
|
||||
}
|
||||
Reference in New Issue
Block a user