diff --git a/docs/class-diagram-web-app.puml b/docs/class-diagram-web-app.puml index 7ffb7bb..a7e0224 100644 --- a/docs/class-diagram-web-app.puml +++ b/docs/class-diagram-web-app.puml @@ -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 \ No newline at end of file diff --git a/docs/class-diagramm-web-app.svg b/docs/class-diagramm-web-app.svg new file mode 100644 index 0000000..b330efb --- /dev/null +++ b/docs/class-diagramm-web-app.svg @@ -0,0 +1 @@ +AppChartComponentscatterControlPanelaction-buttonrefresh-buttonuser-multiselectroom-multiselectdevice-multiselectClientisconnected()getValues(user, room, device)getNewValue()ping()getAuthHeader()TimeSeriesManagerselected_userselected_roomselected_deviceseriesgetTimeSeriesData()getNewValue()SerietypedatauserroomdevicegetLabel()getSerie() \ No newline at end of file diff --git a/web-app/README.md b/web-app/README.md index e60d881..ebdac62 100644 --- a/web-app/README.md +++ b/web-app/README.md @@ -60,6 +60,11 @@ npm run serve npm run build ``` +## Documentation +### Class diagram + +

![Class Diagram](docs/class-diagramm-web-app.svg) + ### Links See [Configuration Reference](https://cli.vuejs.org/config/).\ See [Vue.js](https://vuejs.org/guide/introduction.html).\ diff --git a/web-app/cypress/fixtures/example.json b/web-app/cypress/fixtures/example.json deleted file mode 100644 index 02e4254..0000000 --- a/web-app/cypress/fixtures/example.json +++ /dev/null @@ -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" -}