Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::AlgorithmFailureException Class Reference

Exception thrown when an algorithm realizes an internal bug that prevents it from continuing. More...

#include <ogdf/basic/exceptions.h>

+ Inheritance diagram for ogdf::AlgorithmFailureException:

Public Member Functions

 AlgorithmFailureException (AlgorithmFailureCode code, const char *file=nullptr, int line=-1)
 Constructs an algorithm failure exception. More...
 
 AlgorithmFailureException (const char *file=nullptr, int line=-1)
 Constructs an algorithm failure exception. More...
 
AlgorithmFailureCode exceptionCode () const
 Returns the error code of the exception. More...
 
- Public Member Functions inherited from ogdf::Exception
 Exception (const char *file=nullptr, int line=-1)
 Constructs an exception. More...
 
const char * file () const
 Returns the name of the source file where exception was thrown. More...
 
int line () const
 Returns the line number where the exception was thrown. More...
 

Private Attributes

AlgorithmFailureCode m_exceptionCode
 The error code specifying the exception. More...
 

Detailed Description

Exception thrown when an algorithm realizes an internal bug that prevents it from continuing.

Definition at line 253 of file exceptions.h.

Constructor & Destructor Documentation

◆ AlgorithmFailureException() [1/2]

ogdf::AlgorithmFailureException::AlgorithmFailureException ( AlgorithmFailureCode  code,
const char *  file = nullptr,
int  line = -1 
)
inlineexplicit

Constructs an algorithm failure exception.

Definition at line 258 of file exceptions.h.

◆ AlgorithmFailureException() [2/2]

ogdf::AlgorithmFailureException::AlgorithmFailureException ( const char *  file = nullptr,
int  line = -1 
)
inlineexplicit

Constructs an algorithm failure exception.

Definition at line 266 of file exceptions.h.

Member Function Documentation

◆ exceptionCode()

AlgorithmFailureCode ogdf::AlgorithmFailureException::exceptionCode ( ) const
inline

Returns the error code of the exception.

Definition at line 274 of file exceptions.h.

Member Data Documentation

◆ m_exceptionCode

AlgorithmFailureCode ogdf::AlgorithmFailureException::m_exceptionCode
private

The error code specifying the exception.

Definition at line 277 of file exceptions.h.


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