Syntaxe de la fonction MathScript (module MathScript RT)

Aide du module LabVIEW 2012 MathScript RT

Date d'édition : June 2012

Numéro de référence : 373123C-0114

»Afficher les infos sur le produit
Télécharger l'aide (Windows uniquement)

Vous ne pouvez pas exécuter directement des fonctions MathScript. Autrement dit, vous devez d'abord définir et enregistrer une fonction avant de pouvoir appeler cette fonction avec des entrées et sorties dans la fenêtre MathScript LabVIEW ou le nœud MathScript. Une fonction MathScript LabVIEW doit utiliser la syntaxe suivante :

function sorties = nom_de_la_fonction(entrées)
% documentation
script
  • Commencez chaque définition de fonction par function.
  • Définissez les variables en sortie pour sorties. Si la fonction a plusieurs variables en sortie, encadrez-les entre crochets et séparez-les avec des espaces blancs ou des virgules.
  • Définissez le nom de la fonction pour nom_de_la_fonction.
  • Définissez les variables en entrée pour entrées. Utilisez des virgules pour séparer les variables en entrée.
  • Créez du contenu d'aide pour documentation. LabVIEW affiche cette aide pour la fonction lorsque vous exécutez la commande help dans la fenêtre MathScript LabVIEW ou que vous placez le curseur sur la fonction dans un nœud MathScript. Ajoutez un caractère % au début de chaque ligne de la documentation d'aide. Vous pouvez placer le contenu de l'aide n'importe où dans la définition de la fonction. Toutefois, LabVIEW n'affiche que le premier groupe de lignes de commentaires dans la fenêtre de résultat de la fenêtre MathScript LabVIEW et dans la fenêtre d'Aide contextuelle. Vous pouvez utiliser toutes les autres lignes de commentaires pour la documentation interne.
  • Définissez la partie exécutable de la fonction pour script.

L'exemple suivant représente une fonction définie par l'utilisateur qui renvoie à la fois la somme et la différence de deux valeurs en entrée :

function [sum, difference] = sumdifference(a, b)

%Trouve la somme et la différence de a et b

sum = a + b;

difference = a - b;

Pour cet exemple, vous devez enregistrer la fonction sous sumdifference.m. Le nom de fichier d'une fonction doit être identique au nom de la fonction et doit avoir l'extension .m en minuscule. Vous pouvez utiliser la syntaxe suivante pour appeler sumdifference.m depuis la fenêtre MathScript LabVIEW ou un nœud MathScript :

[sum, difference] = sumdifference(5, 9)

Les exemples suivants montrent les signatures de fonction valides pour foo, foo représentant une fonction définie par l'utilisateur :

function foo function a = foo function [a b] = foo
function foo() function a = foo() function [a b] = foo()
function foo(g) function a = foo(g) function [a b] = foo(g)
function foo(g, h) function a = foo(g, h) function [a b] = foo(g, h)

Définition des sous-fonctions

Si vous définissez plusieurs fonctions dans le même fichier MathScript, toutes les fonctions qui suivent la première sont des sous-fonctions et ne sont accessibles qu'à partir de la fonction principale. Vous ne pouvez pas appeler des fonctions de façon récursive. Par exemple, foo ne peut pas appeler foo. LabVIEW ne supporte pas non plus les appels de fonction récursifs circulaires. Par exemple, foo ne peut pas appeler bar si bar appelle foo.

L'exemple suivant représente un fichier MathScript qui utilise la syntaxe correcte. fadd3 est la fonction principale, et add2 est une sous-fonction de fadd3.

function a = fadd3(x)
% fadd3 ajoute 3 à la valeur x en entrée.
a = 1 + add2(x);

function a = add2(x)
% add2 est une sous-fonction. Seule fadd3 peut appeler cette fonction.
% add2 calcule la constante 2 avec la formule d'Euler :
% e^(i*theta) = cos(theta) + i*sin(theta)
a = x - (exp(i*pi) - 1);

Spécification des entrées et sorties facultatives

Vous pouvez spécifier des options et des sorties facultatives pour une fonction. Utilisez la fonction arginnum pour déterminer le nombre d'arguments en entrée fournis à la fonction qui appelle arginnum. Si le nombre d'entrées fournies est inférieur au nombre maximum d'entrées de la fonction, vous pouvez assigner des valeurs par défaut pour définir les entrées facultatives. Utilisez la fonction argoutnum pour déterminer le nombre d'arguments en sortie requis par la fonction qui appelle argoutnum. Si le nombre de sorties demandées est inférieur au nombre maximum de sorties de la fonction, vous pouvez ignorer le calcul des sorties non demandées.

CET ARTICLE VOUS A-T-IL ÉTÉ UTILE ?

Pas utile