Structure d'un fichier de macro
Structure
La structure d'un fichier de définition de la macro (*.py) est présentée sur l'exemple ci-dessous.
| Partie | Description |
|---|---|
| 1 | L'en-tête du programme Flux exécutable |
| 2 | La description des paramètres d'entrée de la macro |
| 3 | La définition de la fonction paramétrée dans le langage PyFlux |
En-tête du programme (1)
L'en-tête du programme Flux est obligatoire. Elle précise avec quel programme Flux (2D et/ou 3D) et sa version* la macro peut être exécutée.
Remarque : * la version désignée peut correspondre à la version du logiciel ou être
antérieure.
Description des paramètres (2)
Cette deuxième partie concerne la description des paramètres d'entrée de la macro.
Pour chacun des paramètres il faut définir :
- le nom du paramètre
- le type PyFlux
- la cardinalité minimale et la cardinalité maximale (le nombre de valeurs minimal et maximal correspondant à la structure de donnée)
- la valeur par défaut ou le mot réservé None
- le label associé au paramètre (ce label apparaît dans la boîte de dialogue dédiée à la macro pendant l' exécution )
Fonction paramétrée (3)
Cette troisième partie concerne la définition de la fonction paramétrée.
Pour cette fonction il faut définir :
- le nom de la fonction (= nom de la macro)
- les paramètres d'entrée de la fonction
- le corps de la fonction (instructions PyFlux)