Bruk hvilken som helst Code Editor med "Mermaid" - på lightmode for å kunne se komponentene og skriften i klassediagrammet.
classDiagram
class fun_HomeScreen {
}
class HomeScreenViewModel {
- coords: UserLocation
- weatherRepository: WeatherRepository
- locationRepository: LocationRepository
+ weatherUiState: StateFlow<HourlyWeatherUiState>
+ weatherNextDaysUiState: StateFlow<WeekForecastUiState>
+ locationUiState: StateFlow<LocationWeatherUiState>
+ readyUiState: StateFlow<Boolean>
+ showSnackbarState: StateFlow<Boolean>
+ isRefreshingState: StateFlow<Boolean>
+ intitalize()
+ refresh()
+ toggleRefreshing(bool : Boolean)
+ showSnackbar()
}
class HourlyWeatherUiState {
+ nextHours: List<TimeSeriesEntry>
+ weatherNowString: String
+ weatherNowEntry: TimeSeriesEntry#63;
}
class LocationWeatherUiState {
+ location: String
}
class WeekForecastUiState {
+ sevenNextDays: List<List<TimeSeriesEntry>>
}
class fun_HourlyScreen {
}
class fun_SettingsScreen {
}
class SettingsScreenViewModel {
- sharedPref: SharedPreferences
+ selectedTheme: StateFlow<Theme>
+ themeExpanded: StateFlow<Boolean>
+ tempExpanded: StateFlow<Boolean>
+ lightOrDarkExpanded: StateFlow<Boolean>
+ highContrastOn: StateFlow<Boolean>
+ tempPref: StateFlow<Int>
+ lightOrDarkPref: StateFlow<Int>
+ isDarkMode: StateFlow<Boolean>
+ correctLightOrDarkMode(bool: Boolean)
+ themeExpandedChange(bool: Boolean)
+ tempExpandedChange(bool: Boolean)
+ lightOrDarkExpandedChange(bool: Boolean)
+ highContrastChange(bool: Boolean)
+ intToTheme(int: Int) Theme
+ intToTemp (int: Int) String
+ intToLightOrDark(int: Int) String
+ switchTheme(int: Int)
+ switchTemp(int: Int)
+ switchLightOrDark(int: Int)
+ saveThemeChoice(int: Int)
+ saveTempChoice(int: Int)
+ saveLightOrDarkChoice(int: Int)
}
class fun_AboutUs {
}
class fun_LoadingScreen {
}
class fun_StreakPopUp {
}
class fun_AppScaffold {
}
class StreakViewModel {
+ streakManager: StreakManager
+ streakPopUpUiState: StateFlow<Boolean>
+ currentStreak: StateFlow<Int>
+ closeStreakPopUp()
+ openStreakPopUp()
+ updateStreakUI()
}
class fun_AlertsPopUp {
}
class AlertsViewModel {
- coords: UserLocation
+ alertUiState: StateFlow<AlertUiState>
- initialize()
+ alert: List<HashMap<String, String>>
}
class fun_AnimationPopUp {
}
class AnimationViewModel {
+ clothesPopUpUiState: StateFlow<Boolean>
+ rainPopUpUiState: StateFlow<Boolean>
+ windPopUpUiState: StateFlow<Boolean>
+ animationState: StateFlow<Boolean>
+ closeClothesPopUp()
+ openClothesPopUp()
+ closeRainPopUp()
+ openRainPopUp()
+ closeWindPopUp()
+ openWindPopUp()
+ animationStateChange()
}
class AlertsDataSource {
- client : HttpClient
+ fetchAlertData(lat:Double, lon:Double): AlertInfo#63
}
class LocationDataSource {
- client : HttpClient
+ fetchLocationData(lat: Double, lon: Double): LocationInfo#63
}
class WeatherDataSource {
- client : HttpClient
+ fetchWeatherData(lat: Double, lon: Double): WeatherInfo#63
}
class Theme {
+ lightColorScheme: ColorScheme
+ darkColorScheme: ColorScheme
+ highContrastLightColorScheme: ColorScheme
+ highContrastDarkColorScheme: ColorScheme
+ themeName: String
}
class AlertsRepository {
- alertsDataSource: AlertsDataSource
- alertInfo : AlertInfo#63
+ fetchAlertData(lat: Double, lon: Double)
+ getAlertData(): AlertInfo#63
}
class LocationRepository {
- locationDatasource: LocationDataSource
+ location: LocationInfo#63
+ fetchLocation(lat: Double, lon: Double)
+ getLocation(): String#63
}
class WeatherRepository {
- alertsDataSource : WeatherDataSource
- weatherInfo : WeatherInfo#63
+ fetchWeatherData(lat: Double, lon: Double)
+ getWeatherData(): WeatherInfo#63
}
class GetAlertInformationUseCase {
- alertsRepository: AlertsRepository
- defaultDispatcher: CoroutineDispatcher
+ invoke(lat: Double, lon: Double): List<HashMap<String, String>>
}
class GetLocationNameUseCase {
- locationRepository: LocationRepository
- defaultDispatcher: CoroutineDispatcher
+ invoke(): String
}
class GetWeatherCurrentHourUseCase {
- locationRepository: LocationRepository
- defaultDispatcher: CoroutineDispatcher
+ invoke(): String
}
class GetWeatherForSpecificDayUseCase {
- weatherRepository: WeatherRepository
- defaultDispatcher: CoroutineDispatcher
+ invoke(numberOfDaysAway: Int): List<TimeSeriesEntry>
}
class GetWeatherForTheNextHoursUseCase {
- weatherRepository: WeatherRepository
- defaultDispatcher: CoroutineDispatcher
+ invoke(amount: Int): List<TimeSeriesEntry>
}
class UserLocation {
+ lat : Double
+ lon : Double
- getUserLocation(activity: ComponentActivity)
}
class StreakManager {
- sharedPref: SharedPreferences
+ recordDailyAction() : Unit
- isYesterday(lastDay: Long): Boolean
+ getCurrentStreakCount(): Int
+ getStreakRecordCount(): Int
}
style fun_HomeScreen fill:#ddecd7,stroke:#333,stroke-width:4px
style fun_HourlyScreen fill:#ddecd7,stroke:#333,stroke-width:4px
style fun_SettingsScreen fill:#ddecd7,stroke:#333,stroke-width:4px
style fun_LoadingScreen fill:#ddecd7,stroke:#333,stroke-width:4px
style HomeScreenViewModel fill:#cfe2f3,stroke:#333,stroke-width:4px
style SettingsScreenViewModel fill:#cfe2f3,stroke:#333,stroke-width:4px
style StreakViewModel fill:#cfe2f3,stroke:#333,stroke-width:4px
style AlertsViewModel fill:#cfe2f3,stroke:#333,stroke-width:4px
style AnimationViewModel fill:#cfe2f3,stroke:#333,stroke-width:4px
style AlertsRepository fill:#fce5cd,stroke:#333,stroke-width:4px
style LocationRepository fill:#fce5cd,stroke:#333,stroke-width:4px
style WeatherRepository fill:#fce5cd,stroke:#333,stroke-width:4px
style HourlyWeatherUiState fill:#ffffff,stroke:#333,stroke-width:4px
style LocationWeatherUiState fill:#ffffff,stroke:#333,stroke-width:4px
style WeekForecastUiState fill:#ffffff,stroke:#333,stroke-width:4px
style GetAlertInformationUseCase fill:#fff2cc,stroke:#333,stroke-width:4px
style GetLocationNameUseCase fill:#fff2cc,stroke:#333,stroke-width:4px
style GetWeatherCurrentHourUseCase fill:#fff2cc,stroke:#333,stroke-width:4px
style GetWeatherForSpecificDayUseCase fill:#fff2cc,stroke:#333,stroke-width:4px
style GetWeatherForTheNextHoursUseCase fill:#fff2cc,stroke:#333,stroke-width:4px
style AlertsDataSource fill:#ead1dc,stroke:#333,stroke-width:4px
style LocationDataSource fill:#ead1dc,stroke:#333,stroke-width:4px
style WeatherDataSource fill:#ead1dc,stroke:#333,stroke-width:4px
style fun_StreakPopUp fill:#d9d2e9,stroke:#333,stroke-width:4px
style fun_AnimationPopUp fill:#d9d2e9,stroke:#333,stroke-width:4px
style fun_AlertsPopUp fill:#d9d2e9,stroke:#333,stroke-width:4px
style fun_AboutUs fill:#d0e0e3,stroke:#333,stroke-width:4px
style StreakManager fill:#d0e0e3,stroke:#333,stroke-width:4px
style UserLocation fill:#d0e0e3,stroke:#333,stroke-width:4px
style Theme fill:#d0e0e3,stroke:#333,stroke-width:4px
style fun_AppScaffold fill:#f4cccc,stroke:#333,stroke-width:4px
GetAlertInformationUseCase "1" -- "1" AlertsViewModel
GetAlertInformationUseCase "1" -- "1" AlertsRepository
GetLocationNameUseCase "1" -- "1" HomeScreenViewModel
GetLocationNameUseCase "1" -- "1" LocationRepository
GetWeatherCurrentHourUseCase "1" -- "1" HomeScreenViewModel
GetWeatherCurrentHourUseCase "1" -- "1" WeatherRepository
GetWeatherForSpecificDayUseCase "1" -- "1" HomeScreenViewModel
GetWeatherForSpecificDayUseCase "1" -- "1" WeatherRepository
GetWeatherForTheNextHoursUseCase "1" -- "1" HomeScreenViewModel
GetWeatherForTheNextHoursUseCase "1" -- "1" WeatherRepository
GetWeatherForTheNextHoursUseCase "1" -- "1" GetWeatherForSpecificDayUseCase
UserLocation "1" -- "1" fun_AppScaffold
UserLocation "1" -- "1" AlertsViewModel
UserLocation "1" -- "1" HomeScreenViewModel
StreakManager "1" -- "1" StreakViewModel
fun_HomeScreen "1" -- "1" HomeScreenViewModel
HourlyWeatherUiState "1" -- "1" HomeScreenViewModel
LocationWeatherUiState "1" -- "1" HomeScreenViewModel
WeekForecastUiState "1" -- "1" HomeScreenViewModel
fun_HourlyScreen "1" -- "1" fun_HomeScreen
fun_SettingsScreen "1" -- "1" fun_AppScaffold
fun_SettingsScreen "1" -- "1" SettingsScreenViewModel
SettingsScreenViewModel "1" -- "1" fun_AppScaffold
fun_AboutUs "1" -- "1" fun_AppScaffold
fun_LoadingScreen "1" -- "1" fun_HomeScreen
fun_AppScaffold "1" -- "1" fun_HomeScreen
fun_StreakPopUp "1" -- "1" fun_AppScaffold
fun_StreakPopUp "1" -- "1" StreakViewModel
fun_AlertsPopUp "1" -- "1" AlertsViewModel
SettingsScreenViewModel "1" -- "1" fun_AnimationPopUp
fun_AnimationPopUp "1" -- "1" AnimationViewModel
AlertsDataSource "1" -- "1" AlertsRepository
LocationDataSource "1" -- "1" LocationRepository
WeatherDataSource "1" -- "1" WeatherRepository
Theme "1" -- "1" SettingsScreenViewModel
Vi valgte å abstrahere bort så lite som mulig av klassediagrammet, for at det skulle gjenspeile strukturen i prosjektets helhet. Komponentene skjermer består av anså vi derimot som mer forvirrende enn hjelpsomt å inkludere. Noen dataklasser er også fjernet, grunnet deres mindre relevans og for simplisitet.
Illustrerer flyten til applikasjonens viktigste funksjoner. Vi valgte å ikke inkludere casen hvor bruker sjekker været for kommende dager, grunnet at flyten vil være nesten identisk som for å sjekke været i dag.
flowchart TD
start((Åpne app))
start --> nyttvalg{Har godkjent posisjonsporing}
nyttvalg -- Ja --> posisjon
nyttvalg -- Nei --> berposisjon{Ber om posisjon}
berposisjon -- Avslår --> valg{Sette posisjon til Oslo?}
valg -- Ja --> henterdata[Henter og viser data]
valg -- Nei --> slutt
berposisjon -- Godtar --> posisjon[Henter posisjon]
posisjon --> henterdata
henterdata --> leser[Bruker leser værdata]
leser --> ikon[Viser ikoner]
ikon --> velg{Trykk på et ikon?}
velg -- Ja --> beskrivelse[Pop up med mer informasjon]
beskrivelse --> Lukk[Bruker lukker pop up]
Lukk --> ikon
velg -- Nei --> slutt
slutt(((Slutt)))
Flyt for hvert av hovedikonene på hjemskjermen er generalisert siden den vil være omtrent lik for alle disse.
flowchart TD
start((Åpne app))
start --> posisjon[Henter posisjon]
posisjon --> varseldata[Henter varseldata for posisjon]
varseldata --> nåposisjon[Vis hjemskjerm med posisjon]
nåposisjon --> varselfinnes{Farevarsel finnes for brukerens posisjon}
varselfinnes -- Ja --> farevarsel[farevarsel vises i topbar]
varselfinnes -- Nei --> ingenvarsel[Ingen varsel vises i topbar]
ingenvarsel--> slutt
farevarsel --> klikkevarsel{Klikke på varsel?}
klikkevarsel --Ja --> visevarsel[Viser detaljert informasjon om alle varsler] --> slutt
klikkevarsel -- Nei --> slutt(((Slutt)))
Prosessen for å hente og sette posisjon er identisk som i forrige diagram, så den forenkles her for å unngå unødvendig gjentakelse.
flowchart TD
start((Åpne app)) --> navigerer[Navigerer til innstillingssiden]
navigerer --> presenterer[Viser liste over tilgjengelige innstillinger]
presenterer --> innstillinger{Endre innstiling?}
innstillinger -- Dropdown --> ja{Trykk på ny preferanse?}
ja -- Ja --> endrer[Preferanse endret] --> nei
ja -- Nei --> nei[Meny lukkes]
nei --> innstillinger
innstillinger -- Nei --> slutt((Slutt))
innstillinger -- Toggle switch --> option4[Trykker på switch]
option4 --> noe[Endrer kontrast]
noe --> innstillinger
Innstilling-skjermen illustreres som en loop hvor bruker kan endre alle instillinger så mange ganger de ønsker før casen avsluttes.
Sekvensdiagrammene våre viser casen der en bruker skal inn på appen for å sjekke dagens vær. Dette er det viktigste funksjonaliteten til appen, og andre cases vi kunne modellert ville inkludert mye av det samme inholdet som denne. Vi konkluderte det derfor som nok å modellere dette scenarioet. Det måtte deles opp i fire ulike diagrammer for å forbedre lesbarhet, men kan leses og tolkes i gitt rekkefølge for å få en illustrasjon av hele casen. Prosesser som ikke direkte er knyttet til å sjekke dagens vær valgt bort fra diagrammene.
sequenceDiagram
participant Bruker
activate Bruker
create participant MainActivity
Bruker->>MainActivity: åpner app
activate MainActivity
create participant UserLocation
MainActivity->>UserLocation: init()
activate UserLocation
UserLocation->>UserLocation: getUserLocation(activity: ComponentActivity)
par get coordinates
UserLocation->>Bruker: forespørsel om posisjonsdeling
alt bruker vil ikke dele posisjon
Bruker-->>UserLocation: avslår forespørsel
UserLocation->>UserLocation: koordinater forblir 0.0, 0.0
UserLocation->>Bruker: foreslår å sette posisjon til Oslo
Bruker-->>UserLocation: godkjenner Oslo som posisjon
UserLocation->>UserLocation: koordinater settes til Oslo
else bruker vil dele posisjon
Bruker-->>UserLocation: godkjenner deling av egen posisjon
UserLocation->>UserLocation: holder på brukerens koordinater
end
end
deactivate Bruker
deactivate UserLocation
deactivate MainActivity
Dette diagrammet beskriver prosessen fra da bruker åpner appen, til systemet har tilgang på en lokasjon å hente data fra. Om bruker godkjenner posisjonsdeling er det brukerens koordinater som anskaffes, ellers brukes Oslo sine koordinater. Selve prosessen bak å hente koordinatene fra telefon ved bruk av FusedLocationProvider er abstrahert bort for simpelhetens skyld.
sequenceDiagram
participant MainActivity
activate MainActivity
create participant HomeScreenViewModel
MainActivity->>HomeScreenViewModel: init(coords: UserLocation)
activate HomeScreenViewModel
par HomeScreenViewModel initialization
loop wait for coordinates
HomeScreenViewModel->>HomeScreenViewModel: delay
end
create participant WeatherRepository
HomeScreenViewModel->>WeatherRepository: init()
activate WeatherRepository
create participant WeatherDataSource
WeatherRepository->>WeatherDataSource: init()
activate WeatherDataSource
create participant LocationRepository
HomeScreenViewModel->>LocationRepository: init()
activate LocationRepository
create participant LocationDataSource
LocationRepository->>LocationDataSource: init()
activate LocationDataSource
HomeScreenViewModel->>WeatherRepository: fetchWeatherData(lat, lon)
WeatherRepository->>WeatherDataSource: fetchWeatherData(lat, lon)
create participant MET
WeatherDataSource->>MET: forespør værdata for koordinatene
MET-->>WeatherDataSource: returnerer data
WeatherDataSource-->>WeatherRepository: returnerer værdata
deactivate WeatherRepository
deactivate WeatherDataSource
HomeScreenViewModel->>LocationRepository: fetchLocation(lat, lon)
LocationRepository->>LocationDataSource: fetchLocationData(lat, lon)
LocationDataSource->>MET: henter stedsnavn for koordinatene
MET-->>LocationDataSource: returnerer data
LocationDataSource-->>LocationRepository: returnerer lokasjonsnavn
deactivate LocationRepository
deactivate LocationDataSource
end
deactivate HomeScreenViewModel
deactivate MainActivity
Dette diagrammet beskriver initialiseringen av HomeScreenViewModel, som innebærer itialisering av repositories, som igjen initialiserer datasources. Værdata hentes og lagres for senere bruk.
sequenceDiagram
participant HomeScreenViewModel
activate HomeScreenViewModel
create participant GetWeatherForTheNextHoursUseCase
HomeScreenViewModel->>GetWeatherForTheNextHoursUseCase: init(weatherRepository: WeatherRepository)
activate GetWeatherForTheNextHoursUseCase
Note left of GetWeatherForTheNextHoursUseCase: måten UseCasene henter og formerer<br>data på abstraheres bort
HomeScreenViewModel->>GetWeatherForTheNextHoursUseCase: invoke()
GetWeatherForTheNextHoursUseCase-->>HomeScreenViewModel: returnerer vær for de neste timene
deactivate GetWeatherForTheNextHoursUseCase
create participant GetWeatherCurrentHourUseCase
HomeScreenViewModel->>GetWeatherCurrentHourUseCase: init(weatherRepository: WeatherRepository)
activate GetWeatherCurrentHourUseCase
HomeScreenViewModel->>GetWeatherCurrentHourUseCase: invoke()
GetWeatherCurrentHourUseCase-->>HomeScreenViewModel: returnerer vær for akkurat nå
deactivate GetWeatherCurrentHourUseCase
HomeScreenViewModel->>HomeScreenViewModel: Lagrer de to siste resultatene i state
create participant GetWeatherForSpecificDayUseCase
HomeScreenViewModel->>GetWeatherForSpecificDayUseCase: init(weatherRepository: WeatherRepository)
activate GetWeatherForSpecificDayUseCase
HomeScreenViewModel->>GetWeatherForSpecificDayUseCase: invoke()
GetWeatherForSpecificDayUseCase-->>HomeScreenViewModel: returnerer vær for de syv neste dagene, lagres som state
deactivate GetWeatherForSpecificDayUseCase
create participant GetLocationNameUseCase
HomeScreenViewModel->>GetLocationNameUseCase: init(LocationRepository: LocationRepository)
activate GetLocationNameUseCase
HomeScreenViewModel->>GetLocationNameUseCase: invoke()
GetLocationNameUseCase-->>HomeScreenViewModel: returnerer lokasjonsnavn, lagres som state
deactivate GetLocationNameUseCase
deactivate HomeScreenViewModel
Dette diagrammet beskriver prosessen bestående av HomeScreenViewModel som bruker funksjonene i domenelaget for å forme den innhentede dataen til egnet format for states.
sequenceDiagram
participant Bruker
activate Bruker
participant MainActivity
activate MainActivity
participant HomeScreenViewModel
activate HomeScreenViewModel
create participant AnimationViewModel
MainActivity->>AnimationViewModel: init()
activate AnimationViewModel
create participant fun_AppScaffold
MainActivity->>fun_AppScaffold: starter AppScaffold() funksjonen
activate fun_AppScaffold
fun_AppScaffold->>Bruker: viser topAppBar
create participant fun_HomeScreen
fun_AppScaffold->>fun_HomeScreen: starter HomeScreen() inne i scaffoldet
activate fun_HomeScreen
loop Mens bruker ikke har internett
fun_HomeScreen->>HomeScreenViewModel: overvåker states
HomeScreenViewModel-->>fun_HomeScreen: returnerer tomme objekter
fun_HomeScreen->>Bruker: LoadingScreen()
fun_AppScaffold->>Bruker: refreshSnackbar
Bruker->>fun_AppScaffold: trykker "prøv igjen"
fun_AppScaffold->>HomeScreenViewModel: ny initialisering
end
fun_HomeScreen->>Bruker: viser hjemskjerm med hentet informasjon
loop mens bruker ønsker mer informasjon om regn, klær eller vind
Bruker->>fun_HomeScreen: Trykker på ikon
fun_HomeScreen->>AnimationViewModel: endrer popup state til true
AnimationViewModel-->>fun_AppScaffold: state-endring observeres
fun_AppScaffold->>Bruker: popup med ytterligere informasjon vises
Bruker->>fun_AppScaffold: bruker trykker på "bekreft" eller utenfor boksen
fun_AppScaffold->>AnimationViewModel: endrer popup state til false
AnimationViewModel-->>fun_AppScaffold: state-endring observeres
fun_AppScaffold->>Bruker: popup skjules
end
deactivate Bruker
deactivate MainActivity
deactivate HomeScreenViewModel
deactivate AnimationViewModel
deactivate fun_AppScaffold
deactivate fun_HomeScreen
Dette er det siste sekvensdiagrammet i casen, og det beskriver prosessen etter states er hentet inn, til bruker ser hjemskjermen med dagens vær. Det inkluderer også valget om å trykke på ikoner for ytterligere informasjon om været.
Beskrivelse: Viser alle de viktige funksjonene som inngår i vår applikasjon for å sjekke været.
Beskrivelse: Denne use case beskriver hvordan en bruker kan bruke værappen til å få oppdatert værinformasjon for sin nåværende lokasjon.
Aktører: Bruker
Prebetingelse:
- Brukeren har installert værappen på sin smarttelefon eller har tilgang til værappen via en webplattform.
- Brukeren har en aktiv internettforbindelse.
- Appen har tillatelse til å bruke brukerens lokasjonstjenester eller brukeren har oppgitt sin lokasjon.
Postbetingelse: Brukeren har blitt presentert med den tilgjengelige værinformasjonen for den valgte lokasjonen.
Hovedflyt:
- Identifisere aktøren (brukeren).
- Systemet ber om bruker sin posisjon og spør om tillatelse til å hente posisjon
- Bruker tillater tillatelse for å hente posisjon
- Systemet registrerer brukerens lokasjon (automatisk).
- Systemet henter og viser været for brukerens nåværende lokasjon.
- Brukeren ser på temperatur, vær ikon, vindforhold, nedbørsmengde, klesplaggikon
Alternativ flyt:
A3.1: Systemet finner ikke brukerens lokasjon, hvis bruker har deaktivert lokasjonstjenester eller ikke greier å hente lokasjonen
A3.2: Systemet viser en pop up i tillegg til å sette lokasjonen automatisk til Oslo
Beskrivelse: Hva som inngår når bruker skal sjekke været for de syv neste dagene, som gjelder langtidstabellen.
Beskrivelse Hva som skjer dersom bruker mottar et farevarsel på applikasjonen.
Hovedflyt:
- Brukeren navigerer til hamburgemenyen.
- Systemet presenterer hamburgermeny med alternativene “Hjem”, "Innstillinger" og “Om oss”
- Brukeren trykker på “Innstillinger”
- Systemet henter data og viser instillinger siden med alternativene “Tilpasning”, “Utseende” og “Høy Kontrast”
- Bruker endrer en av instillingene
- Systemet lagrer endringene og bekrefter til brukeren at endringene er lagret.
Alternativ flyt:
A3.1: Bruker velger å ikke gjøre noen endringer på innstillinger, og systemet gjør ingen endring
