composite:scope_generator
Version: 0.0.0
Description
Generator operator that returns an element chunk each time generator_counteris modified until all elements have been handled.
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required | generator_counter | int32 | Increment this input to get the next element scope for output element_scoping . |
| Pin 1 | element_scoping | scoping | Element scoping |
| Pin 3 | stream_provider | streams_container | stream_provider of the result file. Required if no explicit element scope is providedor the result definition contains Named Selections. |
| Pin 4 | data_sources | data_sources | Composite data sources |
| Pin 402 | data_tree | abstract_data_tree | Configuration containing the following keys: max_chunk_size (int) and named_selections ([string])) |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | element_scoping | scoping | Element scoping for current chunk. |
| Pin 1 | is_finished | bool | Returns true if generator has returned all the requested elements. In this case the output of pin element_scoping is empty. |
Configurations
| Name | Expected type(s) | Default value | Description |
|---|---|---|---|
| mutex | bool | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
Scripting
Category: composite
Plugin: composite
Scripting name: scope_generator
Full name: composite.scope_generator
Internal name: composite::scope_generator
License: None
Changelog
- Version 0.0.0: Initial release.