progress_bar.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// Copyright (C) 2021 CERN & University of Surrey for the benefit of the
// BioDynaMo collaboration. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
//
// See the LICENSE file distributed with this work for details.
// See the NOTICE file distributed with this work for additional information
// regarding copyright ownership.
//
// -----------------------------------------------------------------------------
 
#ifndef PROGRESS_BAR_H_
#define PROGRESS_BAR_H_
 
#include <cstdint>
#include <iostream>
#include <string>
#include "core/real_t.h"
 
namespace bdm {
 
class ProgressBar {
 private:
  std::string time_unit_ = "s";
  uint64_t total_steps_ = 0;
  uint64_t executed_steps_ = 0;
  int64_t start_time_ = 0;
  size_t n_terminal_chars_ = 0;
  real_t time_conversion_factor_ = 1000;
  bool first_iter_ = true;
  bool write_to_file_ = false;
 
 public:
  ProgressBar();
  explicit ProgressBar(int total_steps);
 
  void Step(uint64_t steps = 1);
 
  void PrintProgressBar(std::ostream& out = std::cout);
 
  void SetTimeUnit(const std::string& time_unit);
};
 
}  // namespace bdm
 
#endif  // PROGRESS_BAR_H_