DataSetCollection Class
A strongly typed collection of DataSet elements that can be accessed by index.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class DataSetCollection : EngineObject,
IList< DataSet >Remarks
The DataSetCollection class is a collection that is implemented inside the Carmenta Engine kernel. It is implemented as an array whose size is dynamically increased as required.
Carmenta Engine collections that hold reference types can not hold null values. Attempts to insert a null reference (Nothing in Visual Basic or None in Python) will result in an exception.
Performance Considerations
The DataSetCollection class is implemented inside the Carmenta Engine kernel which introduces an extra cost when it is accessed compared to when a native API collection is accessed. This means that it is to your advantage to use the collections provided by the native API when you intend to hold references to Carmenta Engine objects and work with them in your application and only explicitly instantiate a Carmenta Engine collection when you create an instance of a Carmenta Engine class that can take ownership of the collection. For example, the LineGeometry class has a constructor that takes a PointCollection which the new LineGeometry instance will take ownership of.
For every method in Carmenta Engine that takes a Carmenta Engine collection as a parameter there exists an overload that takes the native API representation.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
DataSetCollection
Platforms
Windows, Linux, Android
DataSetCollection Members
The DataSetCollection type has the following members.
Constructors
| Name | Description |
|---|---|
| DataSetCollection | Initializes a new instance of the DataSetCollection class. |
Properties
| Name | Description |
|---|---|
| Count | Gets the number of items in the collection. |
| IsDisposed | Gets a value that tells whether the current DataSetCollection has been disposed. Inherited from EngineObject |
| IsReadOnly | Gets a value indicating whether the collection is read-only. |
| Item | Gets or sets the element at the specified index. |
| NativeHandle | Gets the native Carmenta Engine kernel object the current DataSetCollection represents. Inherited from EngineObject |
Methods
| Name | Description |
|---|---|
| Add | Adds an object to the end of the collection. |
| AddRange | Overloaded. Adds the contents of another collection to the end of this collection. |
| Clear | Removes all elements from the collection. |
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Contains | Determines whether the collection contains the specified element. |
| CopyTo | Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. |
| Count | Gets the number of items in the collection. |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| GetEnumerator | Returns an enumerator that iterates through the collection. |
| IndexOf | Tries to find the index of the first occurrence of a value in the collection. |
| Insert | Inserts an element into the collection at the specified index. |
| Remove | Removes the first occurrence of the specified object from the collection. |
| RemoveAt | Removes the element at the specified index of the collection. |
| Reserve | Preallocates space in the internal kernel array to avoid unnecessary memory reallocations. |