How to Use Parent and Child Rules

From TrainzOnline
Jump to: navigation, search

Contents

What Are Parent and Child Rules?

Most Parent Rules are used as "decision makers" in TANE Sessions. They decide if or when other rules, the Child Rules, will be executed. Some Parent Rules control how those Child Rules are executed.

DotPoint.JPG Rules that act as Parent Rules can have one or more sub-rules or Child Rules indented under them.


NotePad.PNG Notes:
  • Only certain rules can be Parent Rules. See the Trainz Wiki page WikiLink.PNG List of Parent Rules for details.
  • Most Parent Rules will either wait for a specific event or perform a test or a comparison. They will execute the child rules when the event occurs or the test/comparison is true.
  • Any rule can be a Child Rule.


DotPoint.JPG Rules that act as Child Rules are indented under a Parent Rule.


SessionRuleIndent.JPG

Steps.PNG Steps:

To indent a rule,

  1. highlight (select) it
  2. click the Right Arrow Indent tool at the bottom of the Session Editor

SessionRuleIndented.JPG

Parent/Child Rule Example

Message Popup.jpg

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.


Sequence of Events

  • When the consist identified in the Trigger Check Rule, a Parent Rule, reaches the set trigger, the Trigger Event is activated and its Child Rules are executed.
    • The Simultaneous List Rule, a Parent Rule, is then executed. It executes all its Child Rules immediately and simultaneously.
      • The Message Popup Rule is executed. At the same time ...
      • The Wait Rule is executed. This is set to force a 20 second wait, after which its Child Rule ...
        • 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 Parent Rule. Since it is the last rule under the Trigger Check Rule, it also terminates that Parent 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

Rule details can be found at WikiLink.PNG Ordered List Rule

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

Gears.PNG Settings:

An Ordered List can be set to run:-

  • a set number of times, OR
  • once only

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


NotePad.PNG Notes:
  • 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 (such as the Message Popup Rule) at the end of an ordered list.

Simultaneous Lists

Rule details can be found at WikiLink.PNG Simultaneous List Rule

DotPoint.JPG Simultaneous Lists are shown with equality ("=") icons on each Child Rule which indicates that they will be executed at the same time.
SimultaneousListRule.JPG

Gears.PNG Settings:

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

Rule details can be found at WikiLink.PNG Progressive List Rule

DotPoint.JPG 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.
ProgressiveListRules.JPG

Gears.PNG Settings:

A Progressive List can be set to:-

  • repeat the sequence after the last child rule has been executed, OR
  • terminate (no further repeats) after the last child rule has been executed


Random Lists

Rule details can be found at WikiLink.PNG Random List Rule

DotPoint.JPG A Random List will run ONLY ONCE and will randomly select a single Child Rule to execute.
RandomListRules.JPG

Reset Lists

Rule details can be found at WikiLink.PNG Reset List Rule

DotPoint.JPG A Reset List will execute continuously, it will never terminate. Each time through the list all the Child Rules will be reset and executed again.
ResetListRules.JPG



Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

Personal tools