vtkm::exec::FunctorBase Class Reference

Base class for all user worklets invoked in the execution environment from a call to vtkm::cont::DeviceAdapterAlgorithm::Schedule. More...

#include <FunctorBase.h>

Inheritance diagram for vtkm::exec::FunctorBase:

Public Member Functions
VTKM_EXEC_CONT	FunctorBase ()
VTKM_EXEC void	RaiseError (const char *message) const
VTKM_CONT void	SetErrorMessageBuffer (const vtkm::exec::internal::ErrorMessageBuffer &buffer)
	Set the error message buffer so that running algorithms can report errors. More...

Private Attributes
vtkm::exec::internal::ErrorMessageBuffer	ErrorMessage

Detailed Description

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.

Constructor & Destructor Documentation

FunctorBase()

VTKM_EXEC_CONT vtkm::exec::FunctorBase::FunctorBase ( )

inline

Member Function Documentation

RaiseError()

VTKM_EXEC void vtkm::exec::FunctorBase::RaiseError ( const char *  message ) const

inline

SetErrorMessageBuffer()

VTKM_CONT void vtkm::exec::FunctorBase::SetErrorMessageBuffer ( const vtkm::exec::internal::ErrorMessageBuffer &  buffer )

inline

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.

Member Data Documentation

ErrorMessage

vtkm::exec::internal::ErrorMessageBuffer vtkm::exec::FunctorBase::ErrorMessage

private

---

The documentation for this class was generated from the following file:

• FunctorBase.h