secondo/include/ProgressView.h

/*
----
This file is part of SECONDO.

Copyright (C) 2004, University in Hagen, Department of Computer Science,
Database Systems for New Applications.

SECONDO 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 2 of the License, or
(at your option) any later version.

SECONDO 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 SECONDO; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
----

//paragraph    [10]    title:           [{\Large \bf ] [}]
//paragraph    [21]    table1column:    [\begin{quote}\begin{tabular}{l}]     [\end{tabular}\end{quote}]
//paragraph    [22]    table2columns:   [\begin{quote}\begin{tabular}{ll}]    [\end{tabular}\end{quote}]
//paragraph    [23]    table3columns:   [\begin{quote}\begin{tabular}{lll}]   [\end{tabular}\end{quote}]
//paragraph    [24]    table4columns:   [\begin{quote}\begin{tabular}{llll}]  [\end{tabular}\end{quote}]
//[--------]    [\hline]
//characters    [1]    verbatim:   [$]    [$]
//characters    [2]    formula:    [$]    [$]
//characters    [3]    capital:    [\textsc{]    [}]
//characters    [4]    teletype:   [\texttt{]    [}]
//[ae] [\"a]
//[oe] [\"o]
//[ue] [\"u]
//[ss] [{\ss}]
//[<=] [\leq]
//[#]  [\neq]
//[tilde] [\verb|~|]
//[Contents] [\tableofcontents]

1 Header File: Progress View

*/

#ifndef PROGRESSVIEW_H
#define PROGRESSVIEW_H

#include "NList.h"
#include "Messages.h"          // msg->Send(msgList)
#include "Profiles.h"          // SmiProfile::GetParameter
#include "Progress.h"
#include "CharTransform.h"


class ProgressView
{
  public:

  ProgressView() : currentProgress(0.0), ofs(), 
                   initialized(false), startClock(0), msgList(), msg(0),
                   PROGRESS_NORM(50), 
                   DETPROT(0), PROGTYPECARD(0), PROGTYPEPROG(0)
  {

    std::string parmFile = expandVar("$(SECONDO_CONFIG)");
    PROGRESS_NORM = SmiProfile::GetParameter("ProgressEstimation", 
      "ProgNorm", 50, parmFile);
    DETPROT = SmiProfile::GetParameter("ProgressEstimation", 
      "ProgProt", 0, parmFile);
    DETPROT += 2 * SmiProfile::GetParameter("ProgressEstimation", 
      "ProgLog", 0, parmFile);
    PROGTYPECARD = SmiProfile::GetParameter("ProgressEstimation", 
      "ProgTypeCard", 0, parmFile);
    PROGTYPEPROG = SmiProfile::GetParameter("ProgressEstimation", 
      "ProgTypeProg", 0, parmFile);
    if (PROGTYPEPROG)
    {
      initialized = false;
      std::string fileName    = "proglogt.csv";
      if (DETPROT & 2) ofs.open(fileName.c_str(), std::ios::app);
    }
  }


  ~ProgressView()
  {        
    if (PROGTYPEPROG && (DETPROT & 2)) {
           ofs << endl; 
           ofs.close(); 
    }
  }

  void
  InitProgressView()
  {

    if (PROGTYPEPROG)
    {
      initialized  = true;
       startClock  = clock();
      msg = MessageCenter::GetInstance();

      msgList = NList(NList("progress"), 
                         NList(NList(-1), 
                         NList(PROGRESS_NORM)));
      msg->Send(nl,msgList.listExpr(),-1);
    }
  }

  void
  WriteCommandToProtocol(const std::string& commandText)
  {
    if (PROGTYPEPROG)
    {
      if (DETPROT & 2) {
        ofs << "'" << commandText << "'" << endl;
        ofs << endl;
      }
    }
  }

  void
  ModifyProgressView(ProgressInfo progress)
  {
    if (PROGTYPEPROG)
    {
      if (!initialized) InitProgressView();

       currentProgress = progress.Progress;
       if(currentProgress < 0){
         currentProgress = 0;
       } 
       if(currentProgress>1){
         currentProgress= 1;
       }
       double bProgress = progress.BProgress;
       bProgress = std::min(1.0,std::max(0.0,bProgress));

       int cp = (int) (currentProgress*PROGRESS_NORM);
       if(cp<0){  // found invalid value
          return;
       }

       msgList = NList( NList("progress"),
              NList( NList(cp), 
                     NList(PROGRESS_NORM)));
        msg->Send(nl,msgList.listExpr(),-1);
              
      if (DETPROT & 2)
      {

       uint64_t clocks = clock() - startClock;
       // convert clocks to milliseconds
       clocks = (clocks * 1000) / CLOCKS_PER_SEC;


       ofs << clocks << ";" ;



        ofs << (size_t) progress.Card << ";";
        ofs << (size_t) progress.Time << ";";
        // write progress as a,b where b has two digits 
        ofs << getProgStr(currentProgress*100.0) << ";";
        // write bTime
        ofs << (size_t) progress.BTime << ";";
        // write BProgress 
        ofs << getProgStr(bProgress*100) << ";";
        ofs << endl;
      }
    }
  }

  std::string getProgStr(const double v, const char sep=',') const{
      std::stringstream ss;
      ss << (int) v << sep;
      int aftercomma = (int) (v*100.0+0.5) % 100;
      if(aftercomma < 10){
         ss << "0";
      }
      ss << aftercomma;
      return ss.str();
  }


  void
  FinishProgressView()
  {
    if (PROGTYPEPROG && initialized)
    {
      initialized = false;

      // set progress to 100%
      msgList = NList( NList("progress"),
                           NList(NList(PROGRESS_NORM), 
                           NList(PROGRESS_NORM)));
      msg->Send(nl,msgList.listExpr(), -1);
    

      // mark end of progress messages
      msgList = NList(NList("progress"), NList(NList(0), NList(-1)));
      msg->Send(nl,msgList.listExpr(),-1);

      if (DETPROT & 2) {
            ofs << endl;
      }
    }
  }

  private:
    double currentProgress;
    std::ofstream ofs;
    bool initialized;
    clock_t startClock;
    NList msgList;
    MessageCenter* msg;
    int PROGRESS_NORM;
    int DETPROT;
    int PROGTYPECARD;
    int PROGTYPEPROG;
};

#endif