:CONFigure:CGENerator:REName

Flex Apps:
FlexOTO
FlexOTO Instance:
Hardware Diagram
Clock Generator Commands

Command Syntax

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

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

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

Description

Renames an Clock Generator block in the Hardware Diagram to a custom name. For example, "System Clock". The default user name for a Clock Generator is "Clock Gen #", where the "#" character is an integer. FlexOTO increments and appends the integer to the default name using the same integer series for Clock Generators.

Use the <new-name> argument to enter a custom name for a Clock Generator. 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).

Requires FlexDCA revision A.07.80 and above.

Example Command

hwdiagram.write(':CONFigure:CGENerator:REName "Clock Generator", "System Clock"')