Class TimeSeriesCollection

Namespace

BlueM.Wave

Assembly

Wave.dll

Collection of TimeSeries Implemented as an ordered dictionary with Ids as keys and TimeSeries as values

public class TimeSeriesCollection : IDictionary<int, TimeSeries>, ICollection<KeyValuePair<int, TimeSeries>>, IEnumerable<KeyValuePair<int, TimeSeries>>, IEnumerable

Inheritance

object

TimeSeriesCollection

Implements

IDictionary<int, TimeSeries>

ICollection<KeyValuePair<int, TimeSeries>>

IEnumerable<KeyValuePair<int, TimeSeries>>

IEnumerable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

TimeSeriesCollection()

public TimeSeriesCollection()

Properties

ToList

Gets a List(Of TimeSeries) containing the TimeSeries in the TimeSeriesCollection

public List<TimeSeries> ToList { get; }

Property Value

List<TimeSeries>

A List(Of TimeSeries) containing the TimeSeries in the TimeSeriesCollection

Methods

Add(TimeSeries)

Adds a TimeSeries to the TimeSeriesCollection

public void Add(TimeSeries ts)

Parameters

ts TimeSeries

The TimeSeries to add

Reorder(List<int>)

Reorders the TimeSeries contained in the TimeSeriesCollection according to the specified list of Ids

public void Reorder(List<int> ids)

Parameters

ids List<int>

List of Ids in the new order

Reorder(int, Direction)

Reorders a TimeSeries within the collection

public void Reorder(int id, Helpers.Direction direction)

Parameters

id int

Id of the TimeSeries to reorder

direction Helpers.Direction

Direction

Explicit Interface Implementations

Add(KeyValuePair<int, TimeSeries>)

void Add(KeyValuePair<int, TimeSeries> item)

Parameters

item KeyValuePair<int, TimeSeries>

Add(int, TimeSeries)

Adds a TimeSeries with the provided Id to the TimeSeriesCollection

void Add(int Id, TimeSeries ts)

Parameters

Id int

The Id of the Timeseries to add

ts TimeSeries

The TimeSeries to add

Clear()

Revomes all TimeSeries from the TimeSeriesCollection

void Clear()

Contains(KeyValuePair<int, TimeSeries>)

bool Contains(KeyValuePair<int, TimeSeries> item)

Parameters

item KeyValuePair<int, TimeSeries>

Returns

bool

ContainsId(int)

Determines whether the TimeSeriesCollection contains a TimeSeries with the specified Id

bool ContainsId(int Id)

Parameters

Id int

The Id to locate in the TimeSeriesCollection

Returns

bool

True if the TimeSeriesCollection contains a TimeSeries with the Id; otherwise, False

CopyTo(KeyValuePair<int, TimeSeries>[], int)

void CopyTo(KeyValuePair<int, TimeSeries>[] array, int arrayIndex)

Parameters

array KeyValuePair<int, TimeSeries>[]

arrayIndex int

Count

Gets the number of TimeSeries contained in the TimeSeriesCollection

int Count { get; }

Returns

int

The number of TimeSeries contained in the TimeSeriesCollection

GetEnumerator()

Returns an enumerator that iterates through the TimeSeriesCollection

IEnumerator<KeyValuePair<int, TimeSeries>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<int, TimeSeries>>

An enumerator that can be used to iterate through the TimeSeriesCollection

Ids

Gets an ICollection(Of Integer) containing the Ids in the TimeSeriesCollection

ICollection<int> Ids { get; }

Returns

ICollection<int>

An ICollection(Of Integer) containing the Ids in the TimeSeriesCollection

IsReadOnly

Gets a value indicating whether the TimeSeriesCollection is read-only

bool IsReadOnly { get; }

Returns

bool

True if the TimeSeriesCollection is read-only; otherwise, False

this[int]

Gets or sets the TimeSeries with the specified Id

TimeSeries this[int Id] { get; set; }

Parameters

Id int

The Id of the TimeSeries to get or set

Returns

TimeSeries

The TimeSeries with the specified Id

Remove(KeyValuePair<int, TimeSeries>)

bool Remove(KeyValuePair<int, TimeSeries> item)

Parameters

item KeyValuePair<int, TimeSeries>

Returns

bool

Remove(int)

Removes the TimeSeries with the specified Id from the TimeSeriesCollection

bool Remove(int Id)

Parameters

Id int

The Id of the TimneSeries to remove

Returns

bool

True if the TimeSeries is successfully removed; otherwise, False

TryGetTimeSeries(int, ref TimeSeries)

Gets the TimeSeries associated with the specified Id

bool TryGetTimeSeries(int Id, ref TimeSeries ts)

Parameters

Id int

The Id of the TimeSeries to get

ts TimeSeries

When this method returns, the TimeSeries associated with the specified Id, if the Id is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

bool

True if the TimeSeriesCollection contains a TimeSeries with the specified Id; otherwise False

Values

Gets an ICollection(Of TimeSeries) containing the TimeSeries in the TimeSeriesCollection

ICollection<TimeSeries> Values { get; }

Returns

ICollection<TimeSeries>

An ICollection(Of TimeSeries) containing the TimeSeries in the TimeSeriesCollection