data_logger.hpp

// Copyright 2023 Jacob Hartzer
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
#ifndef INFRASTRUCTURE__DATA_LOGGER_HPP_
#define INFRASTRUCTURE__DATA_LOGGER_HPP_
 
#include <string>
#include <fstream>
 
class DataLogger
{
public:
  DataLogger() {}
 
  DataLogger(const std::string & log_directory, const std::string & file_name);
 
  DataLogger(const std::string & log_directory, const std::string & file_name, double logging_rate);
 
  void Log(const std::string & message);
 
  void RateLimitedLog(const std::string & message, double time);
 
  void DefineHeader(const std::string & header);
 
  void EnableLogging();
 
  void SetOutputDirectory(const std::string & log_directory);
 
  void SetOutputFileName(const std::string & file_name);
 
  void SetLogRate(double rate);
 
private:
  bool m_initialized{false};
  std::string m_log_header{""};
  std::ofstream m_log_file;
  bool m_logging_on {false};
  std::string m_log_directory {""};
  std::string m_file_name {"default.log"};
  double m_rate{0.0};
  double m_time_init{0};
  unsigned int m_log_count{0};
};
 
#endif  // INFRASTRUCTURE__DATA_LOGGER_HPP_