vtkProcessGroup.h

Go to the documentation of this file.

// -*- c++ -*-
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkProcessGroup.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.
----------------------------------------------------------------------------*/

#ifndef vtkProcessGroup_h
#define vtkProcessGroup_h

#include "vtkParallelCoreModule.h" // For export macro
#include "vtkObject.h"

class vtkMultiProcessController;
class vtkCommunicator;

class VTKPARALLELCORE_EXPORT vtkProcessGroup : public vtkObject
{
public:
  vtkTypeMacro(vtkProcessGroup, vtkObject);
  static vtkProcessGroup *New();
  virtual void PrintSelf(ostream &os, vtkIndent indent);


  void Initialize(vtkMultiProcessController *controller);
  void Initialize(vtkCommunicator *communicator);


  vtkGetObjectMacro(Communicator, vtkCommunicator);

  void SetCommunicator(vtkCommunicator *communicator);


  vtkGetMacro(NumberOfProcessIds, int);

  int GetProcessId(int pos) { return this->ProcessIds[pos]; }

  int GetLocalProcessId();

  int FindProcessId(int processId);

  int AddProcessId(int processId);

  int RemoveProcessId(int processId);

  void RemoveAllProcessIds();

  void Copy(vtkProcessGroup *group);

protected:
  vtkProcessGroup();
  virtual ~vtkProcessGroup();

  int *ProcessIds;
  int NumberOfProcessIds;

  vtkCommunicator *Communicator;

private:
  vtkProcessGroup(const vtkProcessGroup &) VTK_DELETE_FUNCTION;
  void operator=(const vtkProcessGroup &) VTK_DELETE_FUNCTION;
};

#endif //vtkProcessGroup_h