vtkJoinTables.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 vtkJoinTables_h
#define vtkJoinTables_h
 
#include "vtkDataArray.h"            // For numeric key columns
#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkStringArray.h"          // For string key columns
#include "vtkTable.h"                // For table inputs
#include "vtkTableAlgorithm.h"
 
#include <map>    // For left and right key maps
#include <string> // For LeftKey and RightKey
 
VTK_ABI_NAMESPACE_BEGIN
class VTKFILTERSGENERAL_EXPORT vtkJoinTables : public vtkTableAlgorithm
{
public:
  static vtkJoinTables* New();
  vtkTypeMacro(vtkJoinTables, vtkTableAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  enum JoinMode
  {
    INTERSECTION = 0,
    UNION = 1,
    LEFT = 2,
    RIGHT = 3
  };


  vtkSetClampMacro(Mode, int, 0, 3);
  vtkGetMacro(Mode, int);


  vtkSetMacro(ReplacementValue, double);
  vtkGetMacro(ReplacementValue, double);


  vtkSetStdStringFromCharMacro(LeftKey);
  vtkGetCharFromStdStringMacro(LeftKey);


  vtkSetStdStringFromCharMacro(RightKey);
  vtkGetCharFromStdStringMacro(RightKey);

  void SetSourceConnection(vtkAlgorithmOutput* source);

  void SetSourceData(vtkTable* source);
 
protected:
  vtkJoinTables();
  ~vtkJoinTables() override = default;
 
  template <typename T>
  struct Maps
  {
    std::map<T, int> left;
    std::map<T, int> right;
  };
 
  template <typename ColType, typename KeyColType, typename KeyValues>
  void MergeColumn(ColType*, ColType*, KeyColType*, const char*, std::map<KeyValues, int>);
 
  template <typename KeyColType, typename KeyValues>
  void JoinAlgorithm(vtkTable*, vtkTable*, vtkTable*, KeyColType*, KeyColType*, Maps<KeyValues>*);
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int, vtkInformation*) override;
 
  int Mode = JoinMode::INTERSECTION;
  std::string LeftKey;
  std::string RightKey;
  double ReplacementValue = 0;
 
private:
  vtkJoinTables(const vtkJoinTables&) = delete;
  void operator=(const vtkJoinTables&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#include "vtkJoinTables.txx" // for template implementations
 
#endif