InterruptException Class Reference

Exception thrown when interruption occurs, e.g. user press ESC key. More...

#include <baseexception.h>

Inheritance diagram for InterruptException:

Public Member Functions
BASE_EXPORT	InterruptException (bool safe, const IString &state=IString())
BASE_EXPORT bool	wasSafe () const
	returns TRUE if the interrupt was "Safe", in that the model was left in a repeatable and valid state.
BASE_EXPORT IString	state () const
Public Member Functions inherited from Exception
template<typename FirstArg , typename... Args>
	Exception (const IString &s, const FirstArg &fa, Args &&... args)
	Exception (const IString &s)
	Exception (IString &&s)
	Exception (const Exception &e)
	Exception (Exception &&e)
Exception &	operator= (const Exception &e)
Exception &	operator= (Exception &&e)
BASE_EXPORT const char *	what () const override throw ()
	Returns the contents of the error message as a const char.
void	setMessage (const IString &s)
	Allows the message carried by the exception to be replaced with a new one.

Detailed Description

Exception thrown when interruption occurs, e.g. user press ESC key.

Constructor & Destructor Documentation

InterruptException()

BASE_EXPORT InterruptException::InterruptException ( bool safe, const IString & state = IString() )

inline

Constructor

Parameters

safe	indicates that is safe to interrupt
state	see function state()

Member Function Documentation

state()

BASE_EXPORT IString InterruptException::state ( ) const

inline

Only needed for a safe interrupt. A state string to be used to indicate that the conditions required to duplicate the interupt have been met. A case-sensitive match between this string (Stored in the record) and a string representing the current state indicates that an interrupt should be simulated.

---

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

• C:/Source/itasca-suite/common/base/src/baseexception.h