RangeTRange, TState Class

Represents a range of values defined by a start and end value with encapsulated state.

Inheritance Hierarchy

SystemObject
GSFRangeTRange, TState

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.232-beta+203aa83a5a82d50f387e69875549969ad138d6e0

Syntax

C++

JavaScript

Copy

public sealed class Range<TRange, TState>

Public NotInheritable Class Range(Of TRange, TState)

generic<typename TRange, typename TState>
public ref class Range sealed

[<SealedAttribute>]
type Range<'TRange, 'TState> = class end

JavaScript does not support generic types or methods.

View Source

Type Parameters

TRange
TState

The RangeTRange, TState type exposes the following members.

Constructors

	Name	Description
	RangeTRange, TState	Creates a new instance of the RangeTRange, TState class using the default comparer.

Top

Properties

	Name	Description
	End	Gets the end value of the range.
	Start	Gets the start value of the range.
	State	Gets the state encapsulated by the range.

Top

Methods

	Name	Description
	Contains(TRange)	Determines whether the range contains the given value.
	Contains(RangeTRange, TState)	Determines whether the range contains the given range.
	Contains(TRange, IComparerTRange)	Determines whether the range contains the given value.
	Contains(TRange, ComparisonTRange)	Determines whether the range contains the given value.
	Contains(RangeTRange, TState, IComparerTRange)	Determines whether the range contains the given range.
	Contains(RangeTRange, TState, ComparisonTRange)	Determines whether the range contains the given range.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Merge(IEnumerableRangeTRange, TState)	Merges all ranges in a collection of ranges.
	Merge(RangeTRange, TState)	Merges two ranges into one range that fully encompasses both ranges.
	Merge(IEnumerableRangeTRange, TState, ComparerTRange)	Merges all ranges in a collection of ranges.
	Merge(IEnumerableRangeTRange, TState, ComparisonTRange)	Merges all ranges in a collection of ranges.
	Merge(RangeTRange, TState, IComparerTRange)	Merges two ranges into one range that fully encompasses both ranges.
	Merge(RangeTRange, TState, ComparisonTRange)	Merges two ranges into one range that fully encompasses both ranges.
	MergeAllOverlapping(IEnumerableRangeTRange, TState)	Merges all consecutive groups of overlapping ranges in a collection and returns the resulting collection of ranges.
	MergeAllOverlapping(IEnumerableRangeTRange, TState, IComparerTRange)	Merges all consecutive groups of overlapping ranges in a collection and returns the resulting collection of ranges.
	MergeAllOverlapping(IEnumerableRangeTRange, TState, ComparisonTRange)	Merges all consecutive groups of overlapping ranges in a collection and returns the resulting collection of ranges.
	MergeConsecutiveOverlapping(IEnumerableRangeTRange, TState)	Merges all consecutive groups of overlapping ranges in a collection and returns the resulting collection of ranges.
	MergeConsecutiveOverlapping(IEnumerableRangeTRange, TState, IComparerTRange)	Merges all consecutive groups of overlapping ranges in a collection and returns the resulting collection of ranges.
	MergeConsecutiveOverlapping(IEnumerableRangeTRange, TState, ComparisonTRange)	Merges all consecutive groups of overlapping ranges in a collection and returns the resulting collection of ranges.
	Overlaps(RangeTRange, TState)	Determines whether the range overlaps with the given range.
	Overlaps(RangeTRange, TState, IComparerTRange)	Determines whether the range overlaps with the given range.
	Overlaps(RangeTRange, TState, ComparisonTRange)	Determines whether the range overlaps with the given range.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

This class provides flexibility in allowing the user to define their own state and how it is merged. Because of potentially undesirable behavior which could result from merging objects inherited from this class, the class has been sealed to prevent inheritance.

Reference

GSF Namespace