Mantid::Kernel::Exception::IndexError Class Reference

Exception for index errors. More...

#include <Exception.h>

Inheritance diagram for Mantid::Kernel::Exception::IndexError:

Public Member Functions
	IndexError (const IndexError &A)
	Copy Constructor. More...
	IndexError (const size_t V, const size_t B, const std::string &Place)
	Constructor. More...
IndexError &	operator= (const IndexError &A)
const char *	what () const noexcept override
	Overloaded reporting method. More...

Private Attributes
std::string	m_message
	The message reported by what() More...
const size_t	maxVal
	Maximum value. More...
const size_t	Val
	Actual value called. More...

Detailed Description

Exception for index errors.

Called when an index falls out of range

Definition at line 284 of file Exception.h.

Constructor & Destructor Documentation

IndexError() [1/2]

TEMPLATE Mantid::Kernel::Exception::IndexError::IndexError	(	const size_t	V,
		const size_t	B,
		const std::string &	Place
	)

Constructor.

Parameters

V	:: Value of index
B	:: Maximum value
Place	:: Location of Error

Definition at line 254 of file Exception.cpp.

References m_message, maxVal, and Val.

IndexError() [2/2]

Mantid::Kernel::Exception::IndexError::IndexError

(

const IndexError &

A

)

Copy Constructor.

Parameters

A	:: IndexError to copy

Definition at line 265 of file Exception.cpp.

Member Function Documentation

operator=()

IndexError & Mantid::Kernel::Exception::IndexError::operator=

(

const IndexError &

A

)

what()

const char * Mantid::Kernel::Exception::IndexError::what ( ) const

overridenoexcept

Overloaded reporting method.

Writes out the range and limits.

Returns

the error string

Definition at line 271 of file Exception.cpp.

References m_message.

Member Data Documentation

m_message

std::string Mantid::Kernel::Exception::IndexError::m_message

private

The message reported by what()

Definition at line 288 of file Exception.h.

Referenced by IndexError(), and what().

maxVal

const size_t Mantid::Kernel::Exception::IndexError::maxVal

private

Maximum value.

Definition at line 287 of file Exception.h.

Referenced by IndexError().

Val

const size_t Mantid::Kernel::Exception::IndexError::Val

private

Actual value called.

Definition at line 286 of file Exception.h.

Referenced by IndexError().

---

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

• Framework/Kernel/inc/MantidKernel/Exception.h
• Framework/Kernel/src/Exception.cpp