chore(webapp): update documentation with class diagram
This commit is contained in:
fastium committed
1 parent
7e76712e33
commit
550d6fd776
4 files changed
+51
-47
No files matched your search
@@ -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
|
||||
@@ -0,0 +1 @@
|
||||
<?xml version="1.0" encoding="us-ascii" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" height="601px" preserveAspectRatio="none" style="width:571px;height:601px;background:#FFFFFF;" version="1.1" viewBox="0 0 571 601" width="571px" zoomAndPan="magnify"><defs/><g><!--class App--><g id="elem_App"><rect codeLine="5" fill="#F1F1F1" height="48" id="App" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="59" x="146" y="276.5"/><ellipse cx="161" cy="292.5" fill="#ADD1B2" rx="11" ry="11" style="stroke:#181818;stroke-width:1.0;"/><path d="M163.9688,298.1406 Q163.3906,298.4375 162.75,298.5781 Q162.1094,298.7344 161.4063,298.7344 Q158.9063,298.7344 157.5781,297.0938 Q156.2656,295.4375 156.2656,292.3125 Q156.2656,289.1875 157.5781,287.5313 Q158.9063,285.875 161.4063,285.875 Q162.1094,285.875 162.75,286.0313 Q163.4063,286.1875 163.9688,286.4844 L163.9688,289.2031 Q163.3438,288.625 162.75,288.3594 Q162.1563,288.0781 161.5313,288.0781 Q160.1875,288.0781 159.5,289.1563 Q158.8125,290.2188 158.8125,292.3125 Q158.8125,294.4063 159.5,295.4844 Q160.1875,296.5469 161.5313,296.5469 Q162.1563,296.5469 162.75,296.2813 Q163.3438,296 163.9688,295.4219 L163.9688,298.1406 Z " fill="#000000"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="27" x="175" y="297.932">App</text><line style="stroke:#181818;stroke-width:0.5;" x1="147" x2="204" y1="308.5" y2="308.5"/><line style="stroke:#181818;stroke-width:0.5;" x1="147" x2="204" y1="316.5" y2="316.5"/></g><!--class ChartComponent--><g id="elem_ChartComponent"><rect codeLine="10" fill="#F1F1F1" height="67.0679" id="ChartComponent" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="147" x="7" y="489"/><ellipse cx="22" cy="505" fill="#ADD1B2" rx="11" ry="11" style="stroke:#181818;stroke-width:1.0;"/><path d="M24.9688,510.6406 Q24.3906,510.9375 23.75,511.0781 Q23.1094,511.2344 22.4063,511.2344 Q19.9063,511.2344 18.5781,509.5938 Q17.2656,507.9375 17.2656,504.8125 Q17.2656,501.6875 18.5781,500.0313 Q19.9063,498.375 22.4063,498.375 Q23.1094,498.375 23.75,498.5313 Q24.4063,498.6875 24.9688,498.9844 L24.9688,501.7031 Q24.3438,501.125 23.75,500.8594 Q23.1563,500.5781 22.5313,500.5781 Q21.1875,500.5781 20.5,501.6563 Q19.8125,502.7188 19.8125,504.8125 Q19.8125,506.9063 20.5,507.9844 Q21.1875,509.0469 22.5313,509.0469 Q23.1563,509.0469 23.75,508.7813 Q24.3438,508.5 24.9688,507.9219 L24.9688,510.6406 Z " fill="#000000"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="115" x="36" y="510.432">ChartComponent</text><line style="stroke:#181818;stroke-width:0.5;" x1="8" x2="153" y1="521" y2="521"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="46" x="13" y="539.9659">scatter</text><line style="stroke:#181818;stroke-width:0.5;" x1="8" x2="153" y1="548.0679" y2="548.0679"/></g><!--class ControlPanel--><g id="elem_ControlPanel"><rect codeLine="16" fill="#F1F1F1" height="143.3396" id="ControlPanel" rx="2.5" ry="2.5" style="stroke:#181818;stroke-width:0.5;" width="134" x="204.5" y="451"/><ellipse cx="226.7" cy="467" fill="#ADD1B2" rx="11" ry="11" style="stroke:#181818;stroke-width:1.0;"/><path d="M229.6688,472.6406 Q229.0906,472.9375 228.45,473.0781 Q227.8094,473.2344 227.1063,473.2344 Q224.6063,473.2344 223.2781,471.5938 Q221.9656,469.9375 221.9656,466.8125 Q221.9656,463.6875 223.2781,462.0313 Q224.6063,460.375 227.1063,460.375 Q227.8094,460.375 228.45,460.5313 Q229.1063,460.6875 229.6688,460.9844 L229.6688,463.7031 Q229.0438,463.125 228.45,462.8594 Q227.8563,462.5781 227.2313,462.5781 Q225.8875,462.5781 225.2,463.6563 Q224.5125,464.7188 224.5125,466.8125 Q224.5125,468.9063 225.2,469.9844 Q225.8875,471.0469 227.2313,471.0469 Q227.8563,471.0469 228.45,470.7813 Q229.0438,470.5 229.6688,469.9219 L229.6688,472.6406 Z " fill="#000000"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="86" x="242.3" y="472.432">ControlPanel</text><line style="stroke:#181818;stroke-width:0.5;" x1="205.5" x2="337.5" y1="483" y2="483"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="91" x="210.5" y="501.9659">action-button</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="99" x="210.5" y="521.0339">refresh-button</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="109" x="210.5" y="540.1018">user-multiselect</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="114" x="210.5" y="559.1697">room-multiselect</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="122" x="210.5" y="578.2376">device-multiselect</text><line style="stroke:#181818;stroke-width:0.5;" x1="205.5" x2="337.5" y1="586.3396" y2="586.339Line truncated
|
||||
|
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