vtkPVProgressHandler.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVProgressHandler_h
#define vtkPVProgressHandler_h

#include "vtkObject.h"
#include "vtkRemotingCoreModule.h" //needed for exports

#include <set>

class vtkMultiProcessController;
class vtkPVSession;

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


  void SetSession(vtkPVSession* conn);
  vtkGetObjectMacro(Session, vtkPVSession);

  void RegisterProgressEvent(vtkObject* object, int id);

  void PrepareProgress();

  void AddHandlers();

  bool GetEnableProgress();

  void CleanupPendingProgress();

  void LocalCleanupPendingProgress();


  vtkSetClampMacro(ProgressInterval, double, 0.01, 30.0);
  vtkGetMacro(ProgressInterval, double);


  vtkGetStringMacro(LastProgressText);
  vtkGetMacro(LastProgress, int);
  vtkGetMacro(LastProgressId, vtkTypeUInt32);

  void Abort(vtkTypeUInt32 objectId);

  std::set<int> GetAbortedObjectIds();

  void ClearAbortedObjectIds();

  void EnableAbortCheck(vtkTypeUInt32 objectId);

protected:
  vtkPVProgressHandler();
  ~vtkPVProgressHandler() override;

  enum TAGS
  {
    ABORT_TAG = 188968,
    CLEANUP_TAG = 188969,
    PROGRESS_EVENT_TAG = 188970,
    MESSAGE_EVENT_TAG = 188971
  };

  enum RMI_TAGS
  {
    CLEANUP_TAG_RMI = 188972,
    MESSAGE_EVENT_TAG_RMI = 188973
  };

  void RefreshProgress(const char* progress_text, double progress, vtkTypeUInt32 progress_id);

  vtkPVSession* Session;
  double ProgressInterval;

private:
  vtkPVProgressHandler(const vtkPVProgressHandler&) = delete;
  void operator=(const vtkPVProgressHandler&) = delete;

  void OnProgressEvent(vtkObject* caller, unsigned long eventid, void* calldata);

  void OnMessageEvent(vtkObject* caller, unsigned long eventid, void* calldata);

  bool OnWrongTagEvent(vtkObject* caller, unsigned long eventid, void* calldata);

  void RefreshMessage(const char* message_text, int eventid, bool is_local);

  void CheckAbort(vtkTypeUInt32 progressId, vtkObject* caller, vtkObject* communicator);

  bool AddedHandlers;
  class vtkInternals;
  vtkInternals* Internals;

  vtkSetStringMacro(LastProgressText);
  int LastProgress;
  char* LastProgressText;
  vtkTypeUInt32 LastProgressId;

  class RMICallback;
  friend class RMICallback;
  ;
};

#endif