Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:get_pipeline_parameter_count [2024/06/26 20:28] – created sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:get_pipeline_parameter_count [2026/04/28 20:56] (current) – [Command Syntax] wikisysop
@@ Line 1: / Line 1: @@
-====== Get_Pipeline_Parameter_Count ======
+====== Get Pipeline Parameter Count ======
+This command allows users to easily access how many values are contained within a previously defined pipeline parameter.
-Get a count of the number of parameter values in a parameter.
+===== Command Syntax =====
+The command can be found in the Pipeline Workshop within the Pipeline Control folder as so:
-**Get_Pipeline_Parameter_Count**
+<code>
+Get_Pipeline_Parameter_Count
 /PARAMETER_NAME=
-/PARAMETER_VALUE=
+! /PARAMETER_VALUE=
-**;**
+;
-\\
+</code>
+====Command Parameters====
+The following table shows the command parameters that can be used to define the command and their descriptions:
-==== Example1 ====
+^ **Parameter**  ^ **Description** ^
+|**Parameter Name**|Name of the parameter generated, which contains the count.|
+|**Parameter Value**|List whose items we want to count.|
-Create a parameter with three values, then retrieve the count
+===== Examples =====
+==== Example: Create List Parameter and Count Values ====
-**Set_Pipeline_Parameter**
+Create a parameter with three values, then retrieve the count:
-/PARAMETER_NAME=TEST_PARAMETER
+<code>
-/PARAMETER_VALUE=ONE+TWO+THREE
+Set_Pipeline_Parameter
-**;**
-**Get_Pipeline_Parameter_Count**
-/PARAMETER_NAME=COUNT
-/PARAMETER_VALUE=::TEST_PARAMETER
-**;**
-The results from executing these two command is:
----------------------------------------------------------------------------
-**Set_Pipeline_Parameter**
 /PARAMETER_NAME=TEST_PARAMETER
 /PARAMETER_VALUE=ONE+TWO+THREE
@@ Line 32: / Line 30: @@
 ! /PARAMETER_VALUE_PREFIX=
 ! /PARAMETER_VALUE_APPEND=
-**;**
+;
-Pipeline Parameter :
+</code>
 ::TEST_PARAMETER = ONE+TWO+THREE
----------------------------------------------------------------------------
-**Get_Pipeline_Parameter_Count**
+<code>
+Get_Pipeline_Parameter_Count
 /PARAMETER_NAME=COUNT
 /PARAMETER_VALUE=ONE+TWO+THREE
-**;**
+;
+</code>
 ::COUNT = 3
-==== Example2 ====
-**Set_Pipeline_Parameter_To_List_Of_Signal_Names**
+==== Example: Count Number of Signals in a Folder ====
+More usefully, we might want to count the number of a particular item contained within a file. For example, we may want to know how many [[visual3d:documentation:c3d_signal_types:target_data_type|TARGET]] signals are included in a specific [[visual3d:documentation:c3d_signal_types:c3d_format|C3D file]].
+<code>
+Set_Pipeline_Parameter_To_List_Of_Signal_Names
 /PARAMETER_NAME=TARGETS
 /SIGNAL_TYPE=TARGET
 SIGNAL_FOLDER=ORIGINAL
-**;**
+;
-**Get_Pipeline_Parameter_Count**
+</code>
+TARGETS = LAS+LPP+LPS+LTH1+LTH2+LTH3+LTH4+RAS+RPP+RPS+RTH1+RTH2+RTH3+RTH4
+<code>
+Get_Pipeline_Parameter_Count
 /PARAMETER_NAME=COUNT
 /PARAMETER_VALUE=::TARGETS
-**;**
+;
-For this specific test file the results are:
+</code>
-\\
----------------------------------------------------------------------------
-**Set_Pipeline_Parameter_To_List_Of_Signal_Names**
-/PARAMETER_NAME=TARGETS
-/SIGNAL_TYPE=TARGET
-! /SIGNAL_FOLDER=ORIGINAL
-**;**
-TARGETS=
-LAS
-LPP
-LPS
-LTH1
-LTH2
-LTH3
-LTH4
-RAS
-RPP
-RPS
-RTH1
-RTH2
-RTH3
-RTH4
----------------------------------------------------------------------------
-**Get_Pipeline_Parameter_Count**
-/PARAMETER_NAME=COUNT
-/PARAMETER_VALUE=LAS+LPP+LPS+LTH1+LTH2+LTH3+LTH4+RAS+RPP+RPS+RTH1+RTH2+RTH3+RTH4
-**;**
 ::COUNT = 14