如需创建自定义命令行操作以在用于LabVIEW的命令行界面(CLI)中运行,请完成以下任务:

第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. 打开Operations.lvprojToolkit-Operations.lvproj,具体取决于操作是仅需要LabVIEW开发系统还是需要附加的LabVIEW模块和工具包。
    注: 如要打开Toolkit-Operations.lvproj,必须安装下列工具包和库:
    • LabVIEW VI Analyzer工具包
    • LabVIEW Unit Test Framework工具包
    • UTF Junit报告库-通过JKI VI Package Manager (VIPM)安装该库。
  3. 右键单击我的电脑并选择新建»类
  4. 新建类窗口中,指定类的名称,例如AddTwoNumbers。类名是您正在创建的操作的名称。
  5. 在项目树中,右键单击您创建的类,然后选择属性
  6. 继承页上,单击修改父类
  7. 选择CoreOperation.lvclass,单击继承所选类,然后单击确定

第2部分:定义操作行为

如需定义操作行为,必须重写在上一节中创建的类的方法,并在其中一个重写的方法中添加代码。

完成下列步骤,定义操作行为。

  1. 在项目树中,右键单击您在上一节中创建的类,然后选择新建»重写VI
  2. 新建重写窗口中,选择GetHelp.viRunOperation.vi,然后单击确定
  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应用程序。例如,您可配置用于LabVIEW的CLI在操作运行成功时返回0,在发生错误时返回-1。
    显示在用于LabVIEW的CLI的控制台或保存至记录文件的操作输出或错误信息。
    关于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是操作名称,然后保存您的更改。