:CONFigure:IMPairment:REName

Flex Apps:
FlexOTO
FlexOTO Instance:
Hardware Diagram
Impairment Commands

Command Syntax

:CONFigure:IMPairment:REName "<current-name>", "<new-name>"

Where <current-name> is the name currently shown on the Impairment block.

Where <new-name> is the new name for the Impairment block.

Description

Renames an Impairment block in the Hardware Diagram to a custom name. For example, "Fiber Spool". Use this string as a <block > name identification argument when connecting the Impairment ports using the :CONfigure:PORT:CONNect command. The default name is "Impairment #" where "#" is an integer from 1 to 8.

Use the <new-name> argument to enter a custom name for a Impairment. The name is limited to 25 characters. If a longer string is entered, only the first 25 characters is used. Valid characters are restricted to the set of characters that can be used when naming files in Windows.

To reset a custom user name to the default name, enter an empty string as the "<new-name>" argument.

The user name is:

  • Displayed on the Hardware Diagram.
  • Used as an argument when connecting ports with :CONfigure:PORT:CONNect command.
  • Listed in a Station's Test Program, Active Jobs, and Job Results.
  • Saved with the Hardware Diagram Setup file (*.setx).
  • Saved with the Job Results file (*.zip).

Example Command

hwdiagram.write(':CONFigure:IMPairment:REName "Impairment 1", "Fiber Spool"')