    

 ## On this page

  

 

 # Class CompareSuite

 Last update: 09.03.2026 

Namespace: [OpenTD.Results.Dataset](OpenTD.Results.Dataset.md)  
Assembly: OpenTD.Results.dll

Use a CompareSuite to test whether multiple pairs of Datasets are equal or not. Tests a set of CompareAssertions and collects the results.

```csharp
public class CompareSuite : IList<CompareAssertion>, ICollection<CompareAssertion>, IEnumerable<CompareAssertion>, IEnumerable

```

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [CompareSuite](OpenTD.Results.Dataset.CompareSuite.md)

## Implements

[IList&lt;CompareAssertion&gt;](https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1), [ICollection&lt;CompareAssertion&gt;](https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1), [IEnumerable&lt;CompareAssertion&gt;](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1), [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.ienumerable)

## Inherited Members

[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring), [object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)), [object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)), [object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), [object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode), [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype), [object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Properties

### Count

Gets the number of elements contained in the .

```csharp
public int Count { get; }

```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### IsReadOnly

Gets a value indicating whether the  is read-only.

```csharp
public bool IsReadOnly { get; }

```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### Log

```csharp
public string Log { get; set; }

```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### Message

```csharp
public string Message { get; }

```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### this\[int\]

Gets or sets the element at the specified index.

```csharp
public CompareAssertion this[int index] { get; set; }

```

#### Property Value

[CompareAssertion](OpenTD.Results.Dataset.CompareAssertion.md)

#### Exceptions

[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)

`index` is not a valid index in the .

[NotSupportedException](https://learn.microsoft.com/dotnet/api/system.notsupportedexception)

The property is set and the  is read-only.

## Methods

### Add(IDataset, IDataset, bool)

```csharp
public void Add(IDataset a, IDataset b, bool assertDatasetsSame)

```

#### Parameters

`a` [IDataset](OpenTD.Results.Dataset.IDataset.md)

`b` [IDataset](OpenTD.Results.Dataset.IDataset.md)

`assertDatasetsSame` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### Add(CompareAssertion)

Adds an item to the .

```csharp
public void Add(CompareAssertion item)

```

#### Parameters

`item` [CompareAssertion](OpenTD.Results.Dataset.CompareAssertion.md)

The object to add to the .

#### Exceptions

[NotSupportedException](https://learn.microsoft.com/dotnet/api/system.notsupportedexception)

The  is read-only.

### Clear()

Removes all items from the .

```csharp
public void Clear()

```

#### Exceptions

[NotSupportedException](https://learn.microsoft.com/dotnet/api/system.notsupportedexception)

The  is read-only.

### Contains(CompareAssertion)

Determines whether the  contains a specific value.

```csharp
public bool Contains(CompareAssertion item)

```

#### Parameters

`item` [CompareAssertion](OpenTD.Results.Dataset.CompareAssertion.md)

The object to locate in the .

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

[true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if `item` is found in the ; otherwise, [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool).

### CopyTo(CompareAssertion\[\], int)

Copies the elements of the  to an , starting at a particular  index.

```csharp
public void CopyTo(CompareAssertion[] array, int arrayIndex)

```

#### Parameters

`array` [CompareAssertion](OpenTD.Results.Dataset.CompareAssertion.md)\[\]

The one-dimensional  that is the destination of the elements copied from . The  must have zero-based indexing.

`arrayIndex` [int](https://learn.microsoft.com/dotnet/api/system.int32)

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

#### Exceptions

[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)

`array` is [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null).

[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)

`arrayIndex` is less than 0.

[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)

The number of elements in the source  is greater than the available space from `arrayIndex` to the end of the destination `array`.

### GetEnumerator()

Returns an enumerator that iterates through the collection.

```csharp
public IEnumerator<CompareAssertion> GetEnumerator()

```

#### Returns

[IEnumerator](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerator-1)&lt;[CompareAssertion](OpenTD.Results.Dataset.CompareAssertion.md)&gt;

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

### IndexOf(CompareAssertion)

Determines the index of a specific item in the .

```csharp
public int IndexOf(CompareAssertion item)

```

#### Parameters

`item` [CompareAssertion](OpenTD.Results.Dataset.CompareAssertion.md)

The object to locate in the .

#### Returns

[int](https://learn.microsoft.com/dotnet/api/system.int32)

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

### Insert(int, CompareAssertion)

Inserts an item to the  at the specified index.

```csharp
public void Insert(int index, CompareAssertion item)

```

#### Parameters

`index` [int](https://learn.microsoft.com/dotnet/api/system.int32)

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

`item` [CompareAssertion](OpenTD.Results.Dataset.CompareAssertion.md)

The object to insert into the .

#### Exceptions

[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)

`index` is not a valid index in the .

[NotSupportedException](https://learn.microsoft.com/dotnet/api/system.notsupportedexception)

The  is read-only.

### Remove(CompareAssertion)

Removes the first occurrence of a specific object from the .

```csharp
public bool Remove(CompareAssertion item)

```

#### Parameters

`item` [CompareAssertion](OpenTD.Results.Dataset.CompareAssertion.md)

The object to remove from the .

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

[true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if `item` was successfully removed from the ; otherwise, [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool). This method also returns [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if `item` is not found in the original .

#### Exceptions

[NotSupportedException](https://learn.microsoft.com/dotnet/api/system.notsupportedexception)

The  is read-only.

### RemoveAt(int)

Removes the  item at the specified index.

```csharp
public void RemoveAt(int index)

```

#### Parameters

`index` [int](https://learn.microsoft.com/dotnet/api/system.int32)

The zero-based index of the item to remove.

#### Exceptions

[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)

`index` is not a valid index in the .

[NotSupportedException](https://learn.microsoft.com/dotnet/api/system.notsupportedexception)

The  is read-only.

### Run()

```csharp
public Tuple<int, int> Run()

```

#### Returns

[Tuple](https://learn.microsoft.com/dotnet/api/system.tuple-2)&lt;[int](https://learn.microsoft.com/dotnet/api/system.int32), [int](https://learn.microsoft.com/dotnet/api/system.int32)&gt;