more ai generated doc with human review
This commit is contained in:
@@ -1,12 +1,16 @@
|
||||
/*! \file pistatemachine_transition.h
|
||||
* \ingroup StateMachine
|
||||
* \~\brief
|
||||
* \~english State machine transition
|
||||
* \~russian Переход машины состояний
|
||||
*/
|
||||
//! \addtogroup StateMachine
|
||||
//! \{
|
||||
//! \file pistatemachine_transition.h
|
||||
//! \brief
|
||||
//! \~english State machine transition
|
||||
//! \~russian Переход машины состояний
|
||||
//! \details
|
||||
//! \~english Contains transition classes for state machine
|
||||
//! \~russian Содержит классы переходов для машины состояний
|
||||
//! \}
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
State machine transition
|
||||
State machine transition
|
||||
Ivan Pelipenko peri4ko@yandex.ru, Andrey Bychkov work.a.b@yandex.ru
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
@@ -39,7 +43,13 @@ class PIP_EXPORT PITransitionBase {
|
||||
public:
|
||||
//! \~english Creates transition from source to target on event
|
||||
//! \~russian Создает переход от source к target по событию
|
||||
//! \param source Source state
|
||||
//! \param target Target state
|
||||
//! \param event_id Event identifier that triggers this transition
|
||||
PITransitionBase(PIStateBase * source, PIStateBase * target, int event_id);
|
||||
|
||||
//! \~english Virtual destructor
|
||||
//! \~russian Виртуальный деструктор
|
||||
virtual ~PITransitionBase();
|
||||
|
||||
//! \~english Returns state machine this transition belongs to
|
||||
@@ -114,11 +124,20 @@ protected:
|
||||
|
||||
//! \~english Timeout transition
|
||||
//! \~russian Переход по таймауту
|
||||
//! \details
|
||||
//! \~english Transition that triggers after specified timeout
|
||||
//! \~russian Переход, который срабатывает после указанного таймаута
|
||||
class PIP_EXPORT PITransitionTimeout: public PITransitionBase {
|
||||
public:
|
||||
//! \~english Creates timeout transition
|
||||
//! \~russian Создает переход по таймауту
|
||||
//! \param source Source state
|
||||
//! \param target Target state
|
||||
//! \param timeout Timeout duration
|
||||
PITransitionTimeout(PIStateBase * source, PIStateBase * target, PISystemTime timeout);
|
||||
|
||||
//! \~english Destructor
|
||||
//! \~russian Деструктор
|
||||
~PITransitionTimeout();
|
||||
|
||||
private:
|
||||
@@ -128,4 +147,6 @@ private:
|
||||
PITimer timer;
|
||||
};
|
||||
|
||||
//! \}
|
||||
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user