VTK-m  1.8
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
vtkm::cont::Error Class Reference

The superclass of all exceptions thrown by any VTKm function or method. More...

#include <Error.h>

Inheritance diagram for vtkm::cont::Error:
vtkm::cont::cuda::ErrorCuda vtkm::cont::ErrorBadAllocation vtkm::cont::ErrorBadDevice vtkm::cont::ErrorBadType vtkm::cont::ErrorBadValue vtkm::cont::ErrorExecution vtkm::cont::ErrorFilterExecution vtkm::cont::ErrorInternal vtkm::io::ErrorIO

Public Member Functions

const std::string & GetMessage () const
 
const std::string & GetStackTrace () const
 
const char * what () const noexcept override
 
bool GetIsDeviceIndependent () const
 Returns true if this exception is device independent. More...
 

Protected Member Functions

 Error ()
 
 Error (const std::string &message, bool is_device_independent=false)
 
void SetMessage (const std::string &message)
 

Private Attributes

std::string Message
 
std::string StackTrace
 
std::string What
 
bool IsDeviceIndependent
 

Detailed Description

The superclass of all exceptions thrown by any VTKm function or method.

Constructor & Destructor Documentation

◆ Error() [1/2]

vtkm::cont::Error::Error ( )
inlineprotected

◆ Error() [2/2]

vtkm::cont::Error::Error ( const std::string &  message,
bool  is_device_independent = false 
)
inlineprotected

Member Function Documentation

◆ GetIsDeviceIndependent()

bool vtkm::cont::Error::GetIsDeviceIndependent ( ) const
inline

Returns true if this exception is device independent.

For exceptions that are not device independent, vtkm::TryExecute, for example, may try executing the code on other available devices.

◆ GetMessage()

const std::string& vtkm::cont::Error::GetMessage ( ) const
inline

◆ GetStackTrace()

const std::string& vtkm::cont::Error::GetStackTrace ( ) const
inline

◆ SetMessage()

void vtkm::cont::Error::SetMessage ( const std::string &  message)
inlineprotected

◆ what()

const char* vtkm::cont::Error::what ( ) const
inlineoverridenoexcept

Member Data Documentation

◆ IsDeviceIndependent

bool vtkm::cont::Error::IsDeviceIndependent
private

◆ Message

std::string vtkm::cont::Error::Message
private

◆ StackTrace

std::string vtkm::cont::Error::StackTrace
private

◆ What

std::string vtkm::cont::Error::What
private

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