C++ YASMIN (Yet Another State MachINe)
Loading...
Searching...
No Matches
yasmin::StateMachineCancelException Class Reference

Exception thrown when a state machine is canceled as a whole. More...

#include <state_machine_cancel_exception.hpp>

Inheritance diagram for yasmin::StateMachineCancelException:
Collaboration diagram for yasmin::StateMachineCancelException:

Public Member Functions

 StateMachineCancelException (const std::string &state_machine_name)
 Construct a new cancellation exception.

Detailed Description

Exception thrown when a state machine is canceled as a whole.

This exception is used internally to abort the current execution loop after cancel_state_machine() has been requested. It can also be observed by callers that execute the state machine directly.

Constructor & Destructor Documentation

◆ StateMachineCancelException()

yasmin::StateMachineCancelException::StateMachineCancelException ( const std::string & state_machine_name)
inlineexplicit

Construct a new cancellation exception.

Parameters
state_machine_nameHuman-readable state machine name.

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