Servers/Common/vtkPVProgressHandler.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    $RCSfile: vtkPVProgressHandler.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkPVProgressHandler_h
#define __vtkPVProgressHandler_h


#include "vtkObject.h"

class vtkProcessModule;
class vtkPVWindow;
class vtkTimerLog;
class vtkMPIController;
class vtkSocketController;
class vtkPVProgressHandlerInternal;

class VTK_EXPORT vtkPVProgressHandler : public vtkObject
{
public:
  static vtkPVProgressHandler* New();
  vtkTypeRevisionMacro(vtkPVProgressHandler, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);



  virtual void SetProcessModule(vtkProcessModule *pvApp)
    {
    this->ProcessModule = pvApp;
    }


  virtual void InvokeProgressEvent(
    vtkProcessModule* pvApp,
    vtkObject* object,
    int val,
    const char* str);

  virtual void Cleanup() {}


  virtual void PrepareProgress(vtkProcessModule* app);

  virtual void CleanupPendingProgress(vtkProcessModule* app);

  virtual void RegisterProgressEvent(vtkObject* po, int id);

  virtual void SetSocketController(vtkSocketController* soc);


  vtkSetMacro(ClientMode, int);
  vtkSetMacro(ServerMode, int);
  
protected:
  vtkPVProgressHandler();
  ~vtkPVProgressHandler();

  vtkProcessModule* ProcessModule;

  int ReceivingProgressReports;

  //BTX
  int ProgressPending;
  int Progress[4];


  enum {
    NotSet = 0,
    SingleProcess,
    SingleProcessMPI,
    SatelliteMPI,
    ClientServerClient,
    ClientServerServer,
    ClientServerServerMPI
  };
  //ETX
  
  void DetermineProgressType(vtkProcessModule* app);
  int ProgressType;

  int ClientMode;
  int ServerMode;
  int LocalProcessID;
  int NumberOfProcesses;

  void InvokeSatelliteProgressEvent(vtkProcessModule*, vtkObject*, int val);
  void InvokeRootNodeProgressEvent(vtkProcessModule*, vtkObject*, int val);
  void InvokeRootNodeServerProgressEvent(vtkProcessModule*, vtkObject*, int val);
  int ReceiveProgressFromSatellite(int* id, int* progress);
  void LocalDisplayProgress(vtkProcessModule* app, const char* filter, int progress);
  void HandleProgress(int processid, int filterid, int progress);

  double MinimumProgressInterval;
  vtkTimerLog* ProgressTimer;

  vtkMPIController* MPIController;
  vtkSocketController* SocketController;
  vtkPVProgressHandlerInternal* Internals;

  vtkPVProgressHandler(const vtkPVProgressHandler&); // Not implemented
  void operator=(const vtkPVProgressHandler&); // Not implemented
};

#endif

---