Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

TABLE OF CONTENTS

AFCollection(T) Class

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 7 minute read
AFCollection(T) Class
Provides the abstract base class used for all collections in the AF SDK that are indexed by unique identifier.

Inheritance Hierarchy

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

[SerializableAttribute]
public abstract class AFCollection<T> : AFCollection, 
	IAFList, IList, ICollection, IEnumerable, IList<T>, 
	ICollection<T>, IEnumerable<T>
where T : AFObject

<SerializableAttribute>
Public MustInherit Class AFCollection(Of T As AFObject)
	Inherits AFCollection
	Implements IAFList, IList, ICollection, IEnumerable, 
	IList(Of T), ICollection(Of T), IEnumerable(Of T)

Dim instance As AFCollection(Of T)
[SerializableAttribute]
generic<typename T>
where T : AFObject
public ref class AFCollection abstract : public AFCollection, 
	IAFList, IList, ICollection, IEnumerable, IList<T>, 
	ICollection<T>, IEnumerable<T>
[<AbstractClassAttribute>]
[<SerializableAttribute>]
type AFCollection<'T when 'T : AFObject> =  
    class
        inherit AFCollection
        interface IAFList
        interface IList
        interface ICollection
        interface IEnumerable
        interface IList<'T>
        interface ICollection<'T>
        interface IEnumerable<'T>
    end

Type Parameters

T
The type of the item in the list must derive from AFObject.

The AFCollectionT type exposes the following members.

Properties

  NameDescription
Public property
Count
Gets the number of items actually contained in the collection.
Public property
Identity
This read-only property contains identity of the object.
(Inherited from AFCollection.)
Public property
IsDeleted
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.)
Public property
ItemGuid
Returns the item in the collection associated with the passed in ID.
Public property
ItemInt32
Returns the item located at the passed in index.
Public property
ItemIdentity
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.)
Public property
PISystem
This read-only property allows access to the PISystem associated with this collection.
(Inherited from AFCollection.)

Methods

  NameDescription
Public method
Add
Adds an object to the end of the collection.
Public method
Clear
Removes all items from the collection.
Public method
Contains(Guid)
This method determines whether the collection contains a specific item referenced by id.
Public method
Contains(T)
This method determines whether the collection contains a specific item.
Public method
CopyTo
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetEnumerator
Returns an enumerator that iterates through the collection.
Public method
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.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
Public method
Remove(Guid)
Removes the item with the specified id from the collection.
Public method
Remove(T)
Removes the first occurrence of a specific object from the collection.
Public method
RemoveAt
Removes the item at the specified index of the collection.
Public method
Sort
Sorts the items in the entire collection using the default comparer.
Public method
Sort(IComparerT)
Sorts the items in the entire collection using the specified comparer.
Public method
Sort(Int32, Int32, IComparerT)
Sorts the items in a range of items in the collection using the specified comparer.
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFCollection.)

Extension Methods

  NameDescription
Public Extension Method
AggregateT
Performs all requested aggregates on the specified items.
(Defined by AFAggregate.)
Public Extension Method
AggregateAsyncT
Performs all requested aggregates on the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
BinnedSummaryT, TBin
Generates a summary broken down by the specified bins for items matching the search criteria.
(Defined by AFAggregate.)
Public Extension Method
BinnedSummaryAsyncT, TBin
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
(Defined by AFAggregate.)
Public Extension MethodCode example
ChunkedByT
This extension method breaks up search results into chunks to make it easier to page through and process IEnumerableT collections in chunks.
(Defined by AFSDKExtension.)
Public Extension Method
FrequencyDistributionT
Generates a frequency distribution for the specified items.
(Defined by AFAggregate.)
Public Extension Method
FrequencyDistributionAsyncT
Generates a frequency distribution for the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
GroupedSummaryT
Generates a summary broken down by group for the specified items.
(Defined by AFAggregate.)
Public Extension Method
GroupedSummaryAsyncT
Generates a histogram for the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
HistogramT, TBin
Generates a histogram for the specified items with the specified weighting.
(Defined by AFAggregate.)
Public Extension Method
HistogramAsyncT, TBin
Generates a histogram for the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.)
Public Extension Method
SummaryT(String, AFSummaryTypes)Overloaded.
Summarizes the specified items.
(Defined by AFAggregate.)
Public Extension Method
SummaryT(String, AFSummaryTypes, String)Overloaded.
Summarizes the specified items with the specified weighting.
(Defined by AFAggregate.)
Public Extension Method
SummaryAsyncT(String, AFSummaryTypes, CancellationToken)Overloaded.
Summarizes the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
SummaryAsyncT(String, AFSummaryTypes, String, CancellationToken)Overloaded.
Summarizes the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.)

Remarks

The generic AFCollection is an indexed list of AFObject items by unique identifier.

Version Information

AFSDK


See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in