Class Skip

Namespace

Bonsai.Reactive

Assembly

Bonsai.Core.dll

Represents an operator that bypasses the specified number of elements at the start of an observable sequence and returns the remaining elements.

The Skip operator modifies the source sequence to remove the specified number of elements from the start of the sequence. After the maximum number of elements is received, Skip will then emit the remaining elements in the sequence. Skip can be used to ignore unstable values from the start of a dynamic time series, e.g. to remove the auto-exposure adaptation start of a camera capture sequence.

If the source sequence terminates before the specified number of elements is received, Skip will terminate without emitting any values.

public class Skip : Combinator

Inheritance

object

Combinator

Skip

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Count

Gets or sets the number of elements to skip.

public int Count { get; set; }

Property Value

int

Methods

Process<TSource>(IObservable<TSource>)

Bypasses the specified number of elements at the start of an observable sequence and returns the remaining elements.

public override IObservable<TSource> Process<TSource>(IObservable<TSource> source)

Parameters

source IObservable<TSource>

The sequence to skip elements from.

Returns

IObservable<TSource>

An observable sequence that contains the elements that occur after the skipped elements in the source sequence.

Type Parameters

TSource

The type of the elements in the source sequence.