Skip to content

SynchronizingEnumerator

QuantConnect.Lean.Engine.DataFeeds.Enumerators.SynchronizingEnumerator 

SynchronizingEnumerator(
    *enumerators: Union[
        IEnumerator[
            QuantConnect_Lean_Engine_DataFeeds_Enumerators_SynchronizingEnumerator_T
        ],
        Iterable[
            IEnumerator[
                QuantConnect_Lean_Engine_DataFeeds_Enumerators_SynchronizingEnumerator_T
            ]
        ],
    ]
)

SynchronizingEnumerator(
    enumerators: List[
        IEnumerator[
            QuantConnect_Lean_Engine_DataFeeds_Enumerators_SynchronizingEnumerator_T
        ]
    ],
)

Bases: Generic[QuantConnect_Lean_Engine_DataFeeds_Enumerators_SynchronizingEnumerator_T], Object, IEnumerator[QuantConnect_Lean_Engine_DataFeeds_Enumerators_SynchronizingEnumerator_T]

Represents an enumerator capable of synchronizing other enumerators of type T in time. This assumes that all enumerators have data time stamped in the same time zone

Initializes a new instance of the SynchronizingEnumerator{T} class

Parameters:

Name Type Description Default
enumerators Union[IEnumerator[QuantConnect_Lean_Engine_DataFeeds_Enumerators_SynchronizingEnumerator_T], Iterable[IEnumerator[QuantConnect_Lean_Engine_DataFeeds_Enumerators_SynchronizingEnumerator_T]]]

The enumerators to be synchronized. NOTE: Assumes the same time zone for all data

 ()

current 

current: QuantConnect_Lean_Engine_DataFeeds_Enumerators_SynchronizingEnumerator_T

Gets the element in the collection at the current position of the enumerator.

dispose 

dispose() -> None

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

get_instance_time 

get_instance_time(
    instance: QuantConnect_Lean_Engine_DataFeeds_Enumerators_SynchronizingEnumerator_T,
) -> datetime

Gets the Timestamp for the data

This codeEntityType is protected.

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.