vtkCommunicationErrorCatcher.h

Go to the documentation of this file.

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

#include "vtkPVVTKExtensionsCoreModule.h" // needed for export macro
#include "vtkWeakPointer.h"               // needed for vtkWeakPointer.
#include <string>                         // for std::string

class vtkCommunicator;
class vtkMultiProcessController;
class vtkObject;

class VTKPVVTKEXTENSIONSCORE_EXPORT vtkCommunicationErrorCatcher
{
public:
  vtkCommunicationErrorCatcher(vtkMultiProcessController*);
  vtkCommunicationErrorCatcher(vtkCommunicator*);
  virtual ~vtkCommunicationErrorCatcher();

  bool GetErrorsRaised() const { return this->ErrorsRaised; }

  const std::string& GetErrorMessages() const { return this->ErrorMessages; }

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

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

  vtkWeakPointer<vtkMultiProcessController> Controller;
  vtkWeakPointer<vtkCommunicator> Communicator;

  bool ErrorsRaised;
  std::string ErrorMessages;
  unsigned long ControllerObserverId;
  unsigned long CommunicatorObserverId;
};

#endif
// VTK-HeaderTest-Exclude: vtkCommunicationErrorCatcher.h