Public Member Functions | Protected Attributes | List of all members
Seldon::Error Class Reference
Inheritance diagram for Seldon::Error:
Seldon::IOError Seldon::LapackError Seldon::NoMemory Seldon::SolverDivergenceError Seldon::SolverMaximumIterationError Seldon::Undefined Seldon::WrongArgument Seldon::WrongCol Seldon::WrongDim Seldon::WrongIndex Seldon::WrongRow

Public Member Functions

 Error (string function="", string comment="")
 Main constructor. More...
 
 Error (string description, string function, string comment)
 Alternative constructor. More...
 
virtual ~Error ()
 Destructor. More...
 
virtual string What ()
 Delivers information about the error. More...
 
void CoutWhat ()
 Delivers information about the error. More...
 

Protected Attributes

string description_
 Message describing the exception type.
 
string function_
 Name of the function in which the error occurred.
 
string comment_
 A comment about the error.
 

Detailed Description

Definition at line 38 of file Errors.hxx.

Constructor & Destructor Documentation

◆ Error() [1/2]

Seldon::Error::Error ( string  function = "",
string  comment = "" 
)

Main constructor.

Error associated with both a function and a comment.

Parameters
functionfunction with which the error is associated.
commentcomment associated with the error.

Definition at line 43 of file Errors.cxx.

◆ Error() [2/2]

Seldon::Error::Error ( string  description,
string  function,
string  comment 
)

Alternative constructor.

Error associated with a description, a function and a comment.

Parameters
descriptionshort description of the error.
functionfunction with which the error is associated.
commentcomment associated with the error.

Definition at line 60 of file Errors.cxx.

◆ ~Error()

Seldon::Error::~Error ( )
virtual

Destructor.

Note
Empty.

Definition at line 76 of file Errors.cxx.

Member Function Documentation

◆ CoutWhat()

void Seldon::Error::CoutWhat ( )

Delivers information about the error.

Displays available information, i.e. the error description, the function and/or a comment.

Definition at line 106 of file Errors.cxx.

◆ What()

string Seldon::Error::What ( )
virtual

Delivers information about the error.

Displays available information, i.e. the error description, the function and/or a comment.

Reimplemented in Seldon::LapackError, Seldon::WrongArgument, and Seldon::Undefined.

Definition at line 90 of file Errors.cxx.


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