Public Member Functions | List of all members
vtkCommunicationErrorCatcher Class Reference

helper class to catch errors from vtkMultiProcessController and vtkCommunicator. More...

#include <vtkCommunicationErrorCatcher.h>

Public Member Functions

 vtkCommunicationErrorCatcher (vtkMultiProcessController *)
 
 vtkCommunicationErrorCatcher (vtkCommunicator *)
 
virtual ~vtkCommunicationErrorCatcher ()
 
bool GetErrorsRaised () const
 Get the status of errors. More...
 
const std::stringGetErrorMessages () const
 Get the combined error messages. More...
 

Detailed Description

helper class to catch errors from vtkMultiProcessController and vtkCommunicator.

vtkCommunicationErrorCatcher is helper class designed to catch errors from vtkCommunicator and vtkCommunicator. This is not a vtkObject and hence is designed to be created on the stack directly for watching error during a set of calls and not over the lifetime of the controller/communicator. For that, simply add your own observers for vtkCommand::ErrorEvent and intercept those. Note that is vtkObject::GlobalWarningDisplay is off, this class will not receive any ErrorEvents and hence will not report any errors that were raised.

Definition at line 30 of file vtkCommunicationErrorCatcher.h.

Constructor & Destructor Documentation

◆ vtkCommunicationErrorCatcher() [1/2]

vtkCommunicationErrorCatcher::vtkCommunicationErrorCatcher ( vtkMultiProcessController )

◆ vtkCommunicationErrorCatcher() [2/2]

vtkCommunicationErrorCatcher::vtkCommunicationErrorCatcher ( vtkCommunicator )

◆ ~vtkCommunicationErrorCatcher()

virtual vtkCommunicationErrorCatcher::~vtkCommunicationErrorCatcher ( )
virtual

Member Function Documentation

◆ GetErrorsRaised()

bool vtkCommunicationErrorCatcher::GetErrorsRaised ( ) const
inline

Get the status of errors.

Definition at line 40 of file vtkCommunicationErrorCatcher.h.

◆ GetErrorMessages()

const std::string& vtkCommunicationErrorCatcher::GetErrorMessages ( ) const
inline

Get the combined error messages.

Definition at line 45 of file vtkCommunicationErrorCatcher.h.


The documentation for this class was generated from the following file: