Serge NOEL
508 lines
24 KiB
Plaintext
508 lines
24 KiB
Plaintext
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
|
|
<title>JMRI: Conditional State Variables and Actions List</title>
|
|
<meta name="author" content="Bob Jacobsen">
|
|
<meta name="keywords" content="JMRI help Logix Conditional Add Edit">
|
|
<!--#include virtual="/help/en/parts/Style.shtml" -->
|
|
</head>
|
|
<body>
|
|
<!--#include virtual="/help/en/parts/Header.shtml" -->
|
|
|
|
<div id="mBody">
|
|
<div id="mainContent" class="no-sidebar">
|
|
<h1>Conditional State Variables and Actions List</h1>
|
|
|
|
<dl>
|
|
<dd>
|
|
<h2 id="variable">Available State Variables</h2>
|
|
|
|
<p>State variables that are currently available for use in Conditionals are listed below,
|
|
along with information on each. State variables must always evaluate to either true or
|
|
false. The condition resulting in true is given for each. If the condition is not met,
|
|
the state variable evaluates to false. When a Logix is active, the states of entities
|
|
(sensor, turnout, light, etc.) specified in state variables in its Conditionals are
|
|
monitored, unless the Triggers Calculation checkbox of the state variable is unchecked. A
|
|
calculation of all Conditionals in the Logix is triggered when any monitored state
|
|
changes as noted below (if not obvious).</p>
|
|
|
|
<ul>
|
|
<li>Sensor
|
|
<ul>
|
|
<li><strong>Sensor Active</strong>: Evaluates to true if the state of the specified
|
|
sensor is active.</li>
|
|
|
|
<li><strong>Sensor Inactive</strong>: Evaluates to true if the state of the
|
|
specified sensor is inactive.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Turnout
|
|
<ul>
|
|
<li><strong>Turnout Thrown</strong>: Evaluates to true if the known state of the
|
|
specified turnout is thrown.</li>
|
|
|
|
<li><strong>Turnout Closed</strong>: Evaluates to true if the known state of the
|
|
specified turnout is closed.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Light
|
|
<ul>
|
|
<li><strong>Light On</strong>: Evaluates to true if the specified light is on.</li>
|
|
|
|
<li><strong>Light Off</strong>: Evaluates to true if the specified light is
|
|
off.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Signal Head
|
|
<ul>
|
|
<li><strong>Signal Head Appearance equals</strong>: Evaluates to true if the
|
|
appearance of the specified signal head matches the selected Variable Aspect
|
|
(appearance).</li>
|
|
|
|
<li><strong>Signal Head Lit</strong>: Evaluates to true if the specified signal
|
|
head is lit.</li>
|
|
|
|
<li><strong>Signal Head Held</strong>: Evaluates to true if the specified signal
|
|
head is being held.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Signal Mast
|
|
<ul>
|
|
<li><strong>Signal Mast Aspect Equals</strong>: Evaluates to true if the aspect of
|
|
the specified signal mast equals the aspect specified in the state variable.
|
|
Calculation is triggered when the aspect of the signal mast changes.</li>
|
|
|
|
<li><strong>Signal Mast Lit</strong>: Evaluates to true if the specified signal
|
|
mast is Lit.</li>
|
|
|
|
<li><strong>Signal Mast Held</strong>: Evaluates to true if the specified signal
|
|
mast is being held.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Memory
|
|
<ul>
|
|
<li>
|
|
<strong>Memory-Value Compare</strong>: Compares the value saved in the specified
|
|
memory to the value specified in the state variable using a specified comparison
|
|
operator. Evaluates to true if the comparison is true. There are 5 comparison
|
|
operators that may be used for the evaluation:
|
|
<ul>
|
|
<li>"less than"</li>
|
|
|
|
<li>"less than or equal"</li>
|
|
|
|
<li>"equals"</li>
|
|
|
|
<li>"greater than or equal"</li>
|
|
|
|
<li>"greater than"</li>
|
|
</ul>
|
|
Calculation is triggered when the monitored memory value changes so that the
|
|
comparison to the specified value changes.
|
|
</li>
|
|
|
|
<li>
|
|
<strong>Memory-Memory Compare</strong>: Compares the value saved in one specified
|
|
memory to the value saved in a second memory location. There are 5 comparison
|
|
operators that may be used for the evaluation:
|
|
<ul>
|
|
<li>"less than"</li>
|
|
|
|
<li>"less than or equal"</li>
|
|
|
|
<li>"equals"</li>
|
|
|
|
<li>"greater than or equal"</li>
|
|
|
|
<li>"greater than"</li>
|
|
</ul>
|
|
Calculation is triggered when one of the monitored memory values changes so that
|
|
the comparison value changes.
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Conditional
|
|
<ul>
|
|
<li><strong>Conditional True</strong>: Evaluates to true if the state of the
|
|
specified Conditional is true.</li>
|
|
|
|
<li><strong>Conditional False</strong>: Evaluates to true if the state of the
|
|
specified Conditional is false.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Warrant
|
|
<ul>
|
|
<li><strong>Route Free</strong>: Evaluates to true when the route is
|
|
available.</li>
|
|
|
|
<li><strong>Route Set</strong>: Evaluates to true when the route has bee set.</li>
|
|
|
|
<li><strong>Route Allocated</strong>: Evaluates to true when the route has been
|
|
allocated.</li>
|
|
|
|
<li><strong>Route Occupied</strong>: Evaluates to true when the route has been
|
|
occupied.</li>
|
|
|
|
<li><strong>Train Running</strong>: Evaluates to true< when a train is
|
|
running./li></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Fast Clock
|
|
<ul>
|
|
<li><strong>Fast Clock Range</strong>: Evaluates to true if the current fast clock
|
|
time is between the begin time and end time specified for the range. Times must be
|
|
specified in hh:mm format, where hh is hours and mm is minutes, relative to a
|
|
24-hour clock. Calculation is triggered when the fast clock time enters the range
|
|
and when the fast clock time exits the range.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Occupancy Block
|
|
<ul>
|
|
<li><strong>Occupied</strong>: Evaluates to true when the block is occupied.</li>
|
|
|
|
<li><strong>Power Error</strong>: Evaluates to true when a power error has
|
|
occurred.</li>
|
|
|
|
<li><strong>Out Of Service</strong>: Evaluates to true when a block is out of
|
|
service.</li>
|
|
|
|
<li><strong>Dark</strong>: Evaluates to true when a block is to dark.</li>
|
|
|
|
<li><strong>Path Occupied</strong>: Evaluates to true when a path is occupied</li>
|
|
|
|
<li><strong>Unoccupied</strong>: Evaluates to true when a path is not
|
|
occupied.</li>
|
|
|
|
<li><strong>Allocated</strong>: Evaluates to true when the block is allocated.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Entry Exit
|
|
<ul>
|
|
<li><strong>Active</strong>: Evaluates to true when the Entry/Exit is active.</li>
|
|
|
|
<li><strong>Inactive</strong>: Evaluates to true when the Entry/Exit is not
|
|
active.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
|
|
<dd>
|
|
<h2 id="action">Available Actions</h2>
|
|
|
|
<p>Actions that are currently available for use in Conditionals are listed below along
|
|
with information on each:</p>
|
|
|
|
<ul>
|
|
<li>Sensor
|
|
<ul>
|
|
<li><strong>Set Sensor</strong>: Sets the specified sensor to the chosen state.
|
|
Specify the sensor to set by entering its name. Specify the state to set by
|
|
choosing Active or Inactive in the popup menu.</li>
|
|
|
|
<li><strong>Delayed Set Sensor</strong>: Sets the specified sensor to the chosen
|
|
state after waiting for a specified number of seconds. Specify the sensor to set by
|
|
entering its name. Specify the state to set by choosing Active or Inactive in the
|
|
popup menu. Specify the number of seconds to delay before setting the sensor by
|
|
entering a number in the right-most field. If this Conditional is already waiting
|
|
to set this sensor, this action is ignored, and the previous action continues as
|
|
originally scheduled.(see also <strong>Reset Delayed Set Sensor</strong>
|
|
below.)</li>
|
|
|
|
<li><strong>Reset Delayed Set Sensor</strong>: Sets the specified sensor to the
|
|
chosen state after waiting for a specified number of seconds. Specify the sensor to
|
|
set by entering its name. Specify the state to set by choosing Active or Inactive
|
|
in the popup menu. Specify the number of seconds to delay before setting the sensor
|
|
by entering a number in the right-most field. This action is the same as
|
|
<strong>Delayed Set Sensor</strong>, except if this Conditional is already actively
|
|
waiting to set the specified sensor, the previous wait is cancelled, and a new wait
|
|
period is started. In effect, the wait time is restarted. The sensor is not set
|
|
until the most recent wait period expires.</li>
|
|
|
|
<li><strong>Cancel Timers for Sensor</strong>: Cancels all timers waiting to set
|
|
the specified sensor in all Conditionals in all Logixs. Specify the sensor by
|
|
entering its name. The sensor is not set; all active delayed actions for setting
|
|
the specified sensor are cancelled without setting the sensor.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Turnout
|
|
<ul>
|
|
<li><strong>Set Turnout</strong>: Sets the specified turnout to the chosen state.
|
|
Specify the turnout to set by entering its name. Specify the state to set by
|
|
choosing Closed or Thrown in the popup menu.</li>
|
|
|
|
<li><strong>Delayed Set Turnout</strong>: Sets the specified turnout to the chosen
|
|
state after waiting for a specified number of seconds. Specify the turnout to set
|
|
by entering its name. Specify the state to set by choosing Closed or Thrown in the
|
|
popup menu. Specify the number of seconds to delay before setting the turnout by
|
|
entering a number in the right-most field. If this Conditional is already waiting
|
|
to set this turnout, this action is ignored, and the previous action continues as
|
|
originally scheduled.(see also <strong>Reset Delayed Set Turnout</strong>
|
|
below.)</li>
|
|
|
|
<li>
|
|
<strong>Turnout Lock</strong>: Locks or unlocks a turnout. Enter the name for the
|
|
turnout, and choose the operation from the popup menu. <strong>Note:</strong> To
|
|
control the type of turnout lock go to the <a href=
|
|
"../beantable/TurnoutTable.shtml">Turnout Table</a> and select the Lock Mode.
|
|
</li>
|
|
|
|
<li><strong>Cancel Timers for Turnout</strong>: Cancels all timers waiting to set
|
|
the specified turnouts in all Conditionals in all Logixs. Specify the turnout by
|
|
entering its name. The turnout is not set; all active delayed actions for setting
|
|
the specified turnout are cancelled without setting the turnout.</li>
|
|
|
|
<li><strong>Reset Delayed Set Turnout</strong>: Sets the specified turnout to the
|
|
chosen state after waiting for a specified number of seconds. Specify the turnout
|
|
to set by entering its name. Specify the state to set by choosing Closed or Thrown
|
|
in the popup menu. Specify the number of seconds to delay before setting the
|
|
turnout by entering a number in the right-most field. This action is the same as
|
|
<strong>Delayed Set Turnout</strong>, except if this Conditional is already
|
|
actively waiting to set the specified turnout, the previous wait is cancelled, and
|
|
a new wait period is started. In effect, the wait time is restarted. The turnout is
|
|
not set until the most recent wait period expires.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Light
|
|
<ul>
|
|
<li><strong>Set Light</strong>: Sets the specified light to the chosen state.
|
|
Specify the light to set by entering its name. Specify the state to set by choosing
|
|
On or Off in the popup menu.</li>
|
|
|
|
<li><strong>Set Light Intensity</strong>: Sets the intensity of a specified
|
|
variable intensity light to the entered intensity value. Specify the light to set
|
|
by entering its name. Specify the intensity by entering the percent intensity as an
|
|
integer in the range 0 to 100. If the specified light is not a variable light, or
|
|
if the intensity value entered is not an integer in the required range, an error
|
|
message is displayed.</li>
|
|
|
|
<li><strong>Set Light Transition Time</strong>: Sets the transition time of a
|
|
specified variable intensity light to the entered time. Specify the light to set by
|
|
entering its name. Specify the transition time by entering the number of fast clock
|
|
minutes needed to move from 0% intensity to 100% intensity. If the specified light
|
|
is not a variable light, or if a positive integer is not entered for the number of
|
|
fast clock minutes, an error message results.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Signal Head
|
|
<ul>
|
|
<li><strong>Set Signal Appearance</strong>: Sets the specified signal head to the
|
|
chosen appearance. Specify the signal head to set by entering its name. Specify the
|
|
appearance to set by choosing from the popup menu.</li>
|
|
|
|
<li><strong>Set Signal Held</strong>: Sets the specified signal head to hold.
|
|
Specify the signal head to hold by entering its name.</li>
|
|
|
|
<li><strong>Clear Signal Held</strong>: Clears the hold on the specified signal
|
|
head. Specify the signal head by entering its name.</li>
|
|
|
|
<li><strong>Set Signal Dark</strong>: Sets the specified signal head to not lit.
|
|
Specify the signal head by entering its name.</li>
|
|
|
|
<li><strong>Set Signal Lit</strong>: Sets the specified signal head to lit. Specify
|
|
the signal head by entering its name.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Signal Mast
|
|
<ul>
|
|
<li><strong>Set Signal Mast Aspect</strong>: Sets the specified signal mast to the
|
|
chosen aspect. Specify the signal mast to set by entering its name. Select the
|
|
aspect from the Signal Mast Aspect list.</li>
|
|
|
|
<li><strong>Set Signal Mast Held</strong>: Sets the specified signal mast to hold.
|
|
Specify the signal mast to hold by entering its name.</li>
|
|
|
|
<li><strong>Clear Signal Mast Held</strong>: Clears the hold on the specified
|
|
signal mast. Specify the signal mast by entering its name.</li>
|
|
|
|
<li><strong>Set Signal Mast Dark</strong>: Sets the specified signal mast to not
|
|
lit. Specify the signal mast by entering its name.</li>
|
|
|
|
<li><strong>Clear Signal Mast Dark</strong>: Sets the specified signal mast to lit.
|
|
Specify the signal mast by entering its name.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Memory
|
|
<ul>
|
|
<li><strong>Set Memory</strong>: Sets the specified memory to the entered value.
|
|
Specify the memory to set by entering its name. Specify the value to set in the
|
|
memory by entering it in the right-most field.</li>
|
|
|
|
<li><strong>Copy Memory To Memory</strong>: Copies the value of a memory variable
|
|
to another memory variable. Specify the memory to be copied from by entering its
|
|
name in the leftmost field. Specify the memory to receive the copied value by
|
|
entering its name in the rightmost field.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Logix
|
|
<ul>
|
|
<li><strong>Enable Logix</strong>: Enables the specified logix. Specify the logix
|
|
to enable by entering its name.</li>
|
|
|
|
<li><strong>Disable Logix</strong>: Disables the specified logix. Specify the logix
|
|
to disable by entering its name.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Entry Exit
|
|
<ul>
|
|
<li><strong>Set NX Pair Enabled</strong>: Enables the specified Entry/Exit Pair.
|
|
Specify the Entry/Exit Pair to enable by entering its name.</li>
|
|
|
|
<li><strong>Set NX Pair Disabled</strong>: Disables the specified Entry/Exit Pair.
|
|
Specify the Entry/Exit Pair to enable by entering its name.</li>
|
|
|
|
<li><strong>Set NX Pair Segment Active / Inactive</strong>: Request that the route
|
|
segment for the specified Entry/Exit Pair be activated if not active or deactivated
|
|
if active. Specify the Entry/Exit Pair to enable by entering its name.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Warrant
|
|
<ul>
|
|
<li><strong>Allocate Warrant Route</strong>: Allocates (reserves) the OBlocks
|
|
comprising the route of the warrant for use by the warrant. Specify the warrant by
|
|
entering its System Name or User Name.</li>
|
|
|
|
<li><strong>Deallocate Warrant</strong>: Deallocates the OBlocks comprising the
|
|
route of the warrant so they may be allocated to other warrants. Specify the
|
|
warrant by entering its System Name or User Name.</li>
|
|
|
|
<li><strong>Set Route Turnouts</strong>: Sets all the turnouts comprising the route
|
|
of the warrant. Specify the warrant by entering its System Name or User Name.</li>
|
|
|
|
<li><strong>Auto Run Train</strong>: Starts playback of the recorded script for the
|
|
train specified in the warrant. Specify the warrant by entering its System Name or
|
|
User Name.</li>
|
|
|
|
<li><strong>Manually Run Train</strong>: Serves a "clearance" to an operator that a
|
|
humanly run train has running rights for the extent of the warrant's route. Specify
|
|
the warrant by entering its System Name or User Name.</li>
|
|
|
|
<li>
|
|
<strong>Control Auto Train</strong>: Issues the specified command to an auto run
|
|
train. Specify the warrant of the train by entering its System Name or User Name.
|
|
The Commands are:
|
|
<ul>
|
|
<li>Halt</li>
|
|
|
|
<li>Resume</li>
|
|
|
|
<li>Abort</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li><strong>Set Train ID</strong>: Set the train ID from the roster or the DCC
|
|
address. When a DCC address is used, also specify Long or Short. Example: 1234(L)
|
|
or 10(S).</li>
|
|
|
|
<li><strong>Set Train Name</strong>: Set the train Name for the selected
|
|
Warrant.</li>
|
|
|
|
<li><strong>Set Throttle Factor</strong>: Increases or decreases the throttle
|
|
settings of an auto run train by the specified factor. Specify the warrant of the
|
|
train by entering its System Name or User Name.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Fast Clock
|
|
<ul>
|
|
<li><strong>Set Fast Clock Time</strong>: Sets the time on the fast clock to the
|
|
entered time. The time is entered as <em>hh:mm</em> where <em>hh</em> is hours and
|
|
<em>mm</em> is minutes on a 24-hour clock. This action sets the fast clock to the
|
|
specified time regardless of whether the fast clock is running or stopped.</li>
|
|
|
|
<li><strong>Start Fast Clock</strong>: Starts the JMRI fast clock running. If the
|
|
fast clock is already running, this action has no effect.</li>
|
|
|
|
<li><strong>Stop Fast Clock</strong>: Pauses the JMRI fast clock. If the fast clock
|
|
is not running, this action has no effect.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Occupancy Block
|
|
<ul>
|
|
<li><strong>Deallocate Block</strong>: Deallocates an Occupancy block. Specify the
|
|
OBlock by entering its System Name or User Name.</li>
|
|
|
|
<li><strong>Set Block Value</strong>: Set a value for the selected block.</li>
|
|
|
|
<li><strong>Set Block Error</strong>: Set the selected block status to "block
|
|
error".</li>
|
|
|
|
<li><strong>Clear Block Error</strong>: Remove the "block error" status for the
|
|
selected block</li>
|
|
|
|
<li><strong>Set Block OutOfService</strong>: Sets the status of an Occupancy block
|
|
to Out-Of-Service. Specify the OBlock by entering its System Name or User
|
|
Name.</li>
|
|
|
|
<li><strong>Clear Block OutOfService</strong>: Sets the status of an Occupancy
|
|
Block to the current normal status. Specify the OBlock by entering its System Name
|
|
or User Name.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Audio
|
|
<ul>
|
|
<li><strong>Play Sound File</strong>: Plays the specified sound file. Specify the
|
|
sound file to play by entering its name in the field provided. Click
|
|
<strong>Set</strong> to bring up a file selection dialog to aid in finding the
|
|
file. Navigate to your sound file, then click your sound file's name in the dialog
|
|
to copy it (including its path) to the field.</li>
|
|
|
|
<li><strong>Control Audio object</strong>:</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Script
|
|
<ul>
|
|
<li><strong>Script: Run Script</strong>: Starts the specified script. Specify the
|
|
script to start by entering its name in the field provided. Click
|
|
<strong>Set</strong> to bring up a file selection dialog for finding the file.
|
|
Navigate to your script file, then click your script file's name in the dialog to
|
|
copy it (including its path) to the field.</li>
|
|
|
|
<li><strong>Script: Execute Jython Command</strong>: Enter the command in the
|
|
Script Command field.</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Other
|
|
<ul>
|
|
<li><strong>Trigger Route</strong>: Triggers the specified route. Specify the route
|
|
by entering its name.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2>Logix Documentation Pages Logically Listed</h2>
|
|
<!--#include virtual="LogixDocList.shtml" -->
|
|
<!--#include virtual="/help/en/parts/Footer.shtml" -->
|
|
</div>
|
|
<!-- closes #mainContent-->
|
|
</div>
|
|
<!-- closes #mBody-->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|