Differences

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

--- visual3d:documentation:pipeline:pipeline_commands:get_pipeline_parameter_count [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:pipeline_commands:get_pipeline_parameter_count [2026/04/28 20:56] (current) – [Command Syntax] wikisysop
@@ Line 1: / Line 1: @@
-get a count of the number of parameter values in a parameter.
+====== Get Pipeline Parameter Count ======
+This command allows users to easily access how many values are contained within a previously defined pipeline parameter.
-**get_pipeline_parameter_count**
+===== Command Syntax =====
-/parameter_name=
+The command can be found in the Pipeline Workshop within the Pipeline Control folder as so:
-/parameter_value=
+<code>
-**;**
+Get_Pipeline_Parameter_Count
-\\
+/PARAMETER_NAME=
+! /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
-**;**
+/PARAMETER_NAME=TEST_PARAMETER
-**get_pipeline_parameter_count**
+/PARAMETER_VALUE=ONE+TWO+THREE
-/parameter_name=count
+! /PARAMETER_VALUE_SEARCH_FOR=
-/parameter_value=::test_parameter
+! /PARAMETER_VALUE_REPLACE_WITH=
-**;**
+! /PARAMETER_VALUE_PREFIX=
-the results from executing these two command is:
+! /PARAMETER_VALUE_APPEND=
+;
+</code>
----------------------------------------------------------------------------
+::TEST_PARAMETER = ONE+TWO+THREE
-**set_pipeline_parameter**
-/parameter_name=test_parameter
-/parameter_value=one+two+three
-! /parameter_value_search_for=
-! /parameter_value_replace_with=
-! /parameter_value_prefix=
-! /parameter_value_append=
-**;**
-pipeline parameter :
-::test_parameter = one+two+three
----------------------------------------------------------------------------
-**get_pipeline_parameter_count**
-/parameter_name=count
-/parameter_value=one+two+three
-**;**
-::count = 3
-===== example2 =====
-**set_pipeline_parameter_to_list_of_signal_names**
+<code>
-/parameter_name=targets
+Get_Pipeline_Parameter_Count
-/signal_type=target
+/PARAMETER_NAME=COUNT
-signal_folder=original
+/PARAMETER_VALUE=ONE+TWO+THREE
-**;**
+;
-**get_pipeline_parameter_count**
+</code>
-/parameter_name=count
-/parameter_value=::targets
-**;**
-for this specific test file the results are:
-\\
+::COUNT = 3
+==== 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]].
-**set_pipeline_parameter_to_list_of_signal_names**
-/parameter_name=targets
+<code>
-/signal_type=target
+Set_Pipeline_Parameter_To_List_Of_Signal_Names
-! /signal_folder=original
+/PARAMETER_NAME=TARGETS
-**;**
+/SIGNAL_TYPE=TARGET
-targets=
+SIGNAL_FOLDER=ORIGINAL
-las
+;
-lpp
+</code>
-lps
-lth1
+TARGETS = LAS+LPP+LPS+LTH1+LTH2+LTH3+LTH4+RAS+RPP+RPS+RTH1+RTH2+RTH3+RTH4
-lth2
-lth3
+<code>
-lth4
+Get_Pipeline_Parameter_Count
-ras
+/PARAMETER_NAME=COUNT
-rpp
+/PARAMETER_VALUE=::TARGETS
-rps
+;
-rth1
+</code>
-rth2
-rth3
+::COUNT = 14
-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