diff options
author | lonkaars <loek@pipeframe.xyz> | 2022-12-25 21:48:08 +0100 |
---|---|---|
committer | lonkaars <loek@pipeframe.xyz> | 2022-12-25 21:48:08 +0100 |
commit | a167c3e2222b969a4aa65801ee1c0bc891928bea (patch) | |
tree | 09710a40d29dfd6cc9abb5371d26b9f41cb23240 /oop2eindopdr/ZipExport.h | |
parent | 908cb0e3db72cbcecb3b544ad5a406ec8b6d2236 (diff) |
small refactoring and add documentation
Diffstat (limited to 'oop2eindopdr/ZipExport.h')
-rw-r--r-- | oop2eindopdr/ZipExport.h | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/oop2eindopdr/ZipExport.h b/oop2eindopdr/ZipExport.h index 741ab4e..0800b41 100644 --- a/oop2eindopdr/ZipExport.h +++ b/oop2eindopdr/ZipExport.h @@ -5,20 +5,28 @@ class Pokedex; +/** @brief handle csv parsing and zip export */ class ZipExport { private: + /** @brief reference to pokedex */ Pokedex* pokedex; - std::string csv_path, zip_path; - std::vector<std::string> id_list; + std::string csv_path; /** @brief input csv file path */ + std::string zip_path; /** @brief output zip file path */ + std::vector<std::string> id_list; /** @brief list of id's in csv file */ public: + /** @brief create ZipExport */ ZipExport(); + /** @brief create ZipExport class and immediately start export */ ZipExport(Pokedex* pokedex, std::string input_csv, std::string output_zip); virtual ~ZipExport(); + /** @brief set pokedex reference */ virtual void set_pokedex(Pokedex* pokedex); + /** @brief set csv_path and parse csv file */ virtual void import_csv(std::string filename); + /** @brief generate output export zip file */ virtual void export_zip(std::string filename); }; |