vtkSplitColumnComponents.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-NVIDIA-USGov
#ifndef vtkSplitColumnComponents_h
#define vtkSplitColumnComponents_h
 
#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkTableAlgorithm.h"
 
#include <string> // for std::string
 
VTK_ABI_NAMESPACE_BEGIN
class vtkInformationIntegerKey;
class vtkInformationStringKey;
 
class VTKFILTERSGENERAL_EXPORT vtkSplitColumnComponents : public vtkTableAlgorithm
{
public:
  static vtkSplitColumnComponents* New();
  vtkTypeMacro(vtkSplitColumnComponents, vtkTableAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetMacro(CalculateMagnitudes, bool);
  vtkGetMacro(CalculateMagnitudes, bool);
  vtkBooleanMacro(CalculateMagnitudes, bool);
 
  enum
  {
    NUMBERS_WITH_PARENS = 0,      // e.g Points (0)
    NAMES_WITH_PARENS = 1,        // e.g. Points (X)
    NUMBERS_WITH_UNDERSCORES = 2, // e.g. Points_0
    NAMES_WITH_UNDERSCORES = 3    // e.g. Points_X
  };
 
 
  vtkSetClampMacro(NamingMode, int, NUMBERS_WITH_PARENS, NAMES_WITH_UNDERSCORES);
  void SetNamingModeToNumberWithParens() { this->SetNamingMode(NUMBERS_WITH_PARENS); }
  void SetNamingModeToNumberWithUnderscores() { this->SetNamingMode(NUMBERS_WITH_UNDERSCORES); }
  void SetNamingModeToNamesWithParens() { this->SetNamingMode(NAMES_WITH_PARENS); }
  void SetNamingModeToNamesWithUnderscores() { this->SetNamingMode(NAMES_WITH_UNDERSCORES); }
  vtkGetMacro(NamingMode, int);
 
 
  static vtkInformationStringKey* ORIGINAL_ARRAY_NAME();
  static vtkInformationIntegerKey* ORIGINAL_COMPONENT_NUMBER();
 
protected:
  vtkSplitColumnComponents();
  ~vtkSplitColumnComponents() override;
 
  std::string GetComponentLabel(vtkAbstractArray* array, int component_no);
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
private:
  vtkSplitColumnComponents(const vtkSplitColumnComponents&) = delete;
  void operator=(const vtkSplitColumnComponents&) = delete;
 
  bool CalculateMagnitudes;
  int NamingMode;
};
 
VTK_ABI_NAMESPACE_END
#endif