Skip to content

ConcatEnumerator

QuantConnect.Lean.Engine.DataFeeds.Enumerators.ConcatEnumerator

ConcatEnumerator(
    skip_duplicate_end_times: bool,
    *enumerators: Union[
        IEnumerator[BaseData],
        Iterable[IEnumerator[BaseData]],
    ]
)

Bases: Object, IEnumerator[BaseData]

Enumerator that will concatenate enumerators together sequentially enumerating them in the provided order

Creates a new instance

Parameters:

Name Type Description Default
skip_duplicate_end_times bool

True will skip data points from enumerators if before or at the last end time

required
enumerators Union[IEnumerator[BaseData], Iterable[IEnumerator[BaseData]]]

The sequence of enumerators to concatenate. Note that the order here matters, it will consume enumerators and dispose of them, even if they return true and their current is null, except for the last which will be kept!

()

current

current: BaseData

The current BaseData object

can_emit_null

can_emit_null: bool

True if emitting a null data point is expected

dispose

dispose() -> None

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

move_next

move_next() -> bool

Advances the enumerator to the next element of the collection.

Returns:

Type Description
bool

True if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

reset

reset() -> None

Sets the enumerator to its initial position, which is before the first element in the collection.