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:06] – removed 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 ======
+This command allows users to easily access how many values are contained within a previously defined pipeline parameter.
+===== Command Syntax =====
+The command can be found in the Pipeline Workshop within the Pipeline Control folder as so:
+<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:
+^ **Parameter**  ^ **Description** ^
+|**Parameter Name**|Name of the parameter generated, which contains the count.|
+|**Parameter Value**|List whose items we want to count.|
+===== Examples =====
+==== Example: Create List Parameter and Count Values ====
+Create a parameter with three values, then retrieve the count:
+<code>
+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=
+;
+</code>
+::TEST_PARAMETER = ONE+TWO+THREE
+<code>
+Get_Pipeline_Parameter_Count
+/PARAMETER_NAME=COUNT
+/PARAMETER_VALUE=ONE+TWO+THREE
+;
+</code>
+::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]].
+<code>
+Set_Pipeline_Parameter_To_List_Of_Signal_Names
+/PARAMETER_NAME=TARGETS
+/SIGNAL_TYPE=TARGET
+SIGNAL_FOLDER=ORIGINAL
+;
+</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
+;
+</code>
+::COUNT = 14