forked from Kitware/VTK
/
vtkSubCommunicator.h
89 lines (74 loc) · 2.65 KB
/
vtkSubCommunicator.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
// -*- c++ -*-
/*=========================================================================
Program: Visualization Toolkit
Module: vtkSubCommunicator.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm 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.
=========================================================================*/
/*----------------------------------------------------------------------------
Copyright (c) Sandia Corporation
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
----------------------------------------------------------------------------*/
/**
* @class vtkSubCommunicator
* @brief Provides communication on a process group.
*
*
*
* This class provides an implementation for communicating on process groups.
* In general, you should never use this class directly. Instead, use the
* vtkMultiProcessController::CreateSubController method.
*
*
* @bug
* Because all communication is delegated to the original communicator,
* any error will report process ids with respect to the original
* communicator, not this communicator that was actually used.
*
* @sa
* vtkCommunicator, vtkMultiProcessController
*
* @par Thanks:
* This class was originally written by Kenneth Moreland (kmorel@sandia.gov)
* from Sandia National Laboratories.
*
*/
#ifndef vtkSubCommunicator_h
#define vtkSubCommunicator_h
#include "vtkCommunicator.h"
#include "vtkParallelCoreModule.h" // For export macro
class vtkProcessGroup;
class VTKPARALLELCORE_EXPORT vtkSubCommunicator : public vtkCommunicator
{
public:
vtkTypeMacro(vtkSubCommunicator, vtkCommunicator);
static vtkSubCommunicator* New();
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Set/get the group on which communication will happen.
*/
vtkGetObjectMacro(Group, vtkProcessGroup);
virtual void SetGroup(vtkProcessGroup* group);
///@}
///@{
/**
* Implementation for abstract supercalss.
*/
int SendVoidArray(
const void* data, vtkIdType length, int type, int remoteHandle, int tag) override;
int ReceiveVoidArray(void* data, vtkIdType length, int type, int remoteHandle, int tag) override;
///@}
protected:
vtkSubCommunicator();
~vtkSubCommunicator() override;
vtkProcessGroup* Group;
private:
vtkSubCommunicator(const vtkSubCommunicator&) = delete;
void operator=(const vtkSubCommunicator&) = delete;
};
#endif // vtkSubCommunicator_h