Skip to content
This repository has been archived by the owner on Jan 5, 2021. It is now read-only.

[Documentation] Behaviour on internally-raised events described #1569

Merged
merged 2 commits into from
Aug 1, 2017

Conversation

RainerKlute
Copy link
Contributor

[Documentation] Differentiate Standard and Professional Editions Comp-Documentation

@RainerKlute
Copy link
Contributor Author

Fixes #1565.

For the syntax of event declaration, see section ""Events"":#events.

When a reaction raises an event, the subsequent behaviour of the state machine is highly dependent on the execution scheme, selected by either the "@CycleBased":#statechart_language_cyclebased (default) or the "@EventDriven":#statechart_language_eventdriven annotation. In short:
* In the _cycle-based execution scheme_, the raised event will be added to the events that are processed by the current run-to-completion step. However, it will only be visible "downstream" in the run cycle, i.e. active states that have not yet been executed can take the event into account. When the run cycle is completed, the event will cease to exist. It can thus not be processed in any subsequent run-to-completion step.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"cease to exist" is a bit drastic, maybe "stop to exist", or "not exist anymore"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a quite usual term. If you don't agree, you are welcome to attribute it to poetic license.

@@ -916,7 +925,16 @@ p(#fig_region-priorities).

p=. Region priorities

Not being able to raise an event and process it in "earlier" regions is a restriction you can overcome using variables. The idea is to set a "communication variable" to a certain value in a region that is processed "later". During the next RTC the earlier region could act on the variables value.
Not being able to raise an event and process it in "earlier" regions is a restriction you can overcome using variables. The idea is to set a "communication variable" to a certain value in a region that is processed "later". During the next RTC the earlier region could act on the variables value. Another option – and in many cases the better on, is to change to the event-driven execution scheme.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have the feeling I've read this section three times now. Wouldn't it be more useful to use links and only explain it only once? At the very least, all repetitions have to be maintained.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I beg to differ. This is the only occurrence of this paragraph in the whole user guide.

@andreasmuelder andreasmuelder merged commit 9f1ab69 into master Aug 1, 2017
@andreasmuelder andreasmuelder deleted the issue/1565_docu_internally_raised_events branch August 1, 2017 11:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants