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

Objects of the RuntimeError class are thrown in case of errors while processing ArrayToolbox functions. More...

#include "libArrayToolbox/RuntimeError.hh"

Inheritance diagram for atb::RuntimeError:
Collaboration diagram for atb::RuntimeError:

Public Member Functions

 RuntimeError (char const *message=NULL)
 Constructor. More...
 
 RuntimeError (std::string const &message)
 Constructor. More...
 
virtual ~RuntimeError () 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

Objects of the RuntimeError class are thrown in case of errors while processing ArrayToolbox functions.

Definition at line 50 of file RuntimeError.hh.

Constructor & Destructor Documentation

◆ RuntimeError() [1/2]

atb::RuntimeError::RuntimeError ( char const *  message = NULL)

Constructor.

Creates a new RuntimeError object with specified error message string

Parameters
messageThe error message explaining what went wrong

◆ RuntimeError() [2/2]

atb::RuntimeError::RuntimeError ( std::string const &  message)

Constructor.

Creates a new RuntimeError object with specified error message string

Parameters
messageThe error message explaining what went wrong

◆ ~RuntimeError()

virtual atb::RuntimeError::~RuntimeError ( )
throw (
)
virtual

Destructor.

Member Function Documentation

◆ operator<<()

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

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 (
)
virtual

Returns the error description.

Returns
The error description string.

Field Documentation

◆ _message

std::string atb::RuntimeError::_message
protected

Definition at line 107 of file RuntimeError.hh.

Referenced by operator<<().


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