Interface for handling loop completion events.
More...
#include <loopCompletionHandler.hpp>
Interface for handling loop completion events.
This interface is passed to application-level loop actions and allows them to signal completion without direct access to framework-internal events.
Usage:
◆ ~LoopCompletionHandler()
| virtual ifw::slm::LoopCompletionHandler::~LoopCompletionHandler |
( |
| ) |
|
|
virtualdefault |
◆ LoopCompletionHandler() [1/2]
| ifw::slm::LoopCompletionHandler::LoopCompletionHandler |
( |
| ) |
|
|
protecteddefault |
Protected constructor for interface.
Allows derived classes to construct while preventing direct instantiation.
◆ LoopCompletionHandler() [2/2]
◆ operator=()
◆ SignalError()
| virtual void ifw::slm::LoopCompletionHandler::SignalError |
( |
int | loop_index, |
|
|
const std::string & | error_message = "" ) |
|
pure virtual |
Signal loop cycle error.
Called by application when a loop cycle encounters an error. Framework will post the appropriate GenCmd<X>_Err event.
- Parameters
-
| loop_index | The loop index (1-9) |
| error_message | Optional error message |
Implemented in ifw::slm::LoopCompletionHandlerImpl.
◆ SignalSuccess()
| virtual void ifw::slm::LoopCompletionHandler::SignalSuccess |
( |
int | loop_index | ) |
|
|
pure virtual |
Signal successful loop cycle completion.
Called by application when a loop cycle completes successfully. Framework will post the appropriate GenCmd<X>_Ok or L<X>CycleDone event.
- Parameters
-
| loop_index | The loop index (1-9) |
Implemented in ifw::slm::LoopCompletionHandlerImpl.
The documentation for this class was generated from the following file: