User Tools

Site Tools


visual3d:documentation:pipeline:signal_commands:rename_signals

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
visual3d:documentation:pipeline:signal_commands:rename_signals [2024/07/03 17:43] – created sgrangervisual3d: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 ======+====== Rename Signals ======
  
-Rename a signal in the Workspace.+As the name suggests, the Rename_Signal command allows users to rename signals in the workspace.
  
-**Rename_Signals** +<code> 
-/FILE_NAME**=** +Rename_Signals 
-/[[Visual3D:Documentation:Pipeline:General_Information:Signal_Types|Signal_Types]]+/FILE_NAME= 
-/[[Visual3D:Documentation:Pipeline:General_Information:Signal_Names|Signal_Names]]+/Signal_Types= 
-/[[Visual3D:Documentation:Pipeline:General_Information:Signal_Folder|Signal_Folder]]=+/Signal_Names= 
 +/Signal_Folder=
 /NEW_SIGNAL_NAME= /NEW_SIGNAL_NAME=
 ! /APPEND_TO_OLD_SIGNAL_NAME=FALSE ! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
-/INCLUDE_CALFILE=FALSE; +/INCLUDE_CALFILE=FALSE 
-**;** +
-==== Example: Rename a DERIVED signal in all files including CalFiles ====+</code>
  
-**Rename_Signals**+===== 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 /FILE_NAME=*.c3d
 /SIGNAL_TYPES=DERIVED /SIGNAL_TYPES=DERIVED
Line 22: Line 47:
 ! /APPEND_TO_OLD_SIGNAL_NAME=FALSE ! /APPEND_TO_OLD_SIGNAL_NAME=FALSE
 /INCLUDE_CALFILE=TRUE /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= /FILE_NAME=
 /SIGNAL_TYPES=P2D /SIGNAL_TYPES=P2D
Line 35: Line 65:
 /APPEND_TO_OLD_SIGNAL_NAME=FALSE /APPEND_TO_OLD_SIGNAL_NAME=FALSE
 /INCLUDE_CALFILE=FALSE /INCLUDE_CALFILE=FALSE
-**;** +
-METHOD2 - Add a prefix to the signal name indicating that it is GLOBAL+</code> 
 + 
 +=== METHOD 2 - Add a prefix to the signal name indicating that it is GLOBAL ===
  
-**Rename_Signals**+<code> 
 +Rename_Signals
 /FILE_NAME= /FILE_NAME=
 /SIGNAL_TYPES=P2D /SIGNAL_TYPES=P2D
Line 46: Line 79:
 /APPEND_TO_OLD_SIGNAL_NAME=FALSE /APPEND_TO_OLD_SIGNAL_NAME=FALSE
 /INCLUDE_CALFILE=FALSE /INCLUDE_CALFILE=FALSE
-**;**+; 
 +</code>
  
  
visual3d/documentation/pipeline/signal_commands/rename_signals.1720028639.txt.gz · Last modified: 2024/07/03 17:43 by sgranger