Table of Contents

Class TempoMap

Namespace
ChartTools
Assembly
ChartTools.dll

Set of tempo markers that handles synchronism of anchored tempos.

public class TempoMap : IList<Tempo>, ICollection<Tempo>, IEnumerable<Tempo>, IEnumerable
Inheritance
TempoMap
Implements
Inherited Members
Extension Methods

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

this[int]

Gets or sets the element at the specified index.

public Tempo this[int index] { get; set; }

Parameters

index int

The zero-based index of the element to get or set.

Property Value

Tempo

The element at the specified index.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The property is set and the IList<T> is read-only.

Synchronized

Indicates if all anchored markers are synchronized.

public bool Synchronized { get; }

Property Value

bool

Methods

Add(Tempo)

Adds an item to the ICollection<T>.

public void Add(Tempo item)

Parameters

item Tempo

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

AddRange(IEnumerable<Tempo>)

public void AddRange(IEnumerable<Tempo> items)

Parameters

items IEnumerable<Tempo>

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Clear(bool)

public void Clear(bool detachMap)

Parameters

detachMap bool

Contains(Tempo)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(Tempo item)

Parameters

item Tempo

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(Tempo[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(Tempo[] array, int arrayIndex)

Parameters

array Tempo[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<Tempo> GetEnumerator()

Returns

IEnumerator<Tempo>

An enumerator that can be used to iterate through the collection.

IndexOf(Tempo)

Determines the index of a specific item in the IList<T>.

public int IndexOf(Tempo item)

Parameters

item Tempo

The object to locate in the IList<T>.

Returns

int

The index of item if found in the list; otherwise, -1.

Insert(int, Tempo)

Inserts an item to the IList<T> at the specified index.

public void Insert(int index, Tempo item)

Parameters

index int

The zero-based index at which item should be inserted.

item Tempo

The object to insert into the IList<T>.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

InsertRange(int, IEnumerable<Tempo>)

public void InsertRange(int index, IEnumerable<Tempo> items)

Parameters

index int
items IEnumerable<Tempo>

Remove(Tempo)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(Tempo item)

Parameters

item Tempo

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Remove(Tempo, bool)

public bool Remove(Tempo item, bool detachMap)

Parameters

item Tempo
detachMap bool

Returns

bool

RemoveAt(int)

Removes the IList<T> item at the specified index.

public void RemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

RemoveAt(int, bool)

public void RemoveAt(int index, bool detachMap)

Parameters

index int
detachMap bool

Synchronize(uint, bool)

Synchronizes anchored markers by calculating their tick position.

public void Synchronize(uint resolution, bool desyncedPreOrdered = false)

Parameters

resolution uint
desyncedPreOrdered bool

Exceptions

Exception