diff --git a/docs/class-diagram.png b/docs/class-diagram.png new file mode 100644 index 0000000..01a44b9 Binary files /dev/null and b/docs/class-diagram.png differ diff --git a/docs/dev.org b/docs/dev.org new file mode 100644 index 0000000..99d18c8 --- /dev/null +++ b/docs/dev.org @@ -0,0 +1,72 @@ +#+TITLE: Fejlesztői Dokumentáció + +* TODO Követelmények +* TODO Use-cas-ek +* TODO Struktúrális leírás +** Osztály diagram + +#+BEGIN_SRC plantuml :file class-diagram.png :exports result +@startuml +Exchange <|--- Binance +Market <--- "-currencies" Currency : 2 +Exchange *--- " #markets" Market : 1..* +Trader <--- "-exchanges" Exchange: 1..* +TradeTracker *--- "-traders" Trader: 0..* + +class TradeTracker { + -round() + +start() +} + +abstract class Trader { + +{abstract} step() +} + +note right of Trader::step() + Itt történik a trader belső logikája +end note + +abstract class Exchange { + -String name + +getName(): String + +{abstract} updateAllMarkets() + +{abstract} updateMarket(id: int) + +{abstract} updateMarket(name : String) + +getMarket(id: int): Market + +getMarket(name: String): Market + +{abstract} addMarket(m: Market) +} + +class Binance { + -{static} String baseURL + +updateMarket(id: int) + +updateMarket(name : String) + +updateMarkets() +} + +note left of Binance + Ez csak egy példa, lehetne akár más is +end note + +class Market { + -String name + -double exchange_rate + +Market(primary: Currency,secondary: Currency) + +getName(): String + +getExchangeRate(): double + +setExchangeRate(d: double) +} + +class Currency { + -String name + -String symbol + +Currency(name: String,symbol: String) + +getName() : String + +getSymbol() : String +} +@enduml +#+END_SRC + +#+RESULTS: +[[file:class-diagram.png]] +* TODO Viselkedés leírása