Clp 1.17.6

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Static Public Attributes | Private Member Functions | Friends | List of all members
CoinError Class Reference

Error Class thrown by an exception. More...

`#include <CoinError.hpp>`

Collaboration diagram for CoinError:
[legend]

## Public Member Functions
Get error attributes
const std::string & | message () const
| get message text More...
const std::string & | methodName () const
| get name of method instantiating error More...
const std::string & | className () const
| get name of class instantiating error (or hint for assert) More...
const std::string & | fileName () const
| get name of file for assert More...
int | lineNumber () const
| get line number of assert (-1 if not assert) More...
void | print (bool doPrint=true) const
| Just print (for asserts) More...
Constructors and destructors
| CoinError (std::string message__, std::string methodName__, std::string className__, std::string fileName_=std::string(), int line=-1)
| Alternate Constructor. More...
| CoinError (const CoinError &source)
| Copy constructor. More...
CoinError & | operator= (const CoinError &rhs)
| Assignment operator. More...
virtual | ~CoinError ()
| Destructor. More...

## Static Public Attributes
static bool | printErrors_
| Whether to print every error. More...

## Private Member Functions
| CoinError ()

## Private Attributes
Private member data
std::string | message_
| message test More...
std::string | method_
| method name More...
std::string | class_
| class name or hint More...
std::string | file_
| file name More...
int | lineNumber_
| Line number. More...

## Friends
void | CoinErrorUnitTest ()
| A function that tests the methods in the CoinError class. More...

## Detailed Description

Error Class thrown by an exception.

This class is used when exceptions are thrown. It contains:

- message text
- name of method throwing exception
- name of class throwing exception or hint
- name of file if assert
- line number

For asserts class=> optional hint

Definition at line 42 of file CoinError.hpp.

## Constructor & Destructor Documentation

CoinError::CoinError | ( |  | ) |
| inline private

Definition at line 46 of file CoinError.hpp.

CoinError::CoinError | ( | std::string | message__,
|  | std::string | methodName__,
|  | std::string | className__,
|  | std::string | fileName_ = `std::string()`,
|  | int | line = `-1`
| ) |  |
| inline

Alternate Constructor.

Definition at line 106 of file CoinError.hpp.

CoinError::CoinError | ( | const CoinError & | source | ) |
| inline

Copy constructor.

Definition at line 122 of file CoinError.hpp.

virtual CoinError::~CoinError | ( |  | ) |
| inline virtual

Destructor.

Definition at line 146 of file CoinError.hpp.

## Member Function Documentation

const std::string& CoinError::message | ( |  | ) | const
| inline

get message text

Definition at line 63 of file CoinError.hpp.

const std::string& CoinError::methodName | ( |  | ) | const
| inline

get name of method instantiating error

Definition at line 68 of file CoinError.hpp.

const std::string& CoinError::className | ( |  | ) | const
| inline

get name of class instantiating error (or hint for assert)

Definition at line 73 of file CoinError.hpp.

const std::string& CoinError::fileName | ( |  | ) | const
| inline

get name of file for assert

Definition at line 78 of file CoinError.hpp.

int CoinError::lineNumber | ( |  | ) | const
| inline

get line number of assert (-1 if not assert)

Definition at line 83 of file CoinError.hpp.

void CoinError::print | ( | bool | doPrint = `true` | ) | const
| inline

Just print (for asserts)

Definition at line 88 of file CoinError.hpp.

CoinError& CoinError::operator= | ( | const CoinError & | rhs | ) |
| inline

Assignment operator.

Definition at line 133 of file CoinError.hpp.

## Friends And Related Function Documentation

void CoinErrorUnitTest | ( |  | ) |
| friend

A function that tests the methods in the CoinError class.

The only reason for it not to be a member method is that this way it doesn't have to be compiled into the library. And that's a gain, because the library should be compiled with optimization on, but this method should be compiled with debugging.

## Member Data Documentation

std::string CoinError::message_
| private

message test

Definition at line 156 of file CoinError.hpp.

std::string CoinError::method_
| private

method name

Definition at line 158 of file CoinError.hpp.

std::string CoinError::class_
| private

class name or hint

Definition at line 160 of file CoinError.hpp.

std::string CoinError::file_
| private

file name

Definition at line 162 of file CoinError.hpp.

int CoinError::lineNumber_
| private

Line number.

Definition at line 164 of file CoinError.hpp.

bool CoinError::printErrors_
| static

Whether to print every error.

Definition at line 169 of file CoinError.hpp.

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

- /tmp/Clp-1.17.6/CoinUtils/src/CoinError.hpp