MAiNGO
babBase::BranchAndBoundBaseException Class Reference

This class defines the exceptions thrown by BranchAndBoundBase. More...

#include <babException.h>

Inheritance diagram for babBase::BranchAndBoundBaseException:

Public Member Functions

 BranchAndBoundBaseException (const std::string &arg)
 Constructor used for forwarding. More...
 
 BranchAndBoundBaseException (const std::string &arg, const babBase::BabNode &node)
 Constructor used for forwarding. More...
 
 BranchAndBoundBaseException (const std::string &arg, const std::exception &e)
 Constructor used for forwarding. More...
 
 BranchAndBoundBaseException (const std::string &arg, const std::exception &e, const babBase::BabNode &node)
 Constructor used for forwarding. More...
 
 BranchAndBoundBaseException (const std::string &arg, const std::exception *e, const babBase::BabNode *node)
 Constructor used printing a BranchAndBoundBase Exception. More...
 
const char * what () const noexcept
 Function to return the error message. More...
 

Protected Member Functions

 BranchAndBoundBaseException ()
 

Protected Attributes

std::string _msg {""}
 

Detailed Description

This class defines the exceptions thrown by BranchAndBoundBase.

The class contains different constructors. The first parameter is always the error message. For debugging, the error message will also contain the file name and line number Additionally, the constructor can take an exception as second argument. If done so, the type of the exception object and its what() will be saved in the error message as well.

Constructor & Destructor Documentation

◆ BranchAndBoundBaseException() [1/6]

babBase::BranchAndBoundBaseException::BranchAndBoundBaseException ( )
protected

◆ BranchAndBoundBaseException() [2/6]

babBase::BranchAndBoundBaseException::BranchAndBoundBaseException ( const std::string &  arg)
inlineexplicit

Constructor used for forwarding.

Parameters
[in]argis a string holding an error message

◆ BranchAndBoundBaseException() [3/6]

babBase::BranchAndBoundBaseException::BranchAndBoundBaseException ( const std::string &  arg,
const babBase::BabNode node 
)
inline

Constructor used for forwarding.

Parameters
[in]argis a string holding an error message
[in]nodeholds the current BabNode

◆ BranchAndBoundBaseException() [4/6]

babBase::BranchAndBoundBaseException::BranchAndBoundBaseException ( const std::string &  arg,
const std::exception &  e 
)
inline

Constructor used for forwarding.

Parameters
[in]argis a string holding an error message
[in]eholds the exception

◆ BranchAndBoundBaseException() [5/6]

babBase::BranchAndBoundBaseException::BranchAndBoundBaseException ( const std::string &  arg,
const std::exception &  e,
const babBase::BabNode node 
)
inline

Constructor used for forwarding.

Parameters
[in]argis a string holding an error message
[in]eholds the exception
[in]nodeholds the current BabNode

◆ BranchAndBoundBaseException() [6/6]

babBase::BranchAndBoundBaseException::BranchAndBoundBaseException ( const std::string &  arg,
const std::exception *  e,
const babBase::BabNode node 
)
inline

Constructor used printing a BranchAndBoundBase Exception.

Parameters
[in]argis a string holding an error message
[in]eholds the exception
[in]nodeholds the current BabNode

Member Function Documentation

◆ what()

const char* babBase::BranchAndBoundBaseException::what ( ) const
inlinenoexcept

Function to return the error message.

Returns
Error message.

Member Data Documentation

◆ _msg

std::string babBase::BranchAndBoundBaseException::_msg {""}
protected

string holding the exception message


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