summaryrefslogtreecommitdiff
path: root/README.md
blob: 4c777586bc3105e1f5e5f7fe9463c76a60959481 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# Olympia 2024 Events
> View updated Events with its Competitors and Rankings of all Disciplines 

## Galery

<table>
<tr>
<td><img src="doc/events_page_combobox.png"/></td>
<td><img src="doc/events_page_textfield.png"/></td>
<td><img src="doc/event_info.png"/></td>
</tr>
<tr>
<td>Select discipline</td>
<td>Filter by Event</td>
<td>View Competitor</td>
</tr>
</table>

## Getting Started

### Dependencies

- Qt6

### Installation

```sh
git clone git@gitlab.kit.edu:ugmgt/itat_challenge_2024.git
# or download release
cd itat_challenge_2024
cmake -B build
cmake --build build
./build/itat_challenge_olympics
```

## Code Structure

### UML Diagram

```plantuml
@startuml
allowmixing
set namespaceSeparator none
skinparam ranksep 10 

package C++ <<Frame>> {
    class Application {
        QGuiApplication app
            QmlComponent component
            SportModel model
            FilterModel<SportModel> filter
    }

    class SportModel {
        String discipline
            <EventInfo> model
            request(String discipline)
            parseData()
    }

    class FilterModel {
        void setFilterFixedString(String)
    }

    class EventInfo {
        String eventName
            List<Competitor> competitors
    }

    class Competitor {
        String name
            String code
            String noc
    }
}

package QML <<Frame>> {

    component EventInfoPage {
        component [Page] as EIPage {
            component [ToolBar] as EIToolBar
            component [ListView] as EILisView
        }
    }

    EIToolBar -[hidden]- EILisView

    component EventsPage {
        component [Page] as EPage {
            component [ToolBar] as EToolBar
            component [Column] as EColumn {
                component [Row] as ERow {
                    component [ComboBox] as EComboBox
                    component [TextField] as ETextField
                }
                component [ListView] as EListView
            }
        }
    }

    EToolBar -[hidden]- EColumn
    ERow -[hidden]- EListView

    component application.qml {
        component ApplicationWindow {
            component StackView
        }
    }
}

'application.qml -u- a
'Application -r- a

Application *-- "1" SportModel
Application *-- "1" FilterModel

FilterModel "1" o-- "1" SportModel

SportModel *-- "0..*" EventInfo
EventInfo *-- "0..*" Competitor

Application <.l. application.qml
StackView <.. EventInfoPage
StackView <.. EventsPage

EComboBox "request()" .> SportModel

EComboBox -[hidden]u- ETextField

SportModel "View" .> EListView 
FilterModel "View" .> EListView 
ETextField "Control" .r.> FilterModel

EILisView <. "View" Competitor

cloud api.olympics.com
() REST
REST - api.olympics.com

SportModel -( REST

application.qml -[hidden]u- Application
@enduml
```

## Authors

- **Silas Stulz** (ugmgt, 2468197) - *Initial Work*
- **Gero Beckmann** (ukpfm, 2409754) - *Initial Work*