Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

ogdf::LibraryNotSupportedException Class Reference

Exception thrown when an external library shall be used which is not supported. More...

#include <ogdf/basic/exceptions.h>

+ Inheritance diagram for ogdf::LibraryNotSupportedException:

Public Member Functions

 LibraryNotSupportedException (const char *file=nullptr, int line=-1)
 Constructs a library not supported exception. More...
 
 LibraryNotSupportedException (LibraryNotSupportedCode code, const char *file=nullptr, int line=-1)
 Constructs a library not supported exception. More...
 
LibraryNotSupportedCode 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...
 
const char * what () const noexcept override
 

Private Attributes

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

Detailed Description

Exception thrown when an external library shall be used which is not supported.

Definition at line 273 of file exceptions.h.

Constructor & Destructor Documentation

◆ LibraryNotSupportedException() [1/2]

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

Constructs a library not supported exception.

Definition at line 276 of file exceptions.h.

◆ LibraryNotSupportedException() [2/2]

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

Constructs a library not supported exception.

Definition at line 281 of file exceptions.h.

Member Function Documentation

◆ exceptionCode()

LibraryNotSupportedCode ogdf::LibraryNotSupportedException::exceptionCode ( ) const
inline

Returns the error code of the exception.

Definition at line 285 of file exceptions.h.

Member Data Documentation

◆ m_exceptionCode

LibraryNotSupportedCode ogdf::LibraryNotSupportedException::m_exceptionCode
private

The error code specifying the exception.

Definition at line 288 of file exceptions.h.


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