GhostCellRemove.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_entity_extraction_GhostCellRemove_h
#define viskores_filter_entity_extraction_GhostCellRemove_h
 
#include <viskores/CellClassification.h>
#include <viskores/Deprecated.h>
#include <viskores/filter/Filter.h>
#include <viskores/filter/entity_extraction/viskores_filter_entity_extraction_export.h>
 
namespace viskores
{
namespace filter
{
namespace entity_extraction
{
class VISKORES_FILTER_ENTITY_EXTRACTION_EXPORT GhostCellRemove : public viskores::filter::Filter
{
public:
  VISKORES_CONT GhostCellRemove();
 
  VISKORES_CONT void SetRemoveGhostField(bool flag) { this->RemoveField = flag; }
  VISKORES_CONT bool GetRemoveGhostField() const { return this->RemoveField; }
 
  VISKORES_CONT void SetTypesToRemove(viskores::UInt8 typeFlags)
  {
    this->TypesToRemove = typeFlags;
  }
  VISKORES_CONT viskores::UInt8 GetTypesToRemove() const { return this->TypesToRemove; }
 
  VISKORES_CONT void SetTypesToRemoveToAll() { this->SetTypesToRemove(0xFF); }
  VISKORES_CONT bool AreAllTypesRemoved() const { return this->GetTypesToRemove() == 0xFF; }
 
  VISKORES_DEPRECATED(2.1, "Use SetRemoveGhostField(true).")
  VISKORES_CONT void RemoveGhostField() { this->SetRemoveGhostField(true); }
  VISKORES_DEPRECATED(2.1, "Use SetTypesToRemoveToAll().")
  VISKORES_CONT void RemoveAllGhost() { this->SetTypesToRemoveToAll(); }
  VISKORES_DEPRECATED(2.1, "Use SetTypesToRemove(vals).")
  VISKORES_CONT void RemoveByType(const viskores::UInt8& vals) { this->SetTypesToRemove(vals); }
 
  VISKORES_DEPRECATED(2.1, "Use AreAllTypesRemoved().")
  VISKORES_CONT bool GetRemoveAllGhost() const { return this->AreAllTypesRemoved(); }
 
  VISKORES_CONT bool GetUseGhostCellsAsField() const { return this->UseGhostCellsAsField; }
  VISKORES_CONT void SetUseGhostCellsAsField(bool flag) { this->UseGhostCellsAsField = flag; }
 
  VISKORES_DEPRECATED(2.1, "Use !AreAllTypesRemoved().")
  VISKORES_CONT bool GetRemoveByType() const { return !this->AreAllTypesRemoved(); }
  VISKORES_DEPRECATED(2.1, "Use GetTypesToRemove().")
  VISKORES_CONT viskores::UInt8 GetRemoveType() const { return this->GetTypesToRemove(); }
 
private:
  VISKORES_CONT
  viskores::cont::DataSet DoExecute(const viskores::cont::DataSet& input) override;
 
  bool UseGhostCellsAsField = true;
  bool RemoveField = false;
  viskores::UInt8 TypesToRemove = 0xFF;
};
 
} // namespace entity_extraction
} // namespace filter
} // namespace viskores
 
#endif // viskores_filter_entity_extraction_GhostCellRemove_h