API Reference

Class Hierarchy

• • Namespace hsmcpp
    • Class HierarchicalStateMachine
    • Class HsmEventDispatcherArduino
    • Class HsmEventDispatcherBase
    • Class HsmEventDispatcherFreeRTOS
    • Class HsmEventDispatcherGLib
    • Class HsmEventDispatcherGLibmm
    • Class HsmEventDispatcherQt
    • Class HsmEventDispatcherSTD
    • Class IHsmEventDispatcher
    • Class Variant
    • Enum HistoryType
    • Enum StateAction
    • Enum StateActionTrigger
    • Enum TransitionType

File Hierarchy

• • Directory include
    • Directory hsmcpp
      • File hsm.hpp
      • File HsmEventDispatcherArduino.hpp
      • File HsmEventDispatcherBase.hpp
      • File HsmEventDispatcherFreeRTOS.hpp
      • File HsmEventDispatcherGLib.hpp
      • File HsmEventDispatcherGLibmm.hpp
      • File HsmEventDispatcherQt.hpp
      • File HsmEventDispatcherSTD.hpp
      • File HsmTypes.hpp
      • File IHsmEventDispatcher.hpp
      • File variant.hpp

API List

Namespaces

• Namespace hsmcpp
  • Classes
  • Enums
  • Typedefs
  • Variables

Classes and Structs

• Class HierarchicalStateMachine
  • Class Documentation
    • HierarchicalStateMachine
      • HierarchicalStateMachine::HierarchicalStateMachine()
      • HierarchicalStateMachine::~HierarchicalStateMachine()
      • HierarchicalStateMachine::setInitialState()
      • HierarchicalStateMachine::initialize()
      • HierarchicalStateMachine::dispatcher()
      • HierarchicalStateMachine::isInitialized()
      • HierarchicalStateMachine::release()
      • HierarchicalStateMachine::registerFailedTransitionCallback()
      • HierarchicalStateMachine::registerFailedTransitionCallback()
      • HierarchicalStateMachine::registerState()
      • HierarchicalStateMachine::registerState()
      • HierarchicalStateMachine::registerFinalState()
      • HierarchicalStateMachine::registerFinalState()
      • HierarchicalStateMachine::registerHistory()
      • HierarchicalStateMachine::registerHistory()
      • HierarchicalStateMachine::registerSubstate()
      • HierarchicalStateMachine::registerSubstateEntryPoint()
      • HierarchicalStateMachine::registerSubstateEntryPoint()
      • HierarchicalStateMachine::registerTimer()
      • HierarchicalStateMachine::registerStateAction()
      • HierarchicalStateMachine::registerTransition()
      • HierarchicalStateMachine::registerTransition()
      • HierarchicalStateMachine::registerSelfTransition()
      • HierarchicalStateMachine::registerSelfTransition()
      • HierarchicalStateMachine::getLastActiveState()
      • HierarchicalStateMachine::getActiveStates()
      • HierarchicalStateMachine::isStateActive()
      • HierarchicalStateMachine::transition()
      • HierarchicalStateMachine::transitionEx()
      • HierarchicalStateMachine::transitionWithArgsArray()
      • HierarchicalStateMachine::transitionExWithArgsArray()
      • HierarchicalStateMachine::transitionSync()
      • HierarchicalStateMachine::transitionWithQueueClear()
      • HierarchicalStateMachine::transitionInterruptSafe()
      • HierarchicalStateMachine::isTransitionPossible()
      • HierarchicalStateMachine::startTimer()
      • HierarchicalStateMachine::restartTimer()
      • HierarchicalStateMachine::stopTimer()
      • HierarchicalStateMachine::isTimerRunning()
      • HierarchicalStateMachine::enableHsmDebugging()
      • HierarchicalStateMachine::enableHsmDebugging()
      • HierarchicalStateMachine::disableHsmDebugging()

• Class HsmEventDispatcherArduino
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • HsmEventDispatcherArduino
      • HsmEventDispatcherArduino::start()
      • HsmEventDispatcherArduino::emitEvent()
      • HsmEventDispatcherArduino::dispatchEvents()
      • HsmEventDispatcherArduino::create()

• Class HsmEventDispatcherBase
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • HsmEventDispatcherBase
      • HsmEventDispatcherBase::stop()
      • HsmEventDispatcherBase::registerEventHandler()
      • HsmEventDispatcherBase::unregisterEventHandler()
      • HsmEventDispatcherBase::emitEvent()
      • HsmEventDispatcherBase::enqueueEvent()
      • HsmEventDispatcherBase::enqueueAction()
      • HsmEventDispatcherBase::registerEnqueuedEventHandler()
      • HsmEventDispatcherBase::unregisterEnqueuedEventHandler()
      • HsmEventDispatcherBase::registerTimerHandler()
      • HsmEventDispatcherBase::unregisterTimerHandler()
      • HsmEventDispatcherBase::startTimer()
      • HsmEventDispatcherBase::restartTimer()
      • HsmEventDispatcherBase::stopTimer()
      • HsmEventDispatcherBase::isTimerRunning()

• Class HsmEventDispatcherFreeRTOS
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • HsmEventDispatcherFreeRTOS
      • HsmEventDispatcherFreeRTOS::emitEvent()
      • HsmEventDispatcherFreeRTOS::start()
      • HsmEventDispatcherFreeRTOS::stop()
      • HsmEventDispatcherFreeRTOS::join()
      • HsmEventDispatcherFreeRTOS::create()

• Class HsmEventDispatcherGLib
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • HsmEventDispatcherGLib
      • HsmEventDispatcherGLib::start()
      • HsmEventDispatcherGLib::stop()
      • HsmEventDispatcherGLib::emitEvent()
      • HsmEventDispatcherGLib::create()
      • HsmEventDispatcherGLib::create()

• Class HsmEventDispatcherGLibmm
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • HsmEventDispatcherGLibmm
      • HsmEventDispatcherGLibmm::start()
      • HsmEventDispatcherGLibmm::stop()
      • HsmEventDispatcherGLibmm::emitEvent()
      • HsmEventDispatcherGLibmm::create()
      • HsmEventDispatcherGLibmm::create()

• Class HsmEventDispatcherQt
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • HsmEventDispatcherQt
      • HsmEventDispatcherQt::start()
      • HsmEventDispatcherQt::stop()
      • HsmEventDispatcherQt::emitEvent()
      • HsmEventDispatcherQt::create()

• Class HsmEventDispatcherSTD
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • HsmEventDispatcherSTD
      • HsmEventDispatcherSTD::emitEvent()
      • HsmEventDispatcherSTD::start()
      • HsmEventDispatcherSTD::stop()
      • HsmEventDispatcherSTD::join()
      • HsmEventDispatcherSTD::create()

• Class IHsmEventDispatcher
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • IHsmEventDispatcher
      • IHsmEventDispatcher::~IHsmEventDispatcher()
      • IHsmEventDispatcher::start()
      • IHsmEventDispatcher::stop()
      • IHsmEventDispatcher::registerEventHandler()
      • IHsmEventDispatcher::unregisterEventHandler()
      • IHsmEventDispatcher::registerEnqueuedEventHandler()
      • IHsmEventDispatcher::unregisterEnqueuedEventHandler()
      • IHsmEventDispatcher::emitEvent()
      • IHsmEventDispatcher::enqueueEvent()
      • IHsmEventDispatcher::enqueueAction()
      • IHsmEventDispatcher::registerTimerHandler()
      • IHsmEventDispatcher::unregisterTimerHandler()
      • IHsmEventDispatcher::startTimer()
      • IHsmEventDispatcher::restartTimer()
      • IHsmEventDispatcher::stopTimer()
      • IHsmEventDispatcher::isTimerRunning()

• Class Variant
  • Class Documentation
    • Variant
      • Variant::Type
        • Variant::Type::UNKNOWN
        • Variant::Type::BYTE_1
        • Variant::Type::BYTE_2
        • Variant::Type::BYTE_4
        • Variant::Type::BYTE_8
        • Variant::Type::UBYTE_1
        • Variant::Type::UBYTE_2
        • Variant::Type::UBYTE_4
        • Variant::Type::UBYTE_8
        • Variant::Type::DOUBLE
        • Variant::Type::BOOL
        • Variant::Type::STRING
        • Variant::Type::BYTEARRAY
        • Variant::Type::LIST
        • Variant::Type::VECTOR
        • Variant::Type::MAP
        • Variant::Type::PAIR
        • Variant::Type::CUSTOM
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::~Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::Variant()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::operator=()
      • Variant::clear()
      • Variant::getType()
      • Variant::operator bool()
      • Variant::isEmpty()
      • Variant::isNumeric()
      • Variant::isSignedNumeric()
      • Variant::isUnsignedNumeric()
      • Variant::isBool()
      • Variant::isString()
      • Variant::isByteArray()
      • Variant::isVector()
      • Variant::isList()
      • Variant::isMap()
      • Variant::isPair()
      • Variant::isCustomType()
      • Variant::toInt64()
      • Variant::toUInt64()
      • Variant::toDouble()
      • Variant::toBool()
      • Variant::toString()
      • Variant::toByteArray()
      • Variant::getByteArray()
      • Variant::getVector()
      • Variant::toVector()
      • Variant::getList()
      • Variant::toList()
      • Variant::getMap()
      • Variant::toMap()
      • Variant::getPair()
      • Variant::toPair()
      • Variant::getCustomType()
      • Variant::operator==()
      • Variant::operator!=()
      • Variant::operator>()
      • Variant::operator>=()
      • Variant::operator<()
      • Variant::operator<=()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::make()
      • Variant::makeCustom()
      • Variant::make()

Enums

• Enum HistoryType
  • Enum Documentation

• Enum StateAction
  • Enum Documentation

• Enum StateActionTrigger
  • Enum Documentation

• Enum TransitionType
  • Enum Documentation

Variables

• Variable hsmcpp::HSM_WAIT_INDEFINITELY
  • Variable Documentation
    • HSM_WAIT_INDEFINITELY

• Variable hsmcpp::INVALID_HSM_DISPATCHER_HANDLER_ID
  • Variable Documentation
    • INVALID_HSM_DISPATCHER_HANDLER_ID

• Variable hsmcpp::INVALID_HSM_EVENT_ID
  • Variable Documentation
    • INVALID_HSM_EVENT_ID

• Variable hsmcpp::INVALID_HSM_STATE_ID
  • Variable Documentation
    • INVALID_HSM_STATE_ID

• Variable hsmcpp::INVALID_HSM_TIMER_ID
  • Variable Documentation
    • INVALID_HSM_TIMER_ID

Defines

• Define DISPATCHER_DEFAULT_EVENTS_CACHESIZE
  • Define Documentation

Typedefs

• Typedef hsmcpp::ActionHandlerFunc_t
  • Typedef Documentation
    • ActionHandlerFunc_t

• Typedef hsmcpp::ByteArray_t
  • Typedef Documentation
    • ByteArray_t

• Typedef hsmcpp::EnqueuedEventHandlerFunc_t
  • Typedef Documentation
    • EnqueuedEventHandlerFunc_t

• Typedef hsmcpp::EventHandlerFunc_t
  • Typedef Documentation
    • EventHandlerFunc_t

• Typedef hsmcpp::EventID_t
  • Typedef Documentation
    • EventID_t

• Typedef hsmcpp::HandlerID_t
  • Typedef Documentation
    • HandlerID_t

• Typedef hsmcpp::HsmStateChangedCallback_t
  • Typedef Documentation
    • HsmStateChangedCallback_t

• Typedef hsmcpp::HsmStateEnterCallback_t
  • Typedef Documentation
    • HsmStateEnterCallback_t

• Typedef hsmcpp::HsmStateExitCallback_t
  • Typedef Documentation
    • HsmStateExitCallback_t

• Typedef hsmcpp::HsmTransitionCallback_t
  • Typedef Documentation
    • HsmTransitionCallback_t

• Typedef hsmcpp::HsmTransitionConditionCallback_t
  • Typedef Documentation
    • HsmTransitionConditionCallback_t

• Typedef hsmcpp::HsmTransitionFailedCallback_t
  • Typedef Documentation
    • HsmTransitionFailedCallback_t

• Typedef hsmcpp::StateID_t
  • Typedef Documentation
    • StateID_t

• Typedef hsmcpp::TimerHandlerFunc_t
  • Typedef Documentation
    • TimerHandlerFunc_t

• Typedef hsmcpp::TimerID_t
  • Typedef Documentation
    • TimerID_t

• Typedef hsmcpp::VariantList_t
  • Typedef Documentation
    • VariantList_t

• Typedef hsmcpp::VariantMap_t
  • Typedef Documentation
    • VariantMap_t

• Typedef hsmcpp::VariantPair_t
  • Typedef Documentation
    • VariantPair_t

• Typedef hsmcpp::VariantVector_t
  • Typedef Documentation
    • VariantVector_t