BlamException Class Reference

Class representing a custom Blamite exception. More...

#include <exception.h>

Inheritance diagram for BlamException:

Public Member Functions
	BlamException (BlamExceptionType _type, std::string _message)
	Constructs a new Blamite exception. More...
	BlamException (std::string _message)
	Constructs a new Blamite exception. More...
BlamExceptionType	GetType ()
	Retrieves the type of the exception. More...
std::string	GetExceptionMessage ()
	Retrieves the message describing the exception. More...

Detailed Description

Class representing a custom Blamite exception.

While there likely won't be many cases where we want or need to use a custom exception, any custom exceptions that do get introduced should implement this as a base class.

Constructor & Destructor Documentation

BlamException() [1/2]

BlamException::BlamException	(	BlamExceptionType	_type,
		std::string	_message
	)

Constructs a new Blamite exception.

Parameters

_type	- The type of the exception.
_message	- A message describing the exception. Should include as much information as possible for debugging purposes.

BlamException() [2/2]

BlamException::BlamException

(

std::string

_message

)

Constructs a new Blamite exception.

Parameters

_message

- A message describing the exception. Should include as much information as possible for debugging purposes.

Member Function Documentation

GetExceptionMessage()

std::string BlamException::GetExceptionMessage

(

)

Retrieves the message describing the exception.

Returns

The message describing the exception.

GetType()

BlamExceptionType BlamException::GetType

(

)

Retrieves the type of the exception.

Returns

The type of the exception.

---

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

• blam/components/diagnostics/errors/exception.h
• blam/components/diagnostics/errors/exceptions/BlamException.cpp