How to Use Parent and Child Rules

Revision as of 14:02, 1 June 2018

Parent and Child Rules

Parent Rules:

Rules that act as Parent Rules can have one or more sub-rules or Child Rules indented under them.
Only certain rules can be Parent Rules. See the Trainz Wiki page Parent Rule List for details.

Child Rules:

Rules that act as Child Rules are indented under a Parent Rule.
To indent a rule, highlight (select) it and click the Right Arrow Indent tool at the bottom of the Session Editor.

Any rule can be a Child Rule.
Child Rules are only executed if the Parent Rule returns a True result from the condition or test it is examining.

Example:

In the screenshot above, the

Trigger Check Rule is a Parent Rule. It has rules indented below it.
- Simultaneous List Rule is indented under the Trigger Check Rule so it is a Child of that rule. It is also a Parent Rule as it has rules indented below it
  - Message Popup Rule is indented under the Simultaneous List Rule so it is a Child of that rule.
  - Wait Rule is indented under the Simultaneous List Rule so it is a Child of that rule. It is also a Parent Rule as it has rules indented below it
    - Close Message Popup Rule is indented under the Wait Rule so it is a Child of that rule.

You can think of this as a family tree.

Trigger Check Rule	Parent of Simultaneous List Rule Grand Parent of Message Popup Rule Grand Parent of Wait Rule Great Grand Parent of Close Message Popup Rule
Simultaneous Check Rule	Child of Trigger Check Rule Parent of Message Popup Rule Parent of Wait Rule Grand Parent of Close Message Popup Rule
Message Popup Rule	Grand Child of Trigger Check Rule Child of Simultaneous List Rule Sibling of Wait Rule
Wait Rule	Grand Child of Trigger Check Rule Child of Simultaneous List Rule Sibling of Message Popup Rule Parent of Close Message Popup Rule
Close Message Popup Rule	Great Grand Child of Trigger Check Rule Grand Child of Simultaneous Rule Child of Wait Rule

Sequence of Events:

When the consist identified in the Trigger Check Rule reaches the set trigger, then the Trigger Event is activated and its child rules are executed.
- The Simultaneous List Rule (which has no conditional test) is then executed. It executes all its child rules simultaneously.
  - The Message Popup Rule is executed. This waits until its message window is closed. At the same time ...
  - The Wait Rule is executed. This is set to force a 20 second wait, after which ...
    - The Close Message Popup Rule is executed. This closes the Message window created by the Message Popup Rule. Since it is the last rule under the Simultaneous List Rule it terminates that rule. Since it is the last rule under the Trigger Check Rule, it also terminates that rule.

Ordered Lists vs Simultaneous Lists

The majority of sibling Child Rules, rules that are at the same indent level under a Parent Rule, will be executed in order (an Ordered List) or simultaneously (a Simultaneous List).

Ordered Lists: Ordered List Rule

Ordered Lists are shown with numbered icons on each Child Rule which indicates the order in which they will be executed.

Each Child Rule in the sequence must be completed before the next Child Rule can be executed.

Because some rules will wait for an event (such as a mouse click, timer, consist trigger, load trigger, etc) before they are completed, it is possible for the Ordered List to hang indefinitely waiting for the event.
An Ordered List is completed when the last Child Rule is completed.
If possible, place Child Rules that are event dependent at the end of an ordered list.

Simultaneous Lists: Simultaneous List Rule

Simultaneous Lists are shown with equality ("=") icons on each Child Rule which indicates that they will be executed at the same time.
A Simultaneous List can be set to complete when:-
- all the Child Rules are completed, OR
- any one of the Child Rules has been completed.

Other Types of Lists

Progressive Lists: Progressive List Rule

On the first run of a Progressive List, only the first Child Rule is executed. On the second run, the second Child Rule is executed, on the third run the third Child Rule is executed, etc.