CYCLIC

Icône du lien vers le conceptVoir également Icône du lien vers le conceptExemple

Exécute cycliquement une fonction.

Support WebVue - Oui.

Mode

Mnémonique

Syntaxe

0 ADD 3
1 ADDPROG 1
2 ADDPROG_EX 1
5 DEL 1, 3
6 DELALL 2
7 DEL_EX 1
8 ADDPROGBYID 4
9 DELBYID 5
10 TRACE 6

A partir de la version 8.2 du logiciel, l'instruction ADDPROG est identique à ADD.

Syntaxe 1

IntVal = CYCLIC(Mode, Delay, ProgName, Branch, Function [, Farg [, ActivBit]]) ;

Type de retour : INTEGER

Argument

Définition

Delay

Nombre de secondes entre chaque activation de programme. Type INTEGER Le delai maximum est 2 x 106secondes ou environ 20 jours.

ProgName

Nom du programme contenant la fonction. Type STR.

Branch

Nom de branche passé en argument à la fonction appelée. Type STR. Une chaîne nulle peut être utilisée pour n'indiquer aucune branche.

Function

Nom de la fonction à exécuter. Type STR. Une chaîne nulle peut être utilisée pour n'indiquer aucune fonction (par exemple, juste pour exécuter un programme).

Farg

Facultatif. Chaîne de 2 047 caractères maximum. Ces arguments sont récupérables dans la fonction à exécuter par le verbe GETARG.

Activbit

Optionnel. Nom complet de la variable état ou alarme d'activation de l'événement. Type STR.

Exécution

Mode

Mnémonique

Action

1

ADDPROG

Ajout d'un cyclique.

Il est possible de créer plus d'une action cyclique pour la même fonction avec des valeurs différentes pour delay.

Si une action cyclique existante a les mêmes valeurs pour Delay, ProgName, Branch et Fonction, elle est écrasée.

Si le nom d'une fonction n'est pas spécifié, alors la fonction MAIN est exécutée.

2

ADDPROG_EX

Ajout d'un cyclique.

 

 

Identique au mode 1, excepté que les champs Farg et ActivBit peuvent être utilisés pour distinguer les fonctions cycliques qui sont normalement identiques.

Il est possible de créer plusieurs cycles de la même fonction avec des valeurs de Delay Branch, Farg ou ActivBit différentes.

5

DEL

Suppression d'un cyclique existant.

La valeur des champs Delay, ProgName, Branch et Function doit être la même que lors de la création.

Si Delay est 0, alors tous les cycliques existants appelant Function sont supprimés.

Si Farg et ActivBit ne sont pas spécifiés, tous les cycliques appelant Function sont supprimés.

7

DEL_EX

Suppression d'un cyclique existant.

Si appelé avec Delay = 0, supprime alors toutes les fonctions cycliques appelant la fonction Function dans le programme ProgName avec la branche Branch (se comporte comme le mode DEL en ignorant le Farg et ActivBit passé comme paramètres au moment de la création du cyclique).

Si appelé avec Delay différent de 0, ne supprime que la fonction cyclique appelant la fonction Function dans un programme ProgName avec une branche Branch avec Delay, Farg et ActivBit passés comme arguments. S'il n'existe aucune fonction cyclique, une erreur est retournée.

 

 

Retour : 1 si Ok, 0 sinon.

Le programme doit être préchargé (PRELOAD) pour être exécuté. Il ne doit pas contenir de "MAIN".

La fonction appelée ainsi que les autres fonctions de ce programme susceptibles de se dérouler concurremment, ne doivent pas contenir d'instruction de type DELAY.

Syntaxe 2

IntVal = CYCLIC(Mode[,DellAllMode]);

Type de retour : INTEGER

Argument

Définition

DellAllMode

Argument optionnel pour indiquer quels cycliques doivent être supprimés, les temporaires créés par programme et/ou les permanentes créés par configuration. Type : INTEGER.

1 = Supprime uniquement les cycliques temporaires (valeur par défaut),
2 = Supprime uniquement les cycliques permanents,
3 = Supprime à la fois les cycliques temporaires et les permanents.

Exécution

Mode

Mnémonique

Action

6

DELALL

Suppression d'un cyclique existant.

 

 

Retour : toujours 1.

Le programme doit être préchargé (PRELOAD) pour être exécuté.

Une fonction cyclique ne peut être modifiée une fois démarrée. Elle doit être stoppée et reprogrammée.

La fonction appelée ainsi que les autres fonctions de ce programme susceptibles de se dérouler concurremment, ne doivent pas contenir d'instruction de type DELAY.

Syntaxe 3

IntVal = CYCLIC(Mode, Delay, ProgName, Branch, Function, Farg, ActivBit);

Type de retour : INTEGER

Argument

Définition

Delay

Nombre de secondes entre chaque activation de programme. Type INTEGER Le délai maximum est 2 x 106 secondes ou environ 20 jours.

ProgName

Nom du programme contenant la fonction. Type STR.

Branch

Nom de branche passé en argument à la fonction appelée. Type STR. Une chaîne nulle peut être utilisée pour n'indiquer aucune branche.

Function

Nom de la fonction à exécuter. Type STR. Une chaîne nulle peut être utilisée pour n'indiquer aucune fonction (par exemple, juste pour exécuter un programme).

Farg

Chaîne de 2 047 caractères maximum, contenant de 1 à 8 arguments séparés par des , (virgule). Ces arguments sont récupérables dans la fonction à exécuter par le verbe GETARG.

Activbit

Nom complet de la variable état ou alarme d'activation de l'événement. Type STR.

Exécution

Mode

Mnémonique

Action

0

ADD

Ajout d'un cyclique.

5

DEL

Suppression d'un cyclique existant. Des champs doivent être les mêmes que les valeurs d'origine, voir Syntaxe 1 ci-dessus.

 

 

Retour : 1 si la suppression est prise en compte, 0 sinon.

Depuis la version 8.2, les modes ADD et ADDPROG sont les mêmes.

Syntaxe 4

IntVal = CYCLIC(Mode, Name, Description, ServerListName, Delay, ProgName, Branch, Function, [Farg[, FactiveBit]]);

Type de retour : INTEGER

Argument

Définition

Name Identifiant de l'action cyclique tel qu'il apparaît dans le champ Nom de l'Application Explorer. Type STR.
Description Description de l'action cyclique tel qu'elle apparaît dans le champ Description de l'Application Explorer. Type STR.
ServerListName Nom de Liste des serveurs dans la configuration du réseau. Le cyclique ne sera actif que si le poste appartient à cette liste. Si ce paramètre est vide, le cyclique sera actif sur tous les postes. Type STR.

Delay

Nombre de secondes entre chaque activation de programme. Type INTEGER Le délai maximum est 2 x 106 secondes ou environ 20 jours.

ProgName

Nom du programme contenant la fonction. Type STR.

Branch

Nom de branche passé en argument à la fonction appelée. Type STR. Une chaîne nulle peut être utilisée pour n'indiquer aucune branche.

Function

Nom de la fonction à exécuter. Type STR. Une chaîne nulle peut être utilisée pour n'indiquer aucune fonction (par exemple, juste pour exécuter un programme).

Farg

Chaîne de 2 047 caractères maximum, contenant de 1 à 8 arguments séparés par des , (virgule). Ces arguments sont récupérables dans la fonction à exécuter par le verbe GETARG.

Activbit

Le nom de la variable état ou alarme, s'il y en a, qui active l'événement. Type STR.

Exécution

Mode

Mnémonique

Action

8

ADDPROGBYID

Ajouter une action cyclique pour une fonction en utilisant le nom, la description et la liste du serveur.

 

 

Retour : 1 si OK, 0 sinon.

Syntaxe 5

IntVal = CYCLIC(Mode, Name);

Type de retour : INTEGER

Argument

Définition

Name Le nom de l'action cyclique tel que vue dans la configuration.

Exécution

Mode

Mnémonique

Action

9

DELBYID

Suppression de l'action cyclique spécifiée par son nom.

 

 

Retour : 1 si OK, 0 sinon.

Syntaxe 6

IntVal = CYCLIC(Mode, SubMode);

Type de retour : INTEGER

Argument

Définition

SubMode

"ON" ou "OFF". Type STR.

Exécution

Mode

Mnémonique

Action

10 TRACE

Active ("ON") ou désactive ("OFF") les traces de diagnostic. Des messages trace apparaissent dans l'observateur d'événements (F7) et sont générés à chaque fois qu'une fonction cyclique est ajoutée ou supprimée.

Retour : 1 si OK, 0 sinon.

Exemple de message de trace

[SV.Cyclics] The traces are activated

[SV.Cyclics] AddCyclicAction name=CyclicAction2713 program=TryCyclic.svb function=Func1 branch= arg= period=60000ms

[SV.Cyclics] DeleteCyclicAction name=CyclicAction2713 program=TryCyclic.svb function=Func1 branch= arg= period=60000ms

Exemple

Pour plus d'exemples, sélectionnez le lien Exemple ci-dessus.