Create an error library to collect exceptions (927f93b7) · Commits · Giacomo Mulas / NP_TMcode

src/cluster/cluster.cpp

+4 −0

Original line number	Diff line number	Diff line
		@@ -8,6 +8,10 @@
		#include <fstream>
		#include <string>

		#ifndef INCLUDE_ERRORS_H_
		#include "../include/errors.h"
		#endif

		#ifndef INCLUDE_CONFIGURATION_H_
		#include "../include/Configuration.h"
		#endif

src/include/Configuration.h

+0 −46

Original line number	Diff line number	Diff line
		@@ -28,52 +28,6 @@
		#ifndef INCLUDE_CONFIGURATION_H_
		#define INCLUDE_CONFIGURATION_H_

		/**
		* \brief Exception for open file error handlers.
		*/
		class OpenConfigurationFileException: public std::exception {
		protected:
		//! \brief Name of the file that was accessed.
		std::string file_name;

		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param name: `string` Name of the file that was accessed.
		*/
		OpenConfigurationFileException(std::string name) { file_name = name; }

		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return file_name.c_str();
		}
		};

		/**
		* \brief Exception for unrecognized configuration data sets.
		*/
		class UnrecognizedConfigurationException: public std::exception {
		protected:
		//! Description of the problem.
		std::string message;
		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param problem: `string` Description of the problem that occurred.
		*/
		UnrecognizedConfigurationException(std::string problem) { message = problem; }
		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return message.c_str();
		}
		};

		/**
		* \brief A class to represent the configuration of the scattering geometry.
		*

src/include/List.h

+1 −32

Original line number	Diff line number	Diff line
		@@ -6,38 +6,7 @@
		#ifndef INCLUDE_LIST_H_
		#define INCLUDE_LIST_H_

		/**
		* \brief Exception for out of bounds List requests.
		*/
		class ListOutOfBoundsException: public std::exception {
		protected:
		//! Description of the problem.
		std::string message;

		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param requested: `int` The index that was requested.
		* \param min: `int` The minimum index allowed by the list.
		* \param max: `int` The maximum index allowed by the list.
		*/
		ListOutOfBoundsException(int requested, int min, int max) {
		message = "Error: requested index " + std::to_string(requested)
		+ " out of list allowed bounds [" + std::to_string(min) + ", "
		+ std::to_string(max - 1) + "]";
		}

		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return message.c_str();
		}
		};

		/**
		* \brief A class to represent dynamic lists.
		/*! \brief A class to represent dynamic lists.
		*
		* This class helps in the creation and management of dynamic lists of
		* objects, whose size is not known in advance. List offers the advantage

src/include/TransitionMatrix.h

+0 −22

Original line number	Diff line number	Diff line
		@@ -6,28 +6,6 @@
		#ifndef INCLUDE_TRANSITIONMATRIX_H_
		#define INCLUDE_TRANSITIONMATRIX_H_

		/**
		* \brief Exception for unrecognized file formats.
		*/
		class UnrecognizedFormatException: public std::exception {
		protected:
		//! Description of the problem.
		std::string message;
		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param problem: `string` Description of the problem that occurred.
		*/
		UnrecognizedFormatException(std::string problem) { message = problem; }
		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return message.c_str();
		}
		};

		/*! \brief Class to represent the Transition Matrix.
		*/
		class TransitionMatrix {

src/include/errors.h

0 → 100644

+161 −0

Original line number	Diff line number	Diff line
		/*! \file errors.h
		*
		* \brief Collection of proprietary code exceptions.
		*
		* There are many circumstances that can prevent the correct execution
		* of a code. These range from user mistakes, to improper configuration,
		* to unsupported hardware and all the way up to various system failures.
		* Although it is not possible to grant proper execution in all cases,
		* it is often possible to design a code in such a way that the program
		* detects unexpected conditions, informs the user and takes the proper
		* actions, eventually stopping without crash, if no other options are
		* available. C++ handles such unexpected circumstances by means of
		* `exceptions`. These are special procedures that can be launched
		* whenever an unexpected situation occurs and they allow to restore the
		* code work-flow and attempt recovery. Exceptions can be divided in
		* different cathegories, which respond to various types of problems.
		* This library contains a set of exceptions designed to the most common
		* problems that may occur while executing an application of the `NP_TMcode`
		* suite.
		*/

		#ifndef INCLUDE_ERRORS_H_
		#define INCLUDE_ERRORS_H_

		/*! \brief Exception for out of bounds List requests.
		*/
		class ListOutOfBoundsException: public std::exception {
		protected:
		//! Description of the problem.
		std::string message;

		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param requested: `int` The index that was requested.
		* \param min: `int` The minimum index allowed by the list.
		* \param max: `int` The maximum index allowed by the list.
		*/
		ListOutOfBoundsException(int requested, int min, int max) {
		message = "Error: requested index " + std::to_string(requested)
		+ " out of list allowed bounds [" + std::to_string(min) + ", "
		+ std::to_string(max - 1) + "]";
		}

		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return message.c_str();
		}
		};

		/*! \brief Exception for open file error handlers.
		*/
		class OpenConfigurationFileException: public std::exception {
		protected:
		//! \brief Name of the file that was accessed.
		std::string file_name;

		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param name: `string` Name of the file that was accessed.
		*/
		OpenConfigurationFileException(std::string name) { file_name = name; }

		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return file_name.c_str();
		}
		};

		/*! \brief Exception for access requests out of matrix bounds.
		*/
		class MatrixOutOfBoundsException: public std::exception {
		protected:
		//! Description of the problem.
		std::string message;
		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param problem: `string` Description of the problem that occurred.
		*/
		MatrixOutOfBoundsException(std::string problem) { message = problem; }
		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return message.c_str();
		}
		};

		/*! \brief Exception for unrecognized configuration data sets.
		*/
		class UnrecognizedConfigurationException: public std::exception {
		protected:
		//! Description of the problem.
		std::string message;
		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param problem: `string` Description of the problem that occurred.
		*/
		UnrecognizedConfigurationException(std::string problem) { message = problem; }
		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return message.c_str();
		}
		};

		/*! \brief Exception for unrecognized file formats.
		*/
		class UnrecognizedFormatException: public std::exception {
		protected:
		//! Description of the problem.
		std::string message;
		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param problem: `string` Description of the problem that occurred.
		*/
		UnrecognizedFormatException(std::string problem) { message = problem; }
		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return message.c_str();
		}
		};

		/*! \brief Exception for unrecognized parameters.
		*/
		class UnrecognizedParameterException: public std::exception {
		protected:
		//! Description of the problem.
		std::string message;
		public:
		/**
		* \brief Exception instance constructor.
		*
		* \param problem: `string` Description of the problem that occurred.
		*/
		UnrecognizedParameterException(std::string problem) { message = problem; }
		/**
		* \brief Exception message.
		*/
		virtual const char* what() const throw() {
		return message.c_str();
		}
		};

		#endif