FlowController Class Referenceabstract

The interface for classes controlling the flow of execution. More...

Inheritance diagram for FlowController:

Public Member Functions

virtual void pause ()=0
 Performs a pause if needed. More...
 
virtual bool stop ()=0
 The function to check if execution should be terminated as soon as possible. More...
 

Detailed Description

The interface for classes controlling the flow of execution.

This class is used to control the execution flow of subclasses of FlowControlled. See FlowControlled description for more information

Definition at line 36 of file flowcontrol.h.

Member Function Documentation

virtual void pause ( )
pure virtual

Performs a pause if needed.

This function should pause, sleep for a while or return immediately depending on how the execution flow should continue

Implemented in DummyFlowController.

virtual bool stop ( )
pure virtual

The function to check if execution should be terminated as soon as possible.

A note on implementation: if the pause() function could wait for an external event (e.g. the user pressing a button), to stop execution you should make this function return true AND make pause return (e.g. waking the wait condition on which pause() waits)

Returns
true if execution should be terminated as soon as possible

Implemented in DummyFlowController.


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