LabVIEW用コマンドラインインターフェイス (CLI) で実行するカスタムコマンドライン操作を作成するには、以下のタスクを実行します。

  • パート1: 操作の名前を定義します。
  • パート2: 操作の動作を定義します。
  • パート3 (オプション): 操作のヘルプを定義します。

パート1: 操作の名前を定義する

LabVIEW用のCLIでは、コマンドライン操作に親クラスがあり、各操作は親クラスの子クラスから作成されます。操作の名前を定義するには、親クラスの子クラスを作成し、その子クラスの名前を指定する必要があります。

操作の名前を定義するには、次のステップを実行します。

  1. 次のいずれかのディレクトリに移動します。
    • (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. 操作にLabVIEW開発システムのみが必要か、追加のLabVIEWモジュールとツールキットが必要かどうかによって、Operations.lvprojまたはToolkit-Operations.lvprojを開きます。
    メモ Toolkit-Operations.lvprojを開くには、以下のツールキットとライブラリをインストールする必要があります。
    • LabVIEW VI Analyzerツールキット
    • LabVIEW Unit Test Frameworkツールキット
    • UTF JUnit Reportライブラリ―このライブラリは、JKI VI Package Manager (VIPM) ソフトウェアを使用してインストールします。
  3. マイ コンピュータを右クリックして新規»クラスを選択します。
  4. 新規クラスウィンドウで、AddTwoNumbersなどのクラス名を指定します。クラス名は、作成する操作の名前です。
  5. プロジェクトツリーで、作成したクラスを右クリックし、プロパティを選択します。
  6. 継承ページで、親クラスを変更をクリックします。
  7. CoreOperation.lvclassを選択し、選択されたものから継承をクリックし、最後にOKをクリックします。

パート2: 操作の動作を定義する

操作の動作を定義するには、前のセクションで作成したクラスのメソッドをオーバーライドし、オーバーライドされたメソッドの1つにコードを追加する必要があります。

操作の動作を定義するには、次のステップを実行します。

  1. プロジェクトツリーで、前のセクションで作成したクラスを右クリックし、新規»オーバーライドのためのVIを選択します。
  2. 新規オーバーライドウィンドウで、GetHelp.vi とRunOperation.viを選択してOKをクリックします。
  3. プロジェクトを保存します。プロンプトが表示されたら、操作と同じ名前のフォルダにクラスとオーバーライドされたメソッドを保存します。
    メモ NIは、操作の実行中に−AdditionalOperationDirectory引数を使用してフォルダパスを指定しなくてもいいように、以下のディレクトリのいずれかにフォルダを置くことを推奨します。
    • (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. RunOperation.viメソッドのブロックダイアグラムを開きます。
  5. サブVIを削除して再配線します。
  6. 操作の動作を定義するコードを追加し、変更を保存します。次の図に示されているように、コネクタペーンを変更しないでください。
    端子データタイプ説明
    前のセクションで作成したクラスのLabVIEWオブジェクト。
    この操作の実行時にユーザがLabVIEW用CLIで入力する引数。配列内の各文字列は引数を表します。
    前のセクションで作成したクラスのLabVIEWオブジェクト。
    LabVIEW用CLIが呼び出しアプリケーション (Jenkinsアプリケーションなど) に返すコード。たとえば、操作が正常に実行された場合に0、エラーが発生した場合に-1を返すようにLabVIEW用CLIを構成できます。
    操作の出力またはLabVIEW用CLIに表示するためまたはログフィルに保存するためのエラーメッセージ。
    2つの入力値を加算して和を出力として返すAddTwoNumbers操作の動作を定義するサンプルについては、以下のいずれかのディレクトリにあるRunOperation.viを参照してください。
    • (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

パート3: 操作のヘルプを定義する

ユーザが操作を使用開始する際のヘルプを提供するため、前のセッションで作成したGetHelp.viメソッドを変更して操作をドキュメント化します。ユーザは、LabVIEWCLI -OperationName < operation name > -Helpコマンドを実行することによりドキュメントにアクセスできます。

以下の手順に従って、操作をドキュメント化します。

  1. プロジェクトツリーからGetHelp.viメソッドを開きます。
  2. フロントパネルで、ヘルプ (Help) という名前の文字列制御器を作成し、この制御器にドキュメントを入力します。
  3. ヘルプ (Help) 制御器を右クリックしてデータ操作→現在の値をデフォルト設定にするを選択し、現在のテキストをこの制御器のデフォルト値として設定します。テキストを編集するたびにこのステップを繰り返し実行します。
  4. ブロックダイアグラムで、サブVIを削除して再配線します。
  5. オブジェクトを次のように配線し (ここで、AddTwoNumbersｈは操作名)、変更を保存します。