diff --git a/src/libebus/dump.h b/src/libebus/dump.h index 2062104a..34418139 100644 --- a/src/libebus/dump.h +++ b/src/libebus/dump.h @@ -25,21 +25,44 @@ namespace libebus { - +/** + * @brief Class for writing raw bytes to binary file. + */ class Dump { public: + /** + * @brief Create a new instance to write dump files. + * @param filename which will be used for dumping raw bytes. + * @param filesize max. Size of the dump file, before switching. + */ Dump(std::string filename, long filesize) : m_filename(filename), m_filesize(filesize) {} + /** + * @brief write byte to dump file. + * @param byte to write + * @return -1 if dump file cannot opened or renaming of dump file failed. + */ int write(const char* byte); + /** + * @brief setter for dump file name. + * @param filename which will be used for dumping raw bytes. + */ void setFilename(const std::string& filename) { m_filename = filename; } + + /** + * @brief setter for max size of dump file. + * @param filesize max. Size of the dump file, before switching. + */ void setFilesize(const long filesize) { m_filesize = filesize; } private: + /** the name of dump file*/ std::string m_filename; + /** max. size of dump file */ long m_filesize; };