show-progress.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2017 Lawrence Livermore National Laboratory
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Gustavo Carneiro <gjc@inescporto.pt>
 * Author: Peter D. Barnes, Jr. <pdbarnes@llnl.gov>
 */


#ifndef SHOW_PROGRESS_H
#define SHOW_PROGRESS_H

#include <iostream>

#include "event-id.h"
#include "nstime.h"
#include "system-wall-clock-ms.h"
#include "system-wall-clock-timestamp.h"
#include "time-printer.h"

namespace ns3 {


class ShowProgress
{
public:
  ShowProgress (const Time interval = Seconds (1.0),
                std::ostream & os = std::cout);

  ~ShowProgress (void);

  void SetInterval (const Time interval);

  void SetTimePrinter (TimePrinter lp);

  void SetStream (std::ostream & os);

  void SetVerbose (bool verbose);

private:
  
  void Start (void);

  void Stop (void);

  void ScheduleCheckProgress (void);

  void CheckProgress (void);

  void GiveFeedback (uint64_t nEvents, int64x64_t ratio, int64x64_t speed);

  static const int64x64_t HYSTERESIS;
  static const int64x64_t MAXGAIN;

  SystemWallClockMs m_timer;  
  SystemWallClockTimestamp m_stamp;  
  Time m_elapsed;             
  Time m_interval;            
  Time m_vtime;               
  EventId m_event;            
  uint64_t m_eventCount;      

  TimePrinter m_printer;      
  std::ostream *m_os;         
  bool m_verbose;             
  uint64_t m_repCount;        

};  // class ShowProgress

}  // namespace ns3

#endif  /* SHOW_PROGRESS_H */