VTK  9.0.20210510
Public Member Functions | List of all members
vtkPainterCommunicator Class Reference

A communicator that can safely be used inside a painter. More...

#include <vtkPainterCommunicator.h>

Inheritance diagram for vtkPainterCommunicator:
[legend]

Public Member Functions

 vtkPainterCommunicator ()=default
 
virtual ~vtkPainterCommunicator ()=default
 
 vtkPainterCommunicator (const vtkPainterCommunicator &other)
 Copy and assignment operators. More...
 
vtkPainterCommunicatoroperator= (const vtkPainterCommunicator &other)
 
virtual void Copy (const vtkPainterCommunicator *, bool)
 Copy the communicator, the flag indicates if ownership should be assumed. More...
 
virtual void Duplicate (const vtkPainterCommunicator *)
 Duplicate the communicator. More...
 
virtual int GetRank ()
 Querry MPI about the communicator. More...
 
virtual int GetSize ()
 
virtual bool GetIsNull ()
 
virtual int GetWorldRank ()
 Querry MPI about the world communicator. More...
 
virtual int GetWorldSize ()
 
virtual bool GetMPIInitialized ()
 Querry MPI about its state. More...
 
virtual bool GetMPIFinalized ()
 

Detailed Description

A communicator that can safely be used inside a painter.

ranks that will execute a painter chain.

A simple container holding a handle to an MPI communicator. This API is sufficient to allow for control flow with/without MPI. The parallel parts of the code should use the derived class vtkPPainterCommunicator.

A communicator that can safely be used inside a painter. A simple container holding an MPI communicator. The simple API is sufficient to allow serial code (no MPI available) to steer execution.

Definition at line 30 of file vtkPainterCommunicator.h.

Constructor & Destructor Documentation

◆ vtkPainterCommunicator() [1/2]

vtkPainterCommunicator::vtkPainterCommunicator ( )
default

◆ ~vtkPainterCommunicator()

virtual vtkPainterCommunicator::~vtkPainterCommunicator ( )
virtualdefault

◆ vtkPainterCommunicator() [2/2]

vtkPainterCommunicator::vtkPainterCommunicator ( const vtkPainterCommunicator other)
inline

Copy and assignment operators.

Both use Copy internally and do take ownership.

Definition at line 40 of file vtkPainterCommunicator.h.

Member Function Documentation

◆ operator=()

vtkPainterCommunicator& vtkPainterCommunicator::operator= ( const vtkPainterCommunicator other)
inline

Definition at line 42 of file vtkPainterCommunicator.h.

◆ Copy()

virtual void vtkPainterCommunicator::Copy ( const vtkPainterCommunicator ,
bool   
)
inlinevirtual

Copy the communicator, the flag indicates if ownership should be assumed.

The owner is responsible for free'ing the communicator.

Reimplemented in vtkPPainterCommunicator.

Definition at line 53 of file vtkPainterCommunicator.h.

◆ Duplicate()

virtual void vtkPainterCommunicator::Duplicate ( const vtkPainterCommunicator )
inlinevirtual

Duplicate the communicator.

Reimplemented in vtkPPainterCommunicator.

Definition at line 58 of file vtkPainterCommunicator.h.

◆ GetRank()

virtual int vtkPainterCommunicator::GetRank ( )
inlinevirtual

Querry MPI about the communicator.

Reimplemented in vtkPPainterCommunicator.

Definition at line 63 of file vtkPainterCommunicator.h.

◆ GetSize()

virtual int vtkPainterCommunicator::GetSize ( )
inlinevirtual

Reimplemented in vtkPPainterCommunicator.

Definition at line 64 of file vtkPainterCommunicator.h.

◆ GetIsNull()

virtual bool vtkPainterCommunicator::GetIsNull ( )
inlinevirtual

Reimplemented in vtkPPainterCommunicator.

Definition at line 65 of file vtkPainterCommunicator.h.

◆ GetWorldRank()

virtual int vtkPainterCommunicator::GetWorldRank ( )
inlinevirtual

Querry MPI about the world communicator.

Reimplemented in vtkPPainterCommunicator.

Definition at line 70 of file vtkPainterCommunicator.h.

◆ GetWorldSize()

virtual int vtkPainterCommunicator::GetWorldSize ( )
inlinevirtual

Reimplemented in vtkPPainterCommunicator.

Definition at line 71 of file vtkPainterCommunicator.h.

◆ GetMPIInitialized()

virtual bool vtkPainterCommunicator::GetMPIInitialized ( )
inlinevirtual

Querry MPI about its state.

Reimplemented in vtkPPainterCommunicator.

Definition at line 76 of file vtkPainterCommunicator.h.

◆ GetMPIFinalized()

virtual bool vtkPainterCommunicator::GetMPIFinalized ( )
inlinevirtual

Reimplemented in vtkPPainterCommunicator.

Definition at line 77 of file vtkPainterCommunicator.h.


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