Switch Point Functions - Versionsgeschichte

Marc Horstmann: Die Seite wurde neu angelegt: „

EEPSetSw…“
2018-09-07T12:47:02Z

Die Seite wurde neu angelegt: „ <table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;"> <tr> <th colspan="2">EEPSetSw…“

Neue Seite
<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPSetSwitch()</th>
<th style="padding: 10px;">EEPSetSwitch(ID,Direction,Callback)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
-- set switch point 0067 to 1 (main line)
EEPSetSwitch(67, 1)

-- set switch point 0089 to 1 and call
EEPOnSwitch_89()
EEPSetSwitch(89, 1, 1)
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">two or three</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 10.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;">Switches a switch-point.</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>First argument is a numeric value representing the switch point’s ID.</li>
<li>Second argument is the switch point’s aspect.</li>
<li>If a 1 is entered as a third (optional) argument, the EEPOnSwitch_x() function for this switch is called when the direction of the switch has changed.</li>
<li><b>Use with care!</b> The switch must be registerd and the corresponding function must be declared. (see next page). Careless use of this function may result in infinite loops.</li>
<li>The function returns a 1 if the switch and the demanded direction exist. It returns a 0 if either one of the two could not be found.</li>
</ul>
</td>
</tr>
</table>

<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPGetSwitch()</th>
<th style="padding: 10px;">EEPGetSwitch(ID)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
currentDirection = EEPGetSwitch(1)
if currentDirection == 0 then
print("Switch point 1 doesn’t exist")
elseif currentDirection == 1 then
print("Switch point 1 set to main line")
elseif currentDirection == 2 then
print("Switch point 1 set to branch line")
end
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 10.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;">Provides the current state of a switch point.</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>Argument is the switch point’s ID.</li>
<li>Return value is a numeric representation of the switch’s current state. The value reflects the state’s position in the effects list of the switch point’s properties.</li>
<li>The return value is 0 if the switch doesn’t exist.</li>
</ul>
</td>
</tr>
</table>

<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPRegisterSwitch()</th>
<th style="padding: 10px;">EEPRegisterSwitch(ID)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
EEPRegisterSwitch(1)
function EEPOnSwitch_1(Direction)
print("switch point 1 changed to ",
Direction)
end
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 10.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;">Registers a switch for the callback function EEPOnSwitch_x(). The requirement of a registration prevents switches from triggering a callback when no appropriate function was declared.</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>The registration is mandatory for those switches which you want to trigger the EEPOnSwitch_x() function whenever the direction changes.</li>
<li>Argument is the switch’s ID.</li>
<li>Return value is 1, if the switch exists or 0 if it doesn’t exist.</li>
</ul>
</td>
</tr>
</table>

<table width="90%" align="center" border="1" style="border: 1px solid black; border-collapse: collapse;">
<tr>
<th colspan="2">EEPOnSwitch_x()</th>
<th style="padding: 10px;">EEPOnSwitch_x(Direction)</th>
</tr>
<tr>
<td scope="row">type: </td>
<td style="padding: 10px;">function</td>
<td rowspan="6" style="font: 15px Courier New, sans-serif; padding: 10px;">
<pre>
EEPRegisterSwitch(1)
function EEPOnSwitch_1(Direction)
print("switch point 1 changed to ", Direction)
end
</pre>
</td>
</tr>
<tr>
<td scope="row">caller: </td>
<td style="padding: 10px;">EEP</td>
</tr>
<tr>
<td scope="row">defined in: </td>
<td style="padding: 10px;">script</td>
</tr>
<tr>
<td scope="row">parameters: </td>
<td style="padding: 10px;">one</td>
</tr>
<tr>
<td scope="row">returns: </td>
<td style="padding: 10px;">none</td>
</tr>
<tr>
<td scope="row">requires: </td>
<td style="padding: 10px;">EEP 10.2 plug-in 2</td>
</tr>
<tr>
<td scope="row">purpose: </td>
<td colspan="2" style="padding: 10px;">Every aspect change induced by a contact or by manual operation (directly or in a link chain) triggers this callback function if the switch has been registerd for callbacks. <b>However</b>: Changing this or a linked switch’s state by Lua function will not trigger the callback, unless the third argument in that function was a 1.</td>
</tr>
<tr>
<td scope="row">notes: </td>
<td colspan="2">
<ul>
<li>The name of the function must not end in _x but with the switch’s ID. For switch 0034 the correct name of the function would be EEPOnSwitchl_34().</li>
<li><b>Please note</b>: The leading zeroes must be omitted in the function’s name!</li>
<li>The function is called with the new switch direction as an argument. The number matches the position in the switch’s direction list as found in the switch’s properties. Use a variable of your choosing to store this value.</li>
<li>EEP requires no return value when calling this function.</li>
</ul>
</td>
</tr>
</table>