You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

90 lines
2.6 KiB
C++

// -*- 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