AFCollectionList(T) Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
A generic list of objects that does not have name lookup. This collection can
be a user-defined collection of objects which belong to different objects.
Inheritance Hierarchy
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public class AFCollectionList<T> : AFCollection<T> where T : AFObject
Public Class AFCollectionList(Of T As AFObject) Inherits AFCollection(Of T) Dim instance As AFCollectionList(Of T)
generic<typename T> where T : AFObject public ref class AFCollectionList : public AFCollection<T>
type AFCollectionList<'T when 'T : AFObject> = class inherit AFCollection<'T> end
Type Parameters
- T
- The type of the item in the list must derive from AFObject.
The AFCollectionListT type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFCollectionListT |
Initializes a new instance of the AFCollectionListT collection
without any items.
|
| AFCollectionListT(IEnumerableT) |
Initializes a new instance of the AFCollectionListT collection with
the items in the specified IEnumerableT list.
|
| AFCollectionListT(AFIdentity) |
Initializes a new instance of the AFCollectionListT collection
without any items with the AFIdentity of the items specified.
|
| AFCollectionListT(AFObject) |
Initializes a new instance of the AFCollectionListT collection
with the specified parent and without any items.
|
| AFCollectionListT(AFIdentity, AFObject) |
Initializes a new instance of the AFCollectionListT collection
with the specified parent and without any items with the
AFIdentity of the items specified.
|
| AFCollectionListT(AFIdentity, IEnumerableT) |
Initializes a new instance of the AFCollectionListT collection with
the items in the specified IEnumerableT list with the
AFIdentity of the items specified.
|
Properties
| Name | Description | |
|---|---|---|
 | Count |
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.) |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFCollection.) |
| IsDeleted |
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.) |
| ItemGuid | Returns the item in the collection associated with the passed in ID. (Inherited from AFCollectionT.) |
| ItemInt32 | Returns the item located at the passed in index. (Inherited from AFCollectionT.) |
| ItemIdentity |
This read-only property specifies the identity of the objects within the collection.
(Overrides AFCollectionItemIdentity.) |
| PISystem |
This read-only property allows access to the PISystem
associated with this collection.
(Inherited from AFCollection.) |
Methods
| Name | Description | |
|---|---|---|
| Add |
Adds an object to the end of the collection.
(Inherited from AFCollectionT.) |
| AddRange |
Adds the items of the specified collection to the end of the collection.
|
| AsReadOnly |
Returns a read-only IList{T} wrapper for the current collection.
|
| Clear |
Removes all items from the collection.
(Inherited from AFCollectionT.) |
| Contains(Guid) |
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.) |
| Contains(T) |
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.) |
| CopyTo |
Copies the entire collection to a compatible one-dimensional Array,
starting at the specified index of the target array.
(Inherited from AFCollectionT.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.) |
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Inherited from AFCollection.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf |
Searches for the specified object and returns the zero-based index of the first
occurrence within the entire collection.
(Inherited from AFCollectionT.) |
| Insert |
Inserts an item into the collection at the specified index.
|
| Remove(Guid) |
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.) |
| Remove(T) |
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.) |
| RemoveAt |
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.) |
| Sort |
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.) |
| Sort(IComparerT) |
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.) |
| Sort(Int32, Int32, IComparerT) |
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.) |
| ToString |
Returns a String that represents the current object.
(Inherited from AFCollection.) |
Remarks
This collection can be used to contain a list of unrelated objects. The list
does not support looking up items by name.
This collection is also returned from some of the searching methods
(e.g. AFModelGetConnections).