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 [2024/12/27 13:46] (current) – [Rename Signals] wikisysop
@@ Line 1: / Line 1: @@
-rename a signal in the workspace.
+====== Rename Signals ======
-**rename_signals**
+Rename a signal 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
+Renaming multiple signals
-**rename_signals**
+<code>
-/file_name=
+Rename_Signals
-/signal_types=p2d
+/FILE_NAME=*.c3d
-/signal_names=oldname
+/SIGNAL_TYPES=TARGET
-/signal_folder=original
+/SIGNAL_FOLDER=ORIGINAL
-/new_signal_name=newname
+/SIGNAL_NAMES=lft1+lft2
-/append_to_old_signal_name=false
+/NEW_SIGNAL_NAME=lft1a+lft2a
-/include_calfile=false
+! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
-**;**
+! /INCLUDE_CALFILE=FALSE
-method2 - add a prefix to the signal name indicating that it is global
+! /CALFILE_ONLY=FALSE
+;
+</code>
+==== Example: Rename a DERIVED signal in all files including CalFiles ====
-**rename_signals**
+<code>
-/file_name=
+Rename_Signals
-/signal_types=p2d
+/FILE_NAME=*.c3d
-/signal_names=global::oldname
+/SIGNAL_TYPES=DERIVED
-/signal_folder=original
+/SIGNAL_NAMES=Derived1
-/new_signal_name=newname
+/SIGNAL_FOLDER=PROCESSED
-/append_to_old_signal_name=false
+/NEW_SIGNAL_NAME=Derived2
-/include_calfile=false
+! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
-**;**
+/INCLUDE_CALFILE=TRUE
+;
+</code>
+==== Example: Rename a signal in the GLOBAL workspace ====
+METHOD1 - 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>
+METHOD2 - 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>