evProgressReporter.h

Go to the documentation of this file.

/*
 *
 * EVITA: Efficient Visualization of Terascale Datasets
 * Copyright (C) 2000-2016  Team Evita
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Library General Public License for more details.
 * 
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 675 Mass Ave, Cambridge,
 * MA 02139, USA.
 *
 */


#ifndef __evProgressReporter_h
#define __evProgressReporter_h


#include "evCommon.h"
#include "evMultiProcessController.h"


class evProgressReporter 
{
public:
  evProgressReporter(void);
  virtual ~evProgressReporter(void);
  
  virtual const evString GetClassName(void) const
  {
    return(evString("evProgressReporter"));
  }
  
  void SetController(const int report_to_thread,
                     evMultiProcessController *controller);
  
  void ReportProgress(const double progress);
  void ReportProgress(const unsigned int count,
                      const unsigned int max_count);
  void ReportProcess(evString process);
  
protected:
  
private:
  
  unsigned int PreviousProgress;
  evMultiProcessController *Controller;
  int Thread;
  
};


inline evProgressReporter::evProgressReporter(void)
{
  this->Controller = NULL;
  this->PreviousProgress = 0;
}


inline evProgressReporter::~evProgressReporter(void)
{
}


inline void evProgressReporter::SetController(const int
                                              report_to_thread,
                                              evMultiProcessController
                                              *controller)
{
  this->Thread = report_to_thread;
  this->Controller = controller;
}


inline void evProgressReporter::ReportProgress(const double progress)
{
  this->ReportProgress((unsigned int)(progress * 100),
                       (unsigned int)100);
}


inline void evProgressReporter::ReportProgress(const unsigned int count,
                                               const unsigned int max_count)
{
  unsigned int progress;

  if (this->Controller != NULL)
    {
      if (count == max_count)
        progress = 100;
      else
        if (max_count > 100)
          progress = count / (max_count / 100);
        else
          if (!max_count)
            progress = 0;
          else
            progress = (int)((double)count / max_count * 100);
      
      if (progress != this->PreviousProgress)
        {
          this->PreviousProgress = progress;
          this->Controller->Send((char *)&progress,
                                 sizeof(unsigned int),
                                 this->Thread,
                                 EVMESSAGE_PROGRESS);
        }
    }
}


inline void evProgressReporter::ReportProcess(evString process)
{
  if (this->Controller != NULL)
    {
      this->Controller->Send(process.GetString(),
                             EVSTRINGLEN,
                             this->Thread,
                             EVMESSAGE_PROCESS);
      this->ReportProgress(0);
    }
}


#endif