FieldSelection.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  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 viskores_filter_FieldSelection_h
#define viskores_filter_FieldSelection_h
 
#include <viskores/Pair.h>
#include <viskores/cont/Field.h>
 
#include <viskores/filter/viskores_filter_core_export.h>
 
#include <initializer_list>
#include <memory>
 
namespace viskores
{
namespace filter
{
 
class VISKORES_FILTER_CORE_EXPORT FieldSelection
{
public:
  enum struct Mode
  {
    None,
    All,
    Select,
    Exclude
  };
 
  VISKORES_CONT FieldSelection(Mode mode = Mode::Select);
 
  VISKORES_CONT FieldSelection(const std::string& field, Mode mode = Mode::Select);
 
  VISKORES_CONT FieldSelection(const char* field, Mode mode = Mode::Select);
 
  VISKORES_CONT FieldSelection(const std::string& field,
                               viskores::cont::Field::Association association,
                               Mode mode = Mode::Select);
 
  VISKORES_CONT FieldSelection(std::initializer_list<std::string> fields, Mode mode = Mode::Select);
 
  VISKORES_CONT FieldSelection(
    std::initializer_list<std::pair<std::string, viskores::cont::Field::Association>> fields,
    Mode mode = Mode::Select);
 
  VISKORES_CONT FieldSelection(
    std::initializer_list<viskores::Pair<std::string, viskores::cont::Field::Association>> fields,
    Mode mode = Mode::Select);
 
  VISKORES_CONT FieldSelection(const FieldSelection& src);
  VISKORES_CONT FieldSelection(FieldSelection&& rhs);
  VISKORES_CONT FieldSelection& operator=(const FieldSelection& src);
  VISKORES_CONT FieldSelection& operator=(FieldSelection&& rhs);
 
  VISKORES_CONT ~FieldSelection();
 
  VISKORES_CONT
  bool IsFieldSelected(const viskores::cont::Field& inputField) const
  {
    return this->IsFieldSelected(inputField.GetName(), inputField.GetAssociation());
  }
 
  VISKORES_CONT bool IsFieldSelected(
    const std::string& name,
    viskores::cont::Field::Association association = viskores::cont::Field::Association::Any) const;
 
  VISKORES_CONT void AddField(const viskores::cont::Field& inputField)
  {
    this->AddField(inputField.GetName(), inputField.GetAssociation(), this->GetMode());
  }
 
  VISKORES_CONT void AddField(const viskores::cont::Field& inputField, Mode mode)
  {
    this->AddField(inputField.GetName(), inputField.GetAssociation(), mode);
  }
 
  VISKORES_CONT
  void AddField(
    const std::string& fieldName,
    viskores::cont::Field::Association association = viskores::cont::Field::Association::Any)
  {
    this->AddField(fieldName, association, this->GetMode());
  }
 
  VISKORES_CONT void AddField(const std::string& fieldName, Mode mode)
  {
    this->AddField(fieldName, viskores::cont::Field::Association::Any, mode);
  }
 
  VISKORES_CONT void AddField(const std::string& fieldName,
                              viskores::cont::Field::Association association,
                              Mode mode);
 
  VISKORES_CONT Mode GetFieldMode(const viskores::cont::Field& inputField) const
  {
    return this->GetFieldMode(inputField.GetName(), inputField.GetAssociation());
  }
 
  VISKORES_CONT Mode GetFieldMode(
    const std::string& fieldName,
    viskores::cont::Field::Association association = viskores::cont::Field::Association::Any) const;
 
  VISKORES_CONT bool HasField(const viskores::cont::Field& inputField) const
  {
    return this->HasField(inputField.GetName(), inputField.GetAssociation());
  }
 
  VISKORES_CONT bool HasField(
    const std::string& name,
    viskores::cont::Field::Association association = viskores::cont::Field::Association::Any) const
  {
    return (this->GetFieldMode(name, association) != Mode::None);
  }
 
  VISKORES_CONT void ClearFields();
 
  VISKORES_CONT Mode GetMode() const;
 
  VISKORES_CONT void SetMode(Mode val);
 
private:
  struct InternalStruct;
  std::unique_ptr<InternalStruct> Internals;
};
 
}
} // namespace viskores::filter
 
#endif // viskores_filter_FieldSelection_h