progress-updater.h

Go to the documentation of this file.

// Copyright 2012 Cloudera Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


#ifndef IMPALA_UTIL_PROGRESS_UPDATER_H
#define IMPALA_UTIL_PROGRESS_UPDATER_H

#include <string>
#include <boost/cstdint.hpp>

#include "common/atomic.h"

namespace impala {

class ProgressUpdater {
 public:
  ProgressUpdater(const std::string& label, int64_t max, int update_period = 1);

  ProgressUpdater();

  void set_logging_level(int level) { logging_level_ = level; }

  void Update(int64_t delta);

  bool done() const { return num_complete_ >= total_; }

  int64_t total() const { return total_; }
  int64_t num_complete() const { return num_complete_; }
  int64_t remaining() const { return total() - num_complete(); }

  std::string ToString() const;

 private:
  std::string label_;
  int logging_level_;
  int64_t total_;
  int update_period_;

  AtomicInt<int64_t> num_complete_;
  int last_output_percentage_;
};

}

#endif