FieldSelection.h

Go to the documentation of this file.

//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt 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.
//============================================================================
#ifndef vtk_m_filter_FieldSelection_h
#define vtk_m_filter_FieldSelection_h
 
#include <vtkm/Pair.h>
#include <vtkm/cont/Field.h>
 
#include <vtkm/filter/vtkm_filter_core_export.h>
 
#include <initializer_list>
#include <memory>
 
namespace vtkm
{
namespace filter
{
 
class VTKM_FILTER_CORE_EXPORT FieldSelection
{
public:
  enum struct Mode
  {
    None,
    All,
    Select,
    Exclude
  };
 
  VTKM_CONT FieldSelection(Mode mode = Mode::Select);
 
  VTKM_CONT FieldSelection(const std::string& field, Mode mode = Mode::Select);
 
  VTKM_CONT FieldSelection(const char* field, Mode mode = Mode::Select);
 
  VTKM_CONT FieldSelection(const std::string& field,
                           vtkm::cont::Field::Association association,
                           Mode mode = Mode::Select);
 
  VTKM_CONT FieldSelection(std::initializer_list<std::string> fields, Mode mode = Mode::Select);
 
  VTKM_CONT FieldSelection(
    std::initializer_list<std::pair<std::string, vtkm::cont::Field::Association>> fields,
    Mode mode = Mode::Select);
 
  VTKM_CONT FieldSelection(
    std::initializer_list<vtkm::Pair<std::string, vtkm::cont::Field::Association>> fields,
    Mode mode = Mode::Select);
 
  VTKM_CONT FieldSelection(const FieldSelection& src);
  VTKM_CONT FieldSelection(FieldSelection&& rhs);
  VTKM_CONT FieldSelection& operator=(const FieldSelection& src);
  VTKM_CONT FieldSelection& operator=(FieldSelection&& rhs);
 
  VTKM_CONT ~FieldSelection();
 
  VTKM_CONT
  bool IsFieldSelected(const vtkm::cont::Field& inputField) const
  {
    return this->IsFieldSelected(inputField.GetName(), inputField.GetAssociation());
  }
 
  VTKM_CONT bool IsFieldSelected(
    const std::string& name,
    vtkm::cont::Field::Association association = vtkm::cont::Field::Association::Any) const;
 
  VTKM_CONT void AddField(const vtkm::cont::Field& inputField)
  {
    this->AddField(inputField.GetName(), inputField.GetAssociation(), this->GetMode());
  }
 
  VTKM_CONT void AddField(const vtkm::cont::Field& inputField, Mode mode)
  {
    this->AddField(inputField.GetName(), inputField.GetAssociation(), mode);
  }
 
  VTKM_CONT
  void AddField(const std::string& fieldName,
                vtkm::cont::Field::Association association = vtkm::cont::Field::Association::Any)
  {
    this->AddField(fieldName, association, this->GetMode());
  }
 
  VTKM_CONT void AddField(const std::string& fieldName, Mode mode)
  {
    this->AddField(fieldName, vtkm::cont::Field::Association::Any, mode);
  }
 
  VTKM_CONT void AddField(const std::string& fieldName,
                          vtkm::cont::Field::Association association,
                          Mode mode);
 
  VTKM_CONT Mode GetFieldMode(const vtkm::cont::Field& inputField) const
  {
    return this->GetFieldMode(inputField.GetName(), inputField.GetAssociation());
  }
 
  VTKM_CONT Mode GetFieldMode(
    const std::string& fieldName,
    vtkm::cont::Field::Association association = vtkm::cont::Field::Association::Any) const;
 
  VTKM_CONT bool HasField(const vtkm::cont::Field& inputField) const
  {
    return this->HasField(inputField.GetName(), inputField.GetAssociation());
  }
 
  VTKM_CONT bool HasField(
    const std::string& name,
    vtkm::cont::Field::Association association = vtkm::cont::Field::Association::Any) const
  {
    return (this->GetFieldMode(name, association) != Mode::None);
  }
 
  VTKM_CONT void ClearFields();
 
  VTKM_CONT Mode GetMode() const;
 
  VTKM_CONT void SetMode(Mode val);
 
private:
  struct InternalStruct;
  std::unique_ptr<InternalStruct> Internals;
};
 
}
} // namespace vtkm::filter
 
#endif // vtk_m_filter_FieldSelection_h