EEPSetSwitch()
Utilité
Commute un aiguillage
Arguments
Deux ou trois
Valeur en retour
Une
Versions EEP min.
EEP10.2 plugin 2 / EEP14.1 plugin 1
Syntaxe
EEPSetSwitch(ID, Position [, Fonction de rappel])
Détails
- Le 1er argument est l'ID de l'aiguillage.
- Le 2ème argument est la position que l'on souhaite faire adopter à l'aiguille. Les valeurs à partir de 1 et suivants déplacent aussitôt l'aiguille dans la position correspondante. La valeur 0 fait en sorte que l'aiguille se déplace dans le positionnement suivant. Avec la valeur -1 l'aiguille revient sur sa position précédente.
- Depuis EEP 14.1 plugin 1 : Un 3ème argument facultatif avec la valeur 1 permet de lancer l'exécution de la fonction de rappel EEPOnSwitch(). Ce 3ème argument n'a d'effet sur l'aiguillage que si celle-ci est enregistrée et qu'une action EEPOnSwitch_x() a été définie. Veuillez utiliser cette fonction avec prudence ! Il existe le danger de la mise en place d'une chaîne de commande incorrecte fonctionnant en boucle et pouvant entraîner la paralysie d'EEP et Lua.
- La valeur retournée est = à 1 lorsque l'aiguillage ainsi que la position souhaitée de l'aiguille existent. Cette valeur sera = à 0 si l'un des deux n'est pas existant.
Exemple
Lua
-- positionne l´aiguille 0067 sur 1 (Branche principale)
EEPSetSwitch(67, 1)
-- positionne l´aiguille 0089 sur 2 (Embranchement) et exécute EEPOnSwitch_89()
EEPSetSwitch(89, 2, 1)