visual3d:documentation:pipeline:signal_commands:remove_signals
This is an old revision of the document!
Table of Contents
Remove Signals
The Remove_Signals pipeline command allows the user to remove a signal from the data tree.
Pipeline Command
The Remove_Signals command can be found in the pipeline workshop's Signal/Data Management folder:
Remove_Signals /SIGNAL_TYPES= ! /SIGNAL_FOLDER=ORIGINAL ! /SIGNAL_NAMES= ! /INCLUDE_MODELS=FALSE ! /REMOVE_FROM_RECALC_PIPELINE=FALSE ;
Command Parameters
| Parameter | Description |
|---|---|
| Signal Types | The type of signal specified. |
| Signal Folder | The data tree folder specified. Default value is ORIGINAL. |
| Signal Names | The signal names specified. Default value is empty, meaning all signals within Type > Folder. |
| Include Models | If true, then will remove signals from models assigned to the active files. Default value is false. |
| Remove from Recalc Pipeline | If true, then the specified signals are also removed from the Recalc pipeline. Default value is false. |
Example: Remove Signals of Different Types
For example, remove one DERIVED signal and one METRIC from the data tree.
Remove_Signals /SIGNAL_TYPES=DERIVED+METRIC /SIGNAL_NAMES= DERIVED1+METRIC1 /SIGNAL_FOLDER=PROCESSED+PROCESSED ;
This command will have the effect of removing DERIVED::PROCESSED::DERIVED1 and METRIC::PROCESSED::METRIC1 from the data tree.
Example: Remove Link_Model_Based Items from Recalc
For example, remove all LINK_MODEL_BASED items from the Recalc pipeline as well as from the workspace.
Remove_Signals /SIGNAL_TYPES=LINK_MODEL_BASED ! /SIGNAL_FOLDER=ORIGINAL ! /SIGNAL_NAMES= ! /INCLUDE_MODELS=FALSE /REMOVE_FROM_RECALC_PIPELINE=TRUE ;
Notes
Signals can also be removed manually from the data tree via the graphical interface.
visual3d/documentation/pipeline/signal_commands/remove_signals.1788963025.txt.gz · Last modified: by richard