Class Sample

Namespace

Bonsai.Reactive

Assembly

Bonsai.Core.dll

Represents an operator that samples elements from an observable sequence whenever the second sequence emits a notification.

Sample always emits the most recent element received from the source sequence. If multiple elements are received between sampling events, all but the latest element will be dropped from the result sequence. Conversely, elements are never repeated: if no new elements are received between two sampling events, no notifications will be emitted.

Note

If the sampler sequence completes successfully, the termination event will be used to sample the latest element from the source sequence, if it exists.

Example

Use Sample to extract elements from a source sequence based on triggers from another sequence.

Alternative

Use SampleInterval to extract elements based on time.

Use Zip to extract elements from a source sequence where all elements are available up front.

[Combinator]
public class Sample

Inheritance

object

Sample

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

Process<TSource, TOther>(IObservable<TSource>, IObservable<TOther>)

Samples elements from the first sequence whenever the second sequence emits a notification.