| **Input Banks** | `\1` |
| **Output Banks** | `\1` |
| Name | Type | Description |
|---|---|---|
| `\1` | `\2` | \3 |
+
| Type | How to handle the results |
|---|---|
| **Filter** |
-The involved banks will be filtered.
-To iterate over _filtered_ bank rows, use the function `hipo::bank::getRowList`,
-rather than iterating from `0` up to `hipo::bank::getRows()`; for example, given a
-bank object named `particle_bank`:
+The involved banks will be filtered. To iterate over _filtered_ bank rows, use
+the function `hipo::bank::getRowList`, rather than iterating from `0` up to
+`hipo::bank::getRows()`.
+ +For example, given a bank object named `particle_bank`: ```cpp for(auto const& row : particle_bank.getRowList()) { // loops over only the rows which pass the filter @@ -150,24 +144,32 @@ for(int row = 0; row < particle_bank.getRows(); row++) { ``` |
| **Transformer** |
-The transformed `hipo::bank` will simply have
-the relevant bank elements changed. For example, momentum correction algorithms
-typically change the particle momentum components.
+The transformed `hipo::bank` will simply have the relevant bank elements changed.
+ +For example, momentum correction algorithms typically change the particle momentum components. |
| **Creator** |
-Creator-type algorithms will simply create a new `hipo::bank` object, appending
-it to the end of the input `hipo::banklist`. An initial version is created upon calling
-iguana::Algorithm::Start(hipo::banklist&), so that you may begin to reference it; it is helpful to
-use `hipo::getBanklistIndex` (see [the examples for details](#mainpageExample)).
+Creator-type algorithms will create a new `hipo::bank` object, appending
+it to the end of the input `hipo::banklist`.
+
|
clas12root, a version newer than 1.8.6?"}}:::dec
+ hipo_cpp{{"Do you use the HIPO C++ API directly, e.g., hipo::bank objects?"}}:::dec
+ hipo_cppyy{{"Do you use cppyy bindings to the HIPO C++ API? (see our Python examples)"}}:::dec
+ hipo_banklist{{"Do you use hipo::banklist?"}}:::dec
+
+ %% function nodes
+ %% common function nodes are prefixed with c_
+ %% action function nodes are prefixed with a_
+ subgraph "before events"
+ c_start_no_arg["Start()"]:::cftn
+ c_start_banklist["Start(banklist)"]:::cftn
+ a_start["Start()"]:::aftn
+ end
+ subgraph "for each event"
+ c_run_banks["Run(bank1, bank2, ...)"]:::cftn
+ c_run_banklist["Run(banklist)"]:::cftn
+ a_action["call action function(s)"]:::aftn
+ end
+ subgraph " after events"
+ stop["Stop()"]:::sftn
+ end
+ todo["Not yet supported"]:::lang
+ fortran_note["You will be using C wrapper functions (see documentation)"]:::lang
+
+ %% edges
+ language ==> cpp ===> clas12root
+ language ==> python ===> hipo_cppyy
+ language ==> fortran ===> fortran_note ==> a_start
+ language ==> java ===> todo
+
+ clas12root == | YES | ===> c_start_no_arg
+ clas12root == | NO | ===> hipo_cpp
+
+ hipo_cpp == | YES | ===> hipo_banklist
+ hipo_cpp == | NO | ===> a_start
+
+ hipo_cppyy == | YES | ===> hipo_banklist
+ hipo_cppyy == | NO | ===> a_start
+
+ hipo_banklist == | NO | ===> c_start_no_arg
+ hipo_banklist == | YES | ===> c_start_banklist
+
+ c_start_no_arg ==> c_run_banks ==> stop
+ c_start_banklist ==> c_run_banklist ==> stop
+ a_start ==> a_action ==> stop
+
+
diff --git a/doc/gen/mermaid/flowchart_usage.png b/doc/gen/mermaid/flowchart_usage.png
new file mode 100644
index 000000000..aff2faf1b
Binary files /dev/null and b/doc/gen/mermaid/flowchart_usage.png differ
diff --git a/examples/iguana_ex_cpp_00_run_functions.cc b/examples/iguana_ex_cpp_00_run_functions.cc
index f5758560d..8bb100335 100644
--- a/examples/iguana_ex_cpp_00_run_functions.cc
+++ b/examples/iguana_ex_cpp_00_run_functions.cc
@@ -1,7 +1,12 @@
/// @begin_doc_example{cpp}
/// @file iguana_ex_cpp_00_run_functions.cc
-/// @brief Example using **full HIPO banks** with Iguana algorithms' `Run` functions. This example requires the
-/// user to have the C++ `hipo::bank` objects; see other examples if you do not have banks in this format.
+/// @brief Example using **full HIPO banks** with Iguana algorithms' `Run` functions, using `hipo::banklist`
+///
+/// This example requires the user to have the C++ `hipo::banklist` objects, which are lists of `hipo::bank` objects.
+///
+/// - see `iguana_ex_cpp_00_run_functions_with_banks.cc` if you prefer just `hipo::bank` objects, rather than `hipo::banklist`
+/// - see other examples if you do not have `hipo::bank` objects
+///
/// @par Usage
/// ```bash
/// iguana_ex_cpp_00_run_functions [HIPO_FILE] [NUM_EVENTS]
@@ -55,11 +60,14 @@ int main(int argc, char** argv)
// start the algorithms
seq.Start(banks);
+ // get the name of newly created banks (or you can just get them from the documentation)
+ auto sector_finder_bank_name = seq.GetCreatedBankName("clas12::SectorFinder");
+
// get bank index, for each bank we want to use after Iguana algorithms run
// NOTE: new banks from creator algorithms are initialized by `Start`
auto b_config = hipo::getBanklistIndex(banks, "RUN::config");
auto b_particle = hipo::getBanklistIndex(banks, "REC::Particle");
- auto b_sector = hipo::getBanklistIndex(banks, "REC::Particle::Sector"); // new created bank
+ auto b_sector = hipo::getBanklistIndex(banks, sector_finder_bank_name); // new created bank
// run the algorithm sequence on each event
int iEvent = 0;
diff --git a/examples/iguana_ex_cpp_00_run_functions_with_banks.cc b/examples/iguana_ex_cpp_00_run_functions_with_banks.cc
new file mode 100644
index 000000000..c781564d3
--- /dev/null
+++ b/examples/iguana_ex_cpp_00_run_functions_with_banks.cc
@@ -0,0 +1,128 @@
+/// @begin_doc_example{cpp}
+/// @file iguana_ex_cpp_00_run_functions_with_banks.cc
+/// @brief Example using **full HIPO banks** with Iguana algorithms' `Run` functions, using `hipo::bank`
+///
+/// This example requires the user to have the C++ `hipo::bank` objects.
+///
+/// - see `iguana_ex_cpp_00_run_functions.cc` if you prefer `hipo::banklist`
+/// - see other examples if you do not have `hipo::bank` objects
+///
+/// @par Usage
+/// ```bash
+/// iguana_ex_cpp_00_run_functions_with_banks [HIPO_FILE] [NUM_EVENTS]
+///
+/// HIPO_FILE the HIPO file to analyze
+///
+/// NUM_EVENTS the number of events to analyze;
+/// set to zero to analyze all events
+/// ```
+/// @end_doc_example
+
+#include