mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-19 02:25:42 +00:00
f4362a4902
VTK-m style guidelines dictate that all classes part of the API should be in their own header file. Thus, we have moved the result classes out of the filter header files and into their own headers. We have also renamed these clases to ResultField and ResultDataSet to better match the class naming conventions of VTK-m. Since we are moving around these result classes, we have also revamped their structure. They are now in a hierarchy with a common ResultBase class. Additionally, all result classes have a reference to a complete DataSet that can be considered the output of the filter. This will make it easier for users to consistently deal with filter results. These changes cover issues #60 and #62.
101 lines
3.3 KiB
C++
101 lines
3.3 KiB
C++
//============================================================================
|
|
// 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.
|
|
//
|
|
// Copyright 2014 Sandia Corporation.
|
|
// Copyright 2014 UT-Battelle, LLC.
|
|
// Copyright 2014 Los Alamos National Security.
|
|
//
|
|
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
|
// the U.S. Government retains certain rights in this software.
|
|
//
|
|
// Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
|
|
// Laboratory (LANL), the U.S. Government retains certain rights in
|
|
// this software.
|
|
//============================================================================
|
|
|
|
#ifndef vtk_m_filter_FieldFilter_h
|
|
#define vtk_m_filter_FieldFilter_h
|
|
|
|
#include <vtkm/cont/DataSet.h>
|
|
#include <vtkm/cont/CoordinateSystem.h>
|
|
#include <vtkm/cont/Field.h>
|
|
|
|
#include <vtkm/filter/PolicyBase.h>
|
|
#include <vtkm/filter/ResultField.h>
|
|
#include <vtkm/filter/internal/RuntimeDeviceTracker.h>
|
|
|
|
namespace vtkm {
|
|
namespace filter {
|
|
|
|
template<class Derived>
|
|
class FilterField
|
|
{
|
|
public:
|
|
VTKM_CONT_EXPORT
|
|
void SetOutputFieldName( const std::string& name )
|
|
{ this->OutputFieldName = name; }
|
|
|
|
VTKM_CONT_EXPORT
|
|
const std::string& GetOutputFieldName() const
|
|
{ return this->OutputFieldName; }
|
|
|
|
VTKM_CONT_EXPORT
|
|
ResultField Execute(const vtkm::cont::DataSet &input, const std::string &inFieldName);
|
|
|
|
VTKM_CONT_EXPORT
|
|
ResultField Execute(const vtkm::cont::DataSet &input, const vtkm::cont::Field &field);
|
|
|
|
VTKM_CONT_EXPORT
|
|
ResultField Execute(const vtkm::cont::DataSet &input, const vtkm::cont::CoordinateSystem &field);
|
|
|
|
|
|
template<typename DerivedPolicy>
|
|
VTKM_CONT_EXPORT
|
|
ResultField Execute(const vtkm::cont::DataSet &input,
|
|
const std::string &inFieldName,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy );
|
|
|
|
template<typename DerivedPolicy>
|
|
VTKM_CONT_EXPORT
|
|
ResultField Execute(const vtkm::cont::DataSet &input,
|
|
const vtkm::cont::Field &field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy );
|
|
|
|
template<typename DerivedPolicy>
|
|
VTKM_CONT_EXPORT
|
|
ResultField Execute(const vtkm::cont::DataSet &input,
|
|
const vtkm::cont::CoordinateSystem &field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy );
|
|
|
|
|
|
private:
|
|
|
|
template<typename DerivedPolicy>
|
|
VTKM_CONT_EXPORT
|
|
ResultField PrepareForExecution(const vtkm::cont::DataSet& input,
|
|
const vtkm::cont::Field& field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy);
|
|
|
|
template<typename DerivedPolicy>
|
|
VTKM_CONT_EXPORT
|
|
ResultField PrepareForExecution(const vtkm::cont::DataSet& input,
|
|
const vtkm::cont::CoordinateSystem& field,
|
|
const vtkm::filter::PolicyBase<DerivedPolicy>& policy);
|
|
|
|
std::string OutputFieldName;
|
|
vtkm::filter::internal::RuntimeDeviceTracker Tracker;
|
|
};
|
|
|
|
}
|
|
} // namespace vtkm::filter
|
|
|
|
|
|
#include <vtkm/filter/FilterField.hxx>
|
|
|
|
#endif // vtk_m_filter_FieldFilter_h
|