Pour créer une opération de ligne de commande personnalisée à exécuter dans l'interface de ligne de commande (CLI) pour LabVIEW, réalisez les tâches suivantes :

  • 1re partie : Définissez le nom de l'opération.
  • 2e partie : Définissez le comportement de l'opération.
  • 3e partie (facultatif) : Définissez l'aide de l'opération.

1e partie : Définir le nom de l'opération

Dans la CLI pour LabVIEW, les opérations de ligne de commande ont une classe parent, et chaque opération est construite à partir d'une classe enfant de la classe parent. Pour définir le nom de l'opération, vous devez créer une classe enfant de la classe parent et spécifier le nom de cette classe enfant.

Effectuez les étapes suivantes pour définir le nom de l'opération :

  1. Naviguez jusqu'à un des répertoires suivants :
    • (Windows) C:\Program Files (x86)\National Instruments\Shared\LabVIEW CLI\Operations
    • (macOS) /Library/Application Support/National Instruments/LabVIEW CLI/Operations
    • (Linux) /usr/local/natinst/nilvcli/Operations
  2. Ouvrez Operations.lvproj si l'opération ne requiert que le système de développement de LabVIEW ou Toolkit-Operations.lvproj s'il faut aussi des modules ou toolkits LabVIEW.
    Remarque Pour ouvrir Toolkit-Operations.lvproj, vous devez installer les toolkits et la bibliothèque suivants :
    • Toolkit LabVIEW VI Analyzer
    • Toolkit LabVIEW Unit Test Framework
    • Bibliothèque UTF JUnit Report — Installez cette bibliothèque à l'aide du logiciel JKI VI Package Manager (VIPM).
  3. Cliquez avec le bouton droit sur Poste de travail et sélectionnez Nouveau»Classe.
  4. Dans la fenêtre Nouvelle classe, spécifiez le nom de la classe AddTwoNumbers. Le nom de la classe est le nom de l'opération que vous êtes en train de créer.
  5. Dans l'arborescence du projet, cliquez avec le bouton droit sur la classe que vous avez créée et sélectionnez Propriétés.
  6. Sur la page Héritage, cliquez sur Changer la classe parent.
  7. Sélectionnez CoreOperation.lvclass, cliquez sur Hériter de la sélection et cliquez sur OK.

2e partie : Définir le comportement de l'opération

Pour définir le comportement de l'opération, vous devez redéfinir les méthodes de la classe que vous avez créée dans la section précédente et ajouter du code dans une des méthodes redéfinies.

Effectuez les étapes suivantes pour définir le comportement de l'opération :

  1. Dans l'arborescence du projet, cliquez avec le bouton droit sur la classe que vous avez créée dans la section précédente et sélectionnez Nouveau»VI de redéfinition,
  2. Dans la fenêtre Nouvelle redéfinition, sélectionnez GetHelp.vi et RunOperation.vi et cliquez sur OK.
  3. Enregistrez le projet. À l'invite, enregistrez la classe et les méthodes redéfinies dans un dossier du même nom que l'opération.
    Remarque NI vous recommande de mettre le dossier dans un des répertoires suivants pour ne pas avoir besoin de spécifier le chemin du dossier avec l'argument −AdditionalOperationDirectory lorsque vous exécutez l'opération.
    • (Windows) C:\Program Files (x86)\National Instruments\Shared\LabVIEW CLI\Operations
    • (macOS) /Library/Application Support/National Instruments/LabVIEW CLI/Operations
    • (Linux) /usr/local/natinst/nilvcli/Operations
  4. Ouvrez le diagramme de la méthode RunOperation.vi.
  5. Supprimez le sous-VI et recâblez le diagramme.
  6. Ajoutez du code pour définir le comportement de l'opération et enregistrez vos changements. Ne modifiez pas le connecteur, illustré dans la figure suivante.
    TerminalType de donnéesDescription
    Objet LabVIEW de la classe que vous avez créée dans la section précédente.
    Arguments que les utilisateurs entrent dans la CLI pour LabVIEW lorsqu'ils exécutent cette opération. Chaque chaîne du tableau représente un argument.
    Objet LabVIEW de la classe que vous avez créée dans la section précédente.
    Un code renvoyé par la CLI pour LabVIEW à l'application appelante, comme une application Jenkins. Par exemple, vous pouvez configurer la CLI pour LabVIEW afin qu'elle renvoie 0 si l'opération s'exécute avec succès, ou -1 si un erreur a lieu.
    Résultat de l'opération ou messages d'erreur à afficher dans la console de la CLI pour LabVIEW ou à enregistrer dans le fichier journal.
    Reportez-vous à RunOperation.vi dans un des répertoires suivants pour voir un exemple de définition du comportement de l'opération AddTwoNumbers, qui ajoute deux nombres en entrée et renvoie la somme dans la sortie.
    • (Windows) C:\Users\Public\Documents\National Instruments\LabVIEW CLI\Examples\AddTwoNumbers
    • (macOS) /Library/Application Support/National Instruments/LabVIEW CLI/Examples/AddTwoNumbers
    • (Linux) /usr/local/natinst/nilvcli/Examples/AddTwoNumbers

3e partie : Définir l'aide de l'opération

Pour aider les utilisateurs à utiliser l'opération, vous pouvez la documenter en modifiant la méthode GetHelp.vi que vous avez créée dans la section précédente. Les utilisateurs peuvent alors accéder à la documentation en exécutant la commande LabVIEWCLI -OperationName < operation name > -Help.

Effectuez les étapes suivantes pour documenter l'opération :

  1. Ouvrez la méthode GetHelp.vi à partir de l'arborescence du projet.
  2. Sur la face-avant, créez une commande chaîne appelée Help et entrez la documentation dans cette commande.
  3. Cliquez avec le bouton droit sur la commande Help et sélectionnez Opération sur les données»Désigner la valeur actuelle comme défaut pour définir le texte actuel comme valeur par défaut de cette commande. Répétez cette étape à chaque fois que vous modifiez le texte.
  4. Sur le diagramme, supprimez le sous-VI et recâblez.
  5. Câblez les objets comme suit, AddTwoNumbers étant le nom de l'opération, et enregistrez vos modifications.