65 lines
2.3 KiB
C
65 lines
2.3 KiB
C
//! \file pistatemachinemodule.h
|
||
//! \ingroup StateMachine
|
||
//! \~\brief
|
||
//! \~english Declares module entry includes for the state machine API
|
||
//! \~russian Объявляет основной include модуля API машины состояний
|
||
/*
|
||
PIP - Platform Independent Primitives
|
||
Module includes
|
||
Ivan Pelipenko peri4ko@yandex.ru
|
||
|
||
This program is free software: you can redistribute it and/or modify
|
||
it under the terms of the GNU Lesser General Public License as published by
|
||
the Free Software Foundation, either version 3 of the License, or
|
||
(at your option) any later version.
|
||
|
||
This program is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU Lesser General Public License for more details.
|
||
|
||
You should have received a copy of the GNU Lesser General Public License
|
||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
*/
|
||
//! \defgroup StateMachine StateMachine
|
||
//! \~\brief
|
||
//! \~english State machine.
|
||
//! \~russian Машина состояний.
|
||
//!
|
||
//! \~\details
|
||
//! \~english \section cmake_module_StateMachine Building with CMake
|
||
//! \~russian \section cmake_module_StateMachine Сборка с использованием CMake
|
||
//!
|
||
//! \~\code
|
||
//! find_package(PIP REQUIRED)
|
||
//! target_link_libraries([target] PIP)
|
||
//! \endcode
|
||
//!
|
||
//! \~english \par Common
|
||
//! \~russian \par Общее
|
||
//!
|
||
//! \~english
|
||
//! The module provides hierarchical states, event-driven transitions, timeout
|
||
//! transitions and helper state classes for callback-based logic.
|
||
//! Details in \ref state_machine_overview
|
||
//! \~russian
|
||
//! Модуль предоставляет иерархические состояния, переходы по событиям,
|
||
//! переходы по таймауту и вспомогательные классы состояний для логики на callback-функциях.
|
||
//! Подробнее \ref state_machine_overview
|
||
//!
|
||
//! \~\authors
|
||
//! \~english
|
||
//! Ivan Pelipenko peri4ko@yandex.ru;
|
||
//! \~russian
|
||
//! Иван Пелипенко peri4ko@yandex.ru;
|
||
//!
|
||
|
||
#ifndef PISTATEMACHINEMODULE_H
|
||
#define PISTATEMACHINEMODULE_H
|
||
|
||
#include "pistatemachine.h"
|
||
#include "pistatemachine_state.h"
|
||
#include "pistatemachine_transition.h"
|
||
|
||
#endif
|