HAS-Motion Software Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== 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>