Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:signal_commands:rename_signals [2024/07/03 17:30] – removed sgranger
+++ visual3d:documentation:pipeline:signal_commands:rename_signals [2025/05/09 20:38] (current) – Added headers. More work needed to bring the page up to pipeline command standard. wikisysop
@@ Line 1: / Line 1: @@
+====== Rename Signals ======
+As the name suggests, the Rename_Signal command allows users to rename signals in the workspace.
+<code>
+Rename_Signals
+/FILE_NAME=
+/Signal_Types=
+/Signal_Names=
+/Signal_Folder=
+/NEW_SIGNAL_NAME=
+! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
+/INCLUDE_CALFILE=FALSE
+;
+</code>
+===== Examples =====
+==== Example 1: Renaming multiple signals ====
+Multiple signals can be renamed with a single command by concatening "original" and "new" signal names with the + character.
+<code>
+Rename_Signals
+/FILE_NAME=*.c3d
+/SIGNAL_TYPES=TARGET
+/SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=lft1+lft2
+/NEW_SIGNAL_NAME=lft1a+lft2a
+! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
+! /INCLUDE_CALFILE=FALSE
+! /CALFILE_ONLY=FALSE
+;
+</code>
+==== Example 2: Rename a DERIVED signal in all files including CalFiles ====
+Signals can be renamed across all files in the workspace by using the * wildcard in the FILE_NAME parameter.
+<code>
+Rename_Signals
+/FILE_NAME=*.c3d
+/SIGNAL_TYPES=DERIVED
+/SIGNAL_NAMES=Derived1
+/SIGNAL_FOLDER=PROCESSED
+/NEW_SIGNAL_NAME=Derived2
+! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
+/INCLUDE_CALFILE=TRUE
+;
+</code>
+==== Example 3: Rename a signal in the GLOBAL workspace ====
+There are two methods for renaming a signal in the [[visual3d:documentation:definitions:global_workspace|GLOBAL workspace]]. The first is to make the GLOBAL workspace active; the second is to prefix the signal name.
+=== METHOD 1 - Make the Global Workspace Active ===
+<code>
+Rename_Signals
+/FILE_NAME=
+/SIGNAL_TYPES=P2D
+/SIGNAL_NAMES=OLDNAME
+/SIGNAL_FOLDER=ORIGINAL
+/NEW_SIGNAL_NAME=NEWNAME
+/APPEND_TO_OLD_SIGNAL_NAME=FALSE
+/INCLUDE_CALFILE=FALSE
+;
+</code>
+=== METHOD 2 - Add a prefix to the signal name indicating that it is GLOBAL ===
+<code>
+Rename_Signals
+/FILE_NAME=
+/SIGNAL_TYPES=P2D
+/SIGNAL_NAMES=GLOBAL::OLDNAME
+/SIGNAL_FOLDER=ORIGINAL
+/NEW_SIGNAL_NAME=NEWNAME
+/APPEND_TO_OLD_SIGNAL_NAME=FALSE
+/INCLUDE_CALFILE=FALSE
+;
+</code>