iRoCS Toolbox  1.1.0
Public Member Functions | Protected Attributes
atb::SparseMatrixError Class Reference

The SparseMatrixError class is the exception type thrown when SparseMatrix operations fail. More...

#include "libArrayToolbox/SparseMatrix.hh"

Inheritance diagram for atb::SparseMatrixError:
Collaboration diagram for atb::SparseMatrixError:

Public Member Functions

 SparseMatrixError (std::string const &message="")
 Create a new SparseMatrixError object with given error message. More...
 
 ~SparseMatrixError () throw ()
 Destructor. More...
 
template<typename DataT >
RuntimeErroroperator<< (DataT const &data)
 Appends the given data to the message string. More...
 
virtual const char * what () const throw ()
 Returns the error description. More...
 

Protected Attributes

std::string _message
 

Detailed Description

The SparseMatrixError class is the exception type thrown when SparseMatrix operations fail.

Definition at line 57 of file SparseMatrix.hh.

Constructor & Destructor Documentation

◆ SparseMatrixError()

atb::SparseMatrixError::SparseMatrixError ( std::string const &  message = "")
inline

Create a new SparseMatrixError object with given error message.

Parameters
messageThe error message to return to the caller

Definition at line 68 of file SparseMatrix.hh.

◆ ~SparseMatrixError()

atb::SparseMatrixError::~SparseMatrixError ( )
throw (
)
inline

Destructor.

Definition at line 77 of file SparseMatrix.hh.

Member Function Documentation

◆ operator<<()

template<typename DataT >
RuntimeError & atb::RuntimeError::operator<< ( DataT const &  data)
inherited

Appends the given data to the message string.

Parameters
data

Definition at line 112 of file RuntimeError.hh.

◆ what()

virtual const char* atb::RuntimeError::what ( ) const
throw (
)
virtualinherited

Returns the error description.

Returns
The error description string.

Field Documentation

◆ _message

std::string atb::RuntimeError::_message
protectedinherited

Definition at line 107 of file RuntimeError.hh.

Referenced by atb::RuntimeError::operator<<().


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