vtkExtentTranslator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkExtentTranslator_h
#define vtkExtentTranslator_h
 
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkInformationIntegerRequestKey;
class vtkInformationIntegerKey;
 
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkExtentTranslator : public vtkObject
{
public:
  static vtkExtentTranslator* New();
 
  vtkTypeMacro(vtkExtentTranslator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetVector6Macro(WholeExtent, int);
  vtkGetVector6Macro(WholeExtent, int);
  vtkSetVector6Macro(Extent, int);
  vtkGetVector6Macro(Extent, int);
  vtkSetMacro(Piece, int);
  vtkGetMacro(Piece, int);
  vtkSetMacro(NumberOfPieces, int);
  vtkGetMacro(NumberOfPieces, int);
  vtkSetMacro(GhostLevel, int);
  vtkGetMacro(GhostLevel, int);
 
 
  virtual int PieceToExtent();
  virtual int PieceToExtentByPoints();
  virtual int PieceToExtentThreadSafe(int piece, int numPieces, int ghostLevel, int* wholeExtent,
    int* resultExtent, int splitMode, int byPoints);
 
  void SetSplitModeToBlock() { this->SplitMode = vtkExtentTranslator::BLOCK_MODE; }
  void SetSplitModeToXSlab() { this->SplitMode = vtkExtentTranslator::X_SLAB_MODE; }
  void SetSplitModeToYSlab() { this->SplitMode = vtkExtentTranslator::Y_SLAB_MODE; }
  void SetSplitModeToZSlab() { this->SplitMode = vtkExtentTranslator::Z_SLAB_MODE; }
  vtkGetMacro(SplitMode, int);
 
  void SetSplitPath(int len, int* splitpath);
 
  // Don't change the numbers here - they are used in the code
  // to indicate array indices.
  enum Modes
  {
    X_SLAB_MODE = 0,
    Y_SLAB_MODE = 1,
    Z_SLAB_MODE = 2,
    BLOCK_MODE = 3
  };
 
  static vtkInformationIntegerRequestKey* UPDATE_SPLIT_MODE();
 
protected:
  vtkExtentTranslator();
  ~vtkExtentTranslator() override;
 
  static vtkInformationIntegerKey* DATA_SPLIT_MODE();
 
  friend class vtkInformationSplitModeRequestKey;
 
 
  int SplitExtent(int piece, int numPieces, int* extent, int splitMode);
  int SplitExtentByPoints(int piece, int numPieces, int* extent, int splitMode);
 
  int Piece;
  int NumberOfPieces;
  int GhostLevel;
  int Extent[6];
  int WholeExtent[6];
  int SplitMode;
 
  int* SplitPath;
  int SplitLen;
 
private:
  vtkExtentTranslator(const vtkExtentTranslator&) = delete;
  void operator=(const vtkExtentTranslator&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif