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

Inheritance diagram for QuantConnect.Indicators.IReadOnlyWindow< out out T >:

Properties
int	Size `[get]`
	Gets the size of this window More...

int	Count `[get]`
	Gets the current number of elements in this window More...

int	Samples `[get]`
	Gets the number of samples that have been added to this window over its lifetime More...

T	this[int i] `[get]`
	Indexes into this window, where index 0 is the most recently entered value More...

bool	IsReady `[get]`
	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 More...

T	MostRecentlyRemoved `[get]`
	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. More...

Detailed Description

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

Template Parameters

T	The type of data in the window

Definition at line 24 of file IReadOnlyWindow.cs.

Property Documentation

◆ Size

int QuantConnect.Indicators.IReadOnlyWindow< out out T >.Size

get

Gets the size of this window

Definition at line 29 of file IReadOnlyWindow.cs.

◆ Count

int QuantConnect.Indicators.IReadOnlyWindow< out out T >.Count

get

Gets the current number of elements in this window

Definition at line 34 of file IReadOnlyWindow.cs.

◆ Samples

int QuantConnect.Indicators.IReadOnlyWindow< out out T >.Samples

get

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

Definition at line 39 of file IReadOnlyWindow.cs.

◆ this[int i]

T QuantConnect.Indicators.IReadOnlyWindow< out out T >.this[int i]

get

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

Parameters

i	the index, i

Returns: the ith most recent entry

Definition at line 47 of file IReadOnlyWindow.cs.

◆ IsReady

bool QuantConnect.Indicators.IReadOnlyWindow< out out T >.IsReady

get

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

Definition at line 53 of file IReadOnlyWindow.cs.

◆ MostRecentlyRemoved

T QuantConnect.Indicators.IReadOnlyWindow< out out T >.MostRecentlyRemoved

get

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.

Definition at line 60 of file IReadOnlyWindow.cs.

The documentation for this interface was generated from the following file:

Common/Indicators/IReadOnlyWindow.cs

Properties