ifw-slm 0.1.2
 
Loading...
Searching...
No Matches
ifw::slm::LoopCompletionHandler Class Referenceabstract

Interface for handling loop completion events. More...

#include <loopCompletionHandler.hpp>

Inheritance diagram for ifw::slm::LoopCompletionHandler:
ifw::slm::LoopCompletionHandlerImpl

Public Member Functions

virtual ~LoopCompletionHandler ()=default
 
virtual void SignalSuccess (int loop_index)=0
 Signal successful loop cycle completion.
 
virtual void SignalError (int loop_index, const std::string &error_message="")=0
 Signal loop cycle error.
 
 LoopCompletionHandler (const LoopCompletionHandler &)=delete
 
LoopCompletionHandleroperator= (const LoopCompletionHandler &)=delete
 

Protected Member Functions

 LoopCompletionHandler ()=default
 Protected constructor for interface.
 

Detailed Description

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:

Constructor & Destructor Documentation

◆ ~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]

ifw::slm::LoopCompletionHandler::LoopCompletionHandler ( const LoopCompletionHandler & )
delete

Member Function Documentation

◆ operator=()

LoopCompletionHandler & ifw::slm::LoopCompletionHandler::operator= ( const LoopCompletionHandler & )
delete

◆ 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_indexThe loop index (1-9)
error_messageOptional 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_indexThe loop index (1-9)

Implemented in ifw::slm::LoopCompletionHandlerImpl.


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