022c36fa4f
Previously WorkletInvokeFunctor inherited from vtkm::exec::FunctorBase, which is also the base class for all users Worklets and for all functors based to DeviceAdapter::Schedule. This is done for a few reasons. The first is that we reduce the minimum size of user worklets. Previously the users worklet would hold a reference to the error message, and so would the wrapper class added when calling DeviceAdapter::Schedule. Now we only have the users worklet holding a reference. Second, by refactoring to have two base classes we can better improve the documentation on what responsibilities FunctorBase.h has, compared to TaskBase.
70 lines
2.0 KiB
C++
70 lines
2.0 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_exec_FunctorBase_h
|
|
#define vtk_m_exec_FunctorBase_h
|
|
|
|
#include <vtkm/Types.h>
|
|
|
|
#include <vtkm/exec/internal/ErrorMessageBuffer.h>
|
|
|
|
#include <vtkm/cont/vtkm_cont_export.h>
|
|
|
|
|
|
namespace vtkm {
|
|
namespace exec {
|
|
|
|
|
|
/// Base class for all user worklets invoked in the execution environment from a
|
|
/// call to vtkm::cont::DeviceAdapterAlgorithm::Schedule.
|
|
///
|
|
/// This class contains a public method named RaiseError that can be called in
|
|
/// the execution environment to signal a problem.
|
|
///
|
|
class FunctorBase
|
|
{
|
|
public:
|
|
VTKM_EXEC_CONT
|
|
FunctorBase(): ErrorMessage() { }
|
|
|
|
VTKM_EXEC
|
|
void RaiseError(const char *message) const
|
|
{
|
|
this->ErrorMessage.RaiseError(message);
|
|
}
|
|
|
|
/// Set the error message buffer so that running algorithms can report
|
|
/// errors. This is supposed to be set by the dispatcher. This method may be
|
|
/// replaced as the execution semantics change.
|
|
///
|
|
VTKM_CONT
|
|
void SetErrorMessageBuffer(
|
|
const vtkm::exec::internal::ErrorMessageBuffer &buffer)
|
|
{
|
|
this->ErrorMessage = buffer;
|
|
}
|
|
private:
|
|
vtkm::exec::internal::ErrorMessageBuffer ErrorMessage;
|
|
};
|
|
|
|
}
|
|
} // namespace vtkm::exec
|
|
|
|
#endif //vtk_m_exec_FunctorBase_h
|