Interior-point-optimisation  1.0-1
Interior-pointoptimisationlibrary
ipo::IPOException Class Reference

Objects of this class are used to store information about an exception generated by ipo objects and functions at runtime. More...

#include <IPOException.hpp>

Collaboration diagram for ipo::IPOException:
Collaboration graph

Public Member Functions

 IPOException (const std::string &exceptionMessage, char const *const fileName=0, int const lineNumber=0)
 Create a new object with the given message to indicate what happened. More...
 
const std::string & what () const
 Returns the exception’s message. More...
 

Private Attributes

const std::string message
 A string to hold the exception’s message. More...
 

Detailed Description

Objects of this class are used to store information about an exception generated by ipo objects and functions at runtime.

Definition at line 60 of file IPOException.hpp.

Constructor & Destructor Documentation

ipo::IPOException::IPOException ( const std::string &  exceptionMessage,
char const *const  fileName = 0,
int const  lineNumber = 0 
)
inline

Create a new object with the given message to indicate what happened.

Parameters
exceptionMessageThe string containing the message.
fileNameUse with macro to produce error message
lineNumberUse with macro to produce error message

Definition at line 68 of file IPOException.hpp.

Member Function Documentation

const std::string& ipo::IPOException::what ( ) const
inline

Returns the exception’s message.

Returns
The exception’s message.

Definition at line 79 of file IPOException.hpp.

References message.

Member Data Documentation

const std::string ipo::IPOException::message
private

A string to hold the exception’s message.

Definition at line 86 of file IPOException.hpp.

Referenced by what().


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