Lean  $LEAN_TAG$
QuantConnect.Util.CircularQueue< T > Class Template Reference

A never ending queue that will dequeue and reenqueue the same item More...

Public Member Functions

 CircularQueue (params T[] items)
 Initializes a new instance of the CircularQueue<T> class More...
 
 CircularQueue (IEnumerable< T > items)
 Initializes a new instance of the CircularQueue<T> class More...
 
Dequeue ()
 Dequeues the next item More...
 

Protected Member Functions

virtual void OnCircleCompleted ()
 Event invocator for the CircleCompleted evet More...
 

Events

EventHandler CircleCompleted
 Fired when we do a full circle More...
 

Detailed Description

A never ending queue that will dequeue and reenqueue the same item

Definition at line 24 of file CircularQueue.cs.

Constructor & Destructor Documentation

◆ CircularQueue() [1/2]

QuantConnect.Util.CircularQueue< T >.CircularQueue ( params T[]  items)

Initializes a new instance of the CircularQueue<T> class

Parameters
itemsThe items in the queue

Definition at line 38 of file CircularQueue.cs.

◆ CircularQueue() [2/2]

QuantConnect.Util.CircularQueue< T >.CircularQueue ( IEnumerable< T >  items)

Initializes a new instance of the CircularQueue<T> class

Parameters
itemsThe items in the queue

Definition at line 47 of file CircularQueue.cs.

Member Function Documentation

◆ Dequeue()

T QuantConnect.Util.CircularQueue< T >.Dequeue ( )

Dequeues the next item

Returns
The next item

Definition at line 67 of file CircularQueue.cs.

Here is the call graph for this function:

◆ OnCircleCompleted()

virtual void QuantConnect.Util.CircularQueue< T >.OnCircleCompleted ( )
protectedvirtual

Event invocator for the CircleCompleted evet

Definition at line 81 of file CircularQueue.cs.

Here is the caller graph for this function:

Event Documentation

◆ CircleCompleted

EventHandler QuantConnect.Util.CircularQueue< T >.CircleCompleted

Fired when we do a full circle

Definition at line 32 of file CircularQueue.cs.


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