build_stt

Функция build_stt оценивает грамматико-конформное выражение как параметр. Он возвращает переходную таблицу, которая является mpl:: вектор переходов (рядов) или, если выражение плохо сформировано (не соответствует грамматике), тип invalid_type, который приведет к статическому утверждению времени компиляции, когда эта переходная таблица передается машине состояния.

build_internal_stt

Функция build_internal_stt оценивает грамматико-конформное выражение как параметр. Он возвращает переходную таблицу, которая является mpl:: вектор переходов (рядов) или, если выражение плохо сформировано (не соответствует грамматике), тип invalid_type, который приведет к статическому утверждению времени компиляции, когда эта переходная таблица передается машине состояния.

transition table

Переходная таблица принимает следующую грамматику:

Stt := Row | (Stt ',' Stt)
Row := (Target '==' (SourcePlusEvent)) /* first syntax*/
       | ( (SourcePlusEvent) '==' Target ) /* second syntax*/
       | (SourcePlusEvent) /* internal transitions */
SourcePlusEvent := (BuildSource '+' BuildEvent)/* standard transition*/ 
                   | (BuildSource) /* anonymous transition */
BuildSource := state_tag | (state_tag '/' Action) | (state_tag '[' Guard ']') 
            | (state_tag '[' Guard ']' '/' Action)
BuildEvent := event_tag | (event_tag '/' Action) | (event_tag '[' Guard ']') 
            | (event_tag '[' Guard ']' '/' Action)

Грамматика Action и Guard определены в state_grammar.hpp и guard_grammar.hpp соответственно. State_tag и event_tag наследуются от euml_state (или других вариантов состояния) и euml_event соответственно. Например, возможны следующие заявления:

target == source + event [guard] / action,
source + event [guard] / action == target,
source + event [guard] / (action1,action2) == target,
target == source + event [guard] / (action1,action2),
target == source + event,
source + event == target,
target == source + event [guard],
source + event [guard] == target,
target == source + event / action,
source + event /action == target,
source / action == target, /*anonymous transition*/
target == source / action, /*anonymous transition*/
source + event /action, /* internal transition*/

internal transition table

Внутренняя таблица переходов принимает следующую грамматику:

IStt := BuildEvent | (IStt ',' IStt)

BuildEvent определяется как для внутренних, так и для стандартных таблиц перехода.

build_sm

Эта функция имеет несколько перегрузок. Тип возврата не относится к вам, так как только тип возврата - это то, что вам нужно.

Определяет состояние машины без входа или выхода:

Определение машины состояния с поведением входа:

Определяет состояние машины с поведением входа и выхода:

Определяет машину состояния с поведением входа, выхода и атрибутами:

Определяет машину состояния с поведением входа, выхода, атрибутами и конфигурацией (отложенные события, флаги):

Определяет машину состояния с поведением входа, выхода, атрибутами, конфигурацией (отложенные события, флаги) и базовым состоянием:

Обратите внимание, что эта функция требует, чтобы класс дополнительных параметров StateNameTag разграничивал машины состояний, имеющие те же параметры, но все еще отличающиеся.

build_state

Эта функция имеет несколько перегрузок. Тип возврата не относится к вам, так как только тип возврата - это то, что вам нужно.

Определяет простое состояние без входа или выхода:

Определяет простое состояние с входным поведением:

Определяет простое состояние с поведением входа и выхода:

Определяет простое состояние с поведением входа, выхода и атрибутами:

Определяет простое состояние с поведением входа, выхода, атрибутами и конфигурацией (отложенные события, флаги):

Определяет простое состояние с поведением входа, выхода, атрибутами, конфигурацией (отложенные события, флаги) и базовым состоянием:

Обратите внимание, что эта функция требует, чтобы класс дополнительных параметров StateNameTag разъяснял состояния, имеющие те же параметры, но все еще отличающиеся.

build_terminate_state

Эта функция имеет те же перегрузки, что и build_state.

build_interrupt_state

Эта функция имеет несколько перегрузок. Тип возврата не относится к вам, так как только тип возврата - это то, что вам нужно.

Определяет состояние прерывания без входа или выхода:

Определяет состояние прерывания с поведением входа:

Определяет состояние прерывания с поведением входа и выхода:

Определяет состояние прерывания с поведением входа, выхода и атрибутами:

Определяет состояние прерывания с поведением входа, выхода, атрибутами и конфигурацией (отложенные события, флаги):

Определяет состояние прерывания с поведением входа, выхода, атрибутами, конфигурацией (отложенные события, флаги) и базовым состоянием:

Обратите внимание, что эта функция требует, чтобы класс дополнительных параметров StateNameTag разъяснял состояния, имеющие те же параметры, но все еще отличающиеся.

build_entry_state

Эта функция имеет несколько перегрузок. Тип возврата не относится к вам, так как только тип возврата - это то, что вам нужно.

Определение состояния входа без входа или выхода:

Определяет входное псевдосостояние с входным поведением:

Определяет псевдосостояние входа с поведением входа и выхода:

Определяет псевдосостояние входа с поведением входа, выхода и атрибутами:

Определение псевдосостояния входа с поведением входа, выхода, атрибутами и конфигурацией (отложенные события, флаги):

Определяет псевдосостояние входа с поведением входа, выхода, атрибутами, конфигурацией (отложенные события, флаги) и базовым состоянием:

Обратите внимание, что эта функция требует, чтобы класс дополнительных параметров StateNameTag разъяснял состояния, имеющие те же параметры, но все еще отличающиеся.

build_exit_state

Эта функция имеет несколько перегрузок. Тип возврата не относится к вам, так как только тип возврата - это то, что вам нужно.

Определяет псевдосостояние выхода без входа или выхода:

Определяет псевдосостояние выхода с поведением входа:

Определяет псевдо-состояние выхода с поведением входа и выхода:

Определяет псевдосостояние выхода с поведением входа, выхода и атрибутами:

Определяет псевдосостояние выхода с входом, поведением выхода, атрибутами и конфигурацией (отложенные события, флаги):

Определяет псевдосостояние выхода с входом, поведением выхода, атрибутами, конфигурацией (отложенные события, флаги) и базовым состоянием:

Обратите внимание, что эта функция требует, чтобы класс дополнительных параметров StateNameTag разъяснял состояния, имеющие те же параметры, но все еще отличающиеся.

build_explicit_entry_state

Эта функция имеет те же перегрузки, что и build_entry_state и explicit_entry_func_state, что и тип возврата.

euml_event

Основной тип событий с eUML.

 template <class EventName> euml_event; {
}

struct play : euml_event<play>{};

euml_state

Основной тип для государств с eUML. Обычно вы не будете использовать этот тип напрямую, так как его легче использовать. BOOST_MSM_EUML_STATE, BOOST_MSM_EUML_INTERRUPT_STATE, BOOST_MSM_EUML_TERMINATE_STATE, BOOST_MSM_EUML_EXIT_STATE, BOOST_MSM_EUML_EXIT_STATE.

 template <class StateName> euml_state; {
}

Однако вы можете использовать этот тип напрямую, если вы хотите предоставить вашему состоянию дополнительные функции или обеспечить поведение входа или выхода без функторов, например:

struct Empty : public msm::front::state<> , public euml_state<Empty> 
{
    void foo() {...}
    template <class Event,class Fsm>
    void on_entry(Event const& evt,Fsm& fsm){...}
};

euml_flag

Тип флагов с eUML.

 template <class FlagName> euml_flag; {
}

struct PlayingPaused: euml_flag<PlayingPaused>{};

euml_action

Основной тип для состояний или переходных поведений и охранников с eUML.

 template <class AcionName> euml_action; {
}

struct close_drawer : euml_action<close_drawer>
{
    template <class Fsm,class Evt,class SourceState,class TargetState>
    void operator()(Evt const& , Fsm&, SourceState& ,TargetState& ) {...}
};

Или как поведение входа или выхода из состояния:

struct Playing_Entry : euml_action<Playing_Entry>
{
    template <class Event,class Fsm,class State>
    void operator()(Event const&,Fsm& fsm,State& ){...}
};

euml_config

Основной тип конфигурационных возможностей с eUML.

 template <class ConfigName> euml_config; {
}

Обычно вы не используете этот тип напрямую, а вместо этого используете предопределенную конфигурацию:

invalid_type

Тип возвращают грамматические парсеры, если грамматика недействительна. Увидеть этот тип приведет к статическому утверждению.

no_action

Тип держателя для использования в поведении входа / выхода или перехода, который абсолютно ничего не делает.

source_

Общий объект или функция для исходного состояния данного перехода:

target_

Общий объект или функция для целевого состояния данного перехода:

state_

Общий объект или функция для состояния заданного поведения входа/выхода. state_ означает source_ в контексте поведения выхода и target_ в контексте поведения входа:

event_

Общий объект или функция для события, запускающего данный переход (действительны в поведении перехода, а также в поведении входа/выхода состояния):

fsm_

Общий объект или функция для государственной машины, содержащей данный переход:

substate_

Общий объект или функция, возвращающая состояние данной машины состояния:

attribute_

Общий объект или функция, возвращающая пройденный атрибут (по имени) как второй параметр пройденной вещи как первый (состояние, событие или машина состояния). Пример:

attribute_(substate_(my_state),cd_name_attribute)++

True_

Функтор возвращается истинным для переходного или государственного поведения. Как и все константы, существует только форма функтора, поэтому необходимы скобки. Пример:

if_then_(True_(),/* some action always called*/)

False_

Функтор, возвращающийся ложным для переходного или государственного поведения. Как и все константы, существует только форма функтора, поэтому необходимы скобки. Пример:

if_then_(False_(),/* some action never called */)

Int_<int value>

Функтор возвращает целое значение для переходного или государственного поведения. Как и все константы, существует только форма функтора, поэтому необходимы скобки. Пример:

target_(m_ringing_cpt) = Int_<RINGING_TIME>() // RINGING_TIME is a constant

Char_<char value>

Функтор возвращает значение шара для переходного или государственного поведения. Как и все константы, существует только форма функтора, поэтому необходимы скобки. Пример:

// look for 'S' in event.m_song
[string_find_(event_(m_song),Char_<'S'>(),Size_t_<0>()) != Npos_<string>()]

Size_t_<size_t value>

Functor возвращает значение size_t для переходного или государственного поведения. Как и все константы, существует только форма функтора, поэтому необходимы скобки. Пример:

substr_(event_(m_song),Size_t_<1>()) // returns a substring of event.m_song

String_ < mpl::string >

Функтор возвращает строку для переходного или государственного поведения. Как и все константы, существует только форма функтора, поэтому необходимы скобки. Требуется повышение >= 1,40 для mpl::string.

Пример:

// adds "Let it be" to fsm.m_src_container
push_back_(fsm_(m_src_container), String_<mpl::string<'Let','it ','be'> >())

Predicate_ < some_stl_compatible_functor >

Этот функтор eUML поддерживает STL-функтор (для использования в алгоритме). Это необходимо, потому что все, что находится в таблице перехода, должно быть терминалом eUML.

Пример:

//equivalent to: 
//std::accumulate(fsm.m_vec.begin(),fsm.m_vec.end(),1,std::plus<int>())== 1
accumulate_(begin_(fsm_(m_vec)),end_(fsm_(m_vec)),Int_<1>(),
            Predicate_<std::plus<int> >()) == Int_<1>())

process_

Эта функция отправляет событие на 4 машины состояний, вызывая на них process_event:

process2_

Эта функция отправляет событие на 3 машины состояний, вызывая на них process_event и копируя конструкцию события из данных, переданных в качестве второго параметра:

Пример:

// processes NotFound on current state machine, 
// copy-constructed with event.m_song
process2_(NotFound,event_(m_song))

Со следующими определениями:

BOOST_MSM_EUML_DECLARE_ATTRIBUTE(std::string,m_song)//declaration of m_song
NotFound (const string& data) // copy-constructor of NotFound

is_flag_

Эта функция показывает, активен ли флаг, позвонив is_flag_active на машине текущего состояния или в качестве параметра:

defer_

Этот объект отсрочивает текущее событие, вызывая defer_event на машине текущего состояния. Пример:

Empty() + play() / defer_

explicit_(submachine-name,state-name)

Используемый в качестве цели перехода, вызывает явный вход в данное состояние из данной подмашины. Несколько эксплицитных_ в качестве целей, разделенных запятыми, означают вилку. Государство должно быть объявлено как таковое с использованием BOOST_MSM_EUML_EXPLICIT_ENTRY_STATE.

entry_pt_(submachine-name,state-name)

Используемый в качестве мишени перехода от содержащей состояние машины, вызывает ввод субмашинного имени с использованием данного входного псевдо-состояния. Это состояние должно быть объявлено как псевдозапись с использованием BOOST_MSM_EUML_ENTRY_STATE.

exit_pt_(submachine-name,state-name)

Используемый в качестве источника перехода из содержащей состояние машины, вызывает оставление субмашинного имени с использованием данного выхода псевдо-состояния. Это состояние должно быть объявлено как псевдовыход с использованием BOOST_MSM_EUML_EXIT_STATE.

MSM_EUML_FUNCTION

Этот макрос создает функцию eUML и функтор для использования с фронтендом функтора на основе бесплатной функции:

Отметим, что сама функция может принимать до 5 аргументов.

Пример:

MSM_EUML_FUNCTION(BinarySearch_,std::binary_search,binary_search_,bool,bool)

Можно использовать как:

binary_search_(begin_(fsm_(m_var)),end_(fsm_(m_var)),Int_<9>())

MSM_EUML_METHOD

Этот макрос создает функцию eUML и функтор для использования с фронтендом функтора на основе метода:

Заметим, что сам метод может принимать до 4 аргументов (5 как для свободной функции - 1 для объекта, на который называется метод).

Пример:

struct Empty : public msm::front::state<> , public euml_state<Empty> 
{
     void activate_empty() {std::cout << "switching to Empty " << std::endl;}
... 
};
MSM_EUML_METHOD(ActivateEmpty_,activate_empty,activate_empty_,void,void)

Можно использовать как:

Empty == Open + open_close / (close_drawer , activate_empty_(target_))

BOOST_MSM_EUML_ACTION(action-instance-name)

Этот макрос объявляет тип поведения и конст-пример для использования в поведении состояния или перехода. Сама реализация действий следует за макродекларированием, например:

BOOST_MSM_EUML_ACTION(good_disk_format)
{
     template <class Fsm,class Evt,class SourceState,class TargetState>
     void/bool operator()(Evt const& evt,Fsm&,SourceState& ,TargetState& ){...}
};

BOOST_MSM_EUML_FLAG(flag-instance-name)

Этот макрос объявляет тип флага и конст-пример для использования в поведении.

BOOST_MSM_EUML_FLAG_NAME(flag-instance-name)

Этот макрос возвращает имя типа флага, генерируемого BOOST_. MSM_EUML_FLAG. Это необходимо там, где требуется тип (обычно с помощью метода back-end is_flag_active). Например:

fsm.is_flag_active<BOOST_MSM_EUML_FLAG_NAME(CDLoaded)>()

BOOST_MSM_EUML_DECLARE_ATTRIBUTE(event-type,event-name)

Этот макрос объявляет атрибут, называемый event-name типа event-type. Этот атрибут может быть включен в список атрибутов с помощью BOOST_. MSM_EUML_ATTRIBUTES.

BOOST_MSM_EUML_ATTRIBUTES(attributes-expression,attributes-name)

Этот макрос объявляет список атрибутов, называемый атрибутами, основанный на выражении в качестве первого аргумента. Эти атрибуты затем могут быть сделаны частью события, используя BOOST_MSM_EUML_EVENT_WITH_ATTRIBUTES, состояния как 3-й параметр BOOST_MSM_EUML_STATE или машины состояния как 5-й параметр BOOST_MSM_EUML_DECLARE_STATE_MACHINE.

Атрибуты добавляются с помощью левого смещения, например:

// m_song is of type std::string
BOOST_MSM_EUML_DECLARE_ATTRIBUTE(std::string,m_song)
// contains one attribute, m_song
BOOST_MSM_EUML_ATTRIBUTES((attributes_ << m_song ), FoundDef)

BOOST_MSM_EUML_EVENT(event-instance name)

Этот макрос определяет тип события (event-instance-name_helper) и объявляет константный экземпляр этого типа события, называемый event-instance-name, для использования в таблице переходов или поведения состояния.

BOOST_MSM_EUML_EVENT_WITH_ATTRIBUTES(event-instance-name,attributes)

Этот макрос определяет тип события (event-instance-name_helper) и объявляет константный экземпляр этого типа события, называемый event-instance-name, для использования в таблице переходов или поведения состояния. Событие будет иметь в качестве атрибутов те, которые прошли второй аргумент:

BOOST_MSM_EUML_EVENT_WITH_ATTRIBUTES(Found,FoundDef)

Созданный экземпляр события поддерживает оператор()(атрибуты), так что

my_back_end.process_event(Found(some_string))

это возможно.

BOOST_MSM_EUML_EVENT_NAME(event-instance-name)

Этот макрос возвращает название типа события, генерируемого BOOST_MSM_EUML_EVENT или BOOST_MSM_EUML_EVENT_WITH_ATTRIBUTES. Это нужно там, где требуется тип (обычно в заднем определении). Например:

typedef msm::back::state_machine<Playing_,
msm::back::ShallowHistory<mpl::vector<BOOST_MSM_EUML_EVENT_NAME(end_pause)
> > > Playing_type;

BOOST_MSM_EUML_STATE(build-expression,state-instance-name)

Этот макрос определяет тип состояния (state-instance-name_helper) и объявляет константный экземпляр этого типа состояния, называемый state-instance-name, для использования в таблице переходов или поведения состояния.

Существует несколько возможных вариантов синтаксиса выражения:

BOOST_MSM_EUML_INTERRUPT_STATE(build-expression,state-instance-name)

Этот макрос определяет тип состояния прерывания (state-instance-name_helper) и объявляет константный экземпляр этого типа состояния, называемый state-instance-name, для использования в таблице переходов или поведения состояния.

Существует несколько поссибилитов для синтаксиса выражения. Во всех из них первым аргументом является название события (сгенерированного одним из предыдущих макросов), заканчивающего прерывание:

BOOST_MSM_EUML_TERMINATE_STATE(build-expression,state-instance-name)

Этот макрос определяет конечный тип псевдосостояния (state-instance-name_helper) и объявляет константный экземпляр этого типа состояния, называемый state-instance-name, для использования в таблице переходов или поведения состояния.

Существует несколько возможных вариантов синтаксиса выражения:

BOOST_MSM_EUML_EXIT_STATE(build-expression,state-instance-name)

Этот макрос определяет тип псевдосостояния выхода (state-instance-name_helper) и объявляет константный экземпляр этого типа состояния, называемый state-instance-name, для использования в таблице перехода или поведения состояния.

Существует несколько возможных вариантов синтаксиса выражения:

Обратите внимание, что переадресованное событие должно быть сконструировано из события, отправленного подмашиной, содержащей точку выхода.

BOOST_MSM_EUML_ENTRY_STATE(int region-index,build-expression,state-instance-name)

Этот макрос определяет тип входного псевдо-состояния (state-instance-name_helper) и объявляет константный экземпляр этого типа состояния, называемый state-instance-name, для использования в таблице переходов или поведения состояния.

Существует несколько возможных вариантов синтаксиса выражения:

BOOST_MSM_EUML_EXPLICIT_ENTRY_STATE(int region-index,build-expression,state-instance-name)

Этот макрос определяет тип субмашины (state-instance-name_helper), который может быть явно введен, а также объявляет константный экземпляр этого типа состояния, называемый state-instance-name, для использования в таблице переходов или поведения состояния.

Существует несколько возможных вариантов синтаксиса выражения:

BOOST_MSM_EUML_STATE_NAME(state-instance-name)

Этот макрос возвращает название типа состояния, генерируемого BOOST_MSM_EUML_STATE или другими макросами состояния. Это нужно там, где требуется тип (обычно с помощью функции бэкэнда). Например:

fsm.get_state<BOOST_MSM_EUML_STATE_NAME(StringFind)&>().some_state_function();

BOOST_MSM_EUML_DECLARE_STATE(build-expression,state-instance-name)

Как и BOOST_MSM_EUML_STATE, но не предоставляет пример, а просто декларацию типа.

BOOST_MSM_EUML_DECLARE_INTERRUPT_STATE(build-expression,state-instance-name)

Как и BOOST_MSM_EUML_INTERRUPT_STATE, но не предоставляет пример, просто объявление типа.

BOOST_MSM_EUML_DECLARE_TERMINATE_STATE(build-expression,state-instance-name)

Как и BOOST_MSM_EUML_TERMINATE_STATE, но не предоставляет пример, просто объявление типа.

BOOST_MSM_EUML_DECLARE_EXIT_STATE(build-expression,state-instance-name)

Как и BOOST_MSM_EUML_EXIT_STATE, но не предоставляет пример, а просто декларацию типа.

BOOST_MSM_EUML_DECLARE_ENTRY_STATE(int region-index,build-expression,state-instance-name)

Как и BOOST_MSM_EUML_ENTRY_STATE, но не предоставляет пример, а просто декларацию типа.

BOOST_MSM_EUML_DECLARE_EXPLICIT_ENTRY_STATE(int region-index,build-expression,state-instance-name)

Как и BOOST_MSM_EUML_EXPLICIT_ENTRY_STATE, но не предоставляет пример, просто объявление типа.

BOOST_MSM_EUML_TRANSITION_TABLE(expression, table-instance-name)

Этот макрос объявляет тип таблицы перехода, а также константный экземпляр таблицы, который затем может использоваться в объявлении машины состояния (см. BOOST_MSM_EUML_DECLARE_STATE_MACHINE). Выражение должно следовать грамматике таблицы перехода .

BOOST_MSM_EUML_DECLARE_TRANSITION_TABLE(iexpression,table-instance-name)

Как и BOOST_MSM_EUML_TRANSITION_TABLE, но не предоставляет пример, а просто декларацию типа.

BOOST_MSM_EUML_INTERNAL_TRANSITION_TABLE(expression, table-instance-name)

Этот макрос объявляет тип переходной таблицы, а также константный экземпляр таблицы. Выражение должно следовать грамматике таблицы перехода . На данный момент этот макрос не используется.

BOOST_MSM_EUML_DECLARE_INTERNAL_TRANSITION_TABLE(iexpression,table-instance-name)

Как и BOOST_MSM_EUML_TRANSITION_TABLE, но не предоставляет пример, а просто декларацию типа. В настоящее время это единственный способ объявить внутреннюю таблицу перехода с eUML. Например:

BOOST_MSM_EUML_DECLARE_STATE((Open_Entry,Open_Exit),Open_def)
struct Open_impl : public Open_def
{
    BOOST_MSM_EUML_DECLARE_INTERNAL_TRANSITION_TABLE((
          open_close [internal_guard1] / internal_action1 ,
          open_close [internal_guard2] / internal_action2
    ))
};