## On this page

  

 

 # composite:scope\_generator

 Last update: 31.07.2026 

**Version: 0.0.0**

## Description

Generator operator that returns an element chunk each time generator\_counteris modified until all elements have been handled.

## Inputs

InputNameExpected type(s)Description**Pin 0**   
Requiredgenerator\_counter[`int32`](../../core-concepts/dpf-types.md#standard-types)Increment this input to get the next element scope for output element\_scoping .**Pin 1**element\_scoping[`scoping`](../../core-concepts/dpf-types.md#scoping)Element scoping**Pin 3**stream\_provider[`streams_container`](../../core-concepts/dpf-types.md#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`](../../core-concepts/dpf-types.md#data-sources)Composite data sources**Pin 402**data\_tree[`abstract_data_tree`](../../core-concepts/dpf-types.md#data-tree)Configuration containing the following keys: max\_chunk\_size (int) and named\_selections (\[string\]))## Outputs

OutputNameExpected type(s)Description**Pin 0**element\_scoping[`scoping`](../../core-concepts/dpf-types.md#scoping)Element scoping for current chunk.**Pin 1**is\_finished[`bool`](../../core-concepts/dpf-types.md#standard-types)Returns true if generator has returned all the requested elements. In this case the output of pin element\_scoping is empty.## Configurations

NameExpected type(s)Default valueDescription**mutex**[`bool`](../../core-concepts/dpf-types.md#standard-types)falseIf 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.