The StateMachineInterface class defines a implementation independent interface to a PackML state machine. More...
#include <state_machine.h>
Public Member Functions | |
| virtual bool | abort () |
| virtual bool | activate ()=0 |
| virtual bool | clear () |
| virtual int | getCurrentState ()=0 |
| virtual bool | hold () |
| virtual bool | isActive ()=0 |
| virtual bool | reset () |
| virtual bool | setAborting (std::function< int()> state_method)=0 |
| virtual bool | setClearing (std::function< int()> state_method)=0 |
| virtual bool | setCompleting (std::function< int()> state_method)=0 |
| virtual bool | setExecute (std::function< int()> state_method)=0 |
| virtual bool | setHolding (std::function< int()> state_method)=0 |
| virtual bool | setResetting (std::function< int()> state_method)=0 |
| virtual bool | setStarting (std::function< int()> state_method)=0 |
| virtual bool | setStopping (std::function< int()> state_method)=0 |
| virtual bool | setSuspending (std::function< int()> state_method)=0 |
| virtual bool | setUnholding (std::function< int()> state_method)=0 |
| virtual bool | setUnsuspending (std::function< int()> state_method)=0 |
| virtual bool | start () |
| virtual bool | stop () |
| virtual bool | suspend () |
| virtual bool | unhold () |
| virtual bool | unsuspend () |
Protected Member Functions | |
| virtual void | _abort ()=0 |
| virtual void | _clear ()=0 |
| virtual void | _hold ()=0 |
| virtual void | _reset ()=0 |
| virtual void | _start ()=0 |
| virtual void | _stop ()=0 |
| virtual void | _suspend ()=0 |
| virtual void | _unhold ()=0 |
| virtual void | _unsuspend ()=0 |
Detailed Description
The StateMachineInterface class defines a implementation independent interface to a PackML state machine.
Definition at line 41 of file state_machine.h.
Member Function Documentation
| virtual void packml_sm::StateMachineInterface::_abort | ( | ) | [protected, pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual void packml_sm::StateMachineInterface::_clear | ( | ) | [protected, pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual void packml_sm::StateMachineInterface::_hold | ( | ) | [protected, pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual void packml_sm::StateMachineInterface::_reset | ( | ) | [protected, pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual void packml_sm::StateMachineInterface::_start | ( | ) | [protected, pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual void packml_sm::StateMachineInterface::_stop | ( | ) | [protected, pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual void packml_sm::StateMachineInterface::_suspend | ( | ) | [protected, pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual void packml_sm::StateMachineInterface::_unhold | ( | ) | [protected, pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual void packml_sm::StateMachineInterface::_unsuspend | ( | ) | [protected, pure virtual] |
Implemented in packml_sm::StateMachine.
| bool packml_sm::StateMachineInterface::abort | ( | ) | [virtual] |
Definition at line 138 of file src/state_machine.cpp.
| virtual bool packml_sm::StateMachineInterface::activate | ( | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| bool packml_sm::StateMachineInterface::clear | ( | ) | [virtual] |
Definition at line 39 of file src/state_machine.cpp.
| virtual int packml_sm::StateMachineInterface::getCurrentState | ( | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| bool packml_sm::StateMachineInterface::hold | ( | ) | [virtual] |
Definition at line 64 of file src/state_machine.cpp.
| virtual bool packml_sm::StateMachineInterface::isActive | ( | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| bool packml_sm::StateMachineInterface::reset | ( | ) | [virtual] |
Definition at line 51 of file src/state_machine.cpp.
| virtual bool packml_sm::StateMachineInterface::setAborting | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setClearing | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setCompleting | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setExecute | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setHolding | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setResetting | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setStarting | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setStopping | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setSuspending | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setUnholding | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| virtual bool packml_sm::StateMachineInterface::setUnsuspending | ( | std::function< int()> | state_method | ) | [pure virtual] |
Implemented in packml_sm::StateMachine.
| bool packml_sm::StateMachineInterface::start | ( | ) | [virtual] |
Definition at line 27 of file src/state_machine.cpp.
| bool packml_sm::StateMachineInterface::stop | ( | ) | [virtual] |
Definition at line 115 of file src/state_machine.cpp.
| bool packml_sm::StateMachineInterface::suspend | ( | ) | [virtual] |
Definition at line 90 of file src/state_machine.cpp.
| bool packml_sm::StateMachineInterface::unhold | ( | ) | [virtual] |
Definition at line 77 of file src/state_machine.cpp.
| bool packml_sm::StateMachineInterface::unsuspend | ( | ) | [virtual] |
Definition at line 102 of file src/state_machine.cpp.
The documentation for this class was generated from the following files: