Differences

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

--- visual3d:documentation:pipeline:signal_commands:rename_signals [2024/06/17 18:23] – created 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 =====
-Rename a signal in the Workspace.
+==== Example 1: Renaming multiple signals ====
-**Rename_Signals**
+Multiple signals can be renamed with a single command by concatening "original" and "new" signal names with the + character.
-/FILE_NAME**=**
-/[[Visual3D:Documentation:Pipeline:General_Information:Signal_Types|Signal_Types]]=
+<code>
-/[[Visual3D:Documentation:Pipeline:General_Information:Signal_Names|Signal_Names]]=
+Rename_Signals
-/[[Visual3D:Documentation:Pipeline:General_Information:Signal_Folder|Signal_Folder]]=
+/FILE_NAME=*.c3d
-/NEW_SIGNAL_NAME=
+/SIGNAL_TYPES=TARGET
+/SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=lft1+lft2
+/NEW_SIGNAL_NAME=lft1a+lft2a
 ! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
-/INCLUDE_CALFILE=FALSE;
+! /INCLUDE_CALFILE=FALSE
-**;**
+! /CALFILE_ONLY=FALSE
-===== Example: Rename a DERIVED signal in all files including CalFiles =====
+;
+</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.
-**Rename_Signals**
+<code>
+Rename_Signals
 /FILE_NAME=*.c3d
 /SIGNAL_TYPES=DERIVED
@@ Line 24: / Line 47: @@
 ! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
 /INCLUDE_CALFILE=TRUE
-**;**
+;
-===== Example: Rename a signal in the GLOBAL workspace =====
+</code>
-METHOD1 - Make the Global Workspace Active
+==== Example 3: Rename a signal in the GLOBAL workspace ====
-**Rename_Signals**
+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
@@ Line 37: / Line 65: @@
 /APPEND_TO_OLD_SIGNAL_NAME=FALSE
 /INCLUDE_CALFILE=FALSE
-**;**
+;
-METHOD2 - Add a prefix to the signal name indicating that it is GLOBAL
+</code>
-**Rename_Signals**
+=== METHOD 2 - Add a prefix to the signal name indicating that it is GLOBAL ===
+<code>
+Rename_Signals
 /FILE_NAME=
 /SIGNAL_TYPES=P2D
@@ Line 48: / Line 79: @@
 /APPEND_TO_OLD_SIGNAL_NAME=FALSE
 /INCLUDE_CALFILE=FALSE
-**;**
+;
+</code>