Skip to content

IReadOnlyWindow

QuantConnect.Indicators.IReadOnlyWindow

Bases: Generic[QuantConnect_Indicators_IReadOnlyWindow_T], Iterable[QuantConnect_Indicators_IReadOnlyWindow_T]

Interface type used to pass windows around without worry of external modification

size

size: int

Gets the size of this window

count

count: int

Gets the current number of elements in this window

samples

samples: int

Gets the number of samples that have been added to this window over its lifetime

is_ready

is_ready: bool

Gets a value indicating whether or not this window is ready, i.e, it has been filled to its capacity, this is when the Size==Count

most_recently_removed

most_recently_removed: (
    QuantConnect_Indicators_IReadOnlyWindow_T
)

Gets the most recently removed item from the window. This is the piece of data that just 'fell off' as a result of the most recent add. If no items have been removed, this will throw an exception.

__getitem__

__getitem__(
    i: int,
) -> QuantConnect_Indicators_IReadOnlyWindow_T

Indexes into this window, where index 0 is the most recently entered value

Parameters:

Name Type Description Default
i int

the index, i

required

Returns:

Type Description
QuantConnect_Indicators_IReadOnlyWindow_T

the ith most recent entry.