Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Private Member Functions | List of all members
utility::graph::EXCN_Stop_BFS Class Reference

Class to raise to do an immediate stop of a breadth first search. ONLY THROW FROM WITHIN A VISITOR PASSED TO breadth_first_visit_prune/breadth_first_search_prune. More...

#include <BFS_prune.hh>

Inheritance diagram for utility::graph::EXCN_Stop_BFS:
Inheritance graph
[legend]

Private Member Functions

void crash_log () const override
 Invoke a crash log for throwing this exception. If your exception is one which is a "non-error" exception, override this function to do nothing. More...
 

Additional Inherited Members

- Public Member Functions inherited from utility::excn::Exception
 Exception ()=delete
 
 Exception (char const *file, int line, std::string const &msg)
 
 ~Exception () override
 
virtual void display () const
 Present this exception to the user. Will invoke crash log reporting, if applicable. More...
 
void show (std::ostream &) const
 
std::string msg () const
 Will return a formatted message (with file/line information) More...
 
std::string raw_msg () const
 Will return the raw message (without file/line information) More...
 
void msg (std::string const &m)
 Will set the raw message. More...
 
void add_msg (std::string const &str)
 
void prepend_to_msg (std::string const &str)
 
std::string const & file ()
 
int line ()
 
std::string const & traceback ()
 

Detailed Description

Class to raise to do an immediate stop of a breadth first search. ONLY THROW FROM WITHIN A VISITOR PASSED TO breadth_first_visit_prune/breadth_first_search_prune.

Member Function Documentation

void utility::graph::EXCN_Stop_BFS::crash_log ( ) const
inlineoverrideprivatevirtual

Invoke a crash log for throwing this exception. If your exception is one which is a "non-error" exception, override this function to do nothing.

Reimplemented from utility::excn::Exception.


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