Differences

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

--- visual3d:documentation:pipeline:signal_commands:rename_signals [2024/06/19 12:53] – 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 a signal in the workspace.
+====== Rename Signals ======
-**rename_signals**
+As the name suggests, the Rename_Signal command allows users to rename signals in the workspace.
-/file_name**=**
-/[[visual3d:documentation:pipeline:general_information:signal_types|signal_types]]=
-/[[visual3d:documentation:pipeline:general_information:signal_names|signal_names]]=
-/[[visual3d:documentation:pipeline:general_information:signal_folder|signal_folder]]=
-/new_signal_name=
-! /append_to_old_signal_name=false
-/include_calfile=false;
-**;**
-===== example: rename a derived signal in all files including calfiles =====
-**rename_signals**
+<code>
-/file_name=*.c3d
+Rename_Signals
-/signal_types=derived
+/FILE_NAME=
-/signal_names=derived1
+/Signal_Types=
-/signal_folder=processed
+/Signal_Names=
-/new_signal_name=derived2
+/Signal_Folder=
-! /append_to_old_signal_name=false
+/NEW_SIGNAL_NAME=
-/include_calfile=true
+! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
-**;**
+/INCLUDE_CALFILE=FALSE
-===== example: rename a signal in the global workspace =====
+;
+</code>
-method1 - make the global workspace active
+===== Examples =====
-**rename_signals**
+==== Example 1: Renaming multiple 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
-**;**
-method2 - add a prefix to the signal name indicating that it is global
-**rename_signals**
+Multiple signals can be renamed with a single command by concatening "original" and "new" signal names with the + character.
-/file_name=
-/signal_types=p2d
+<code>
-/signal_names=global::oldname
+Rename_Signals
-/signal_folder=original
+/FILE_NAME=*.c3d
-/new_signal_name=newname
+/SIGNAL_TYPES=TARGET
-/append_to_old_signal_name=false
+/SIGNAL_FOLDER=ORIGINAL
-/include_calfile=false
+/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>