AF SDK Reference

AFNamedCollection(T) Class

Save PDF

TABLE OF CONTENTS

AFNamedCollection(T) Class

Save PDF

Last UpdatedNov 18, 2025
9 minute read

Provides the abstract base class used for all collections in the AF SDK that are indexed by unique identifier and name.

Inheritance Hierarchy

SystemObject
  OSIsoft.AFAFCollection
    OSIsoft.AFAFCollectionT
      OSIsoft.AFAFNamedCollectionT
        More...

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

Syntax

public abstract class AFNamedCollection<T> : AFCollection<T>, 
	IAFNamedCollection<T>, ICollection<T>, IEnumerable<T>, IEnumerable, IList<T>
where T : AFObject

Public MustInherit Class AFNamedCollection(Of T As AFObject)
	Inherits AFCollection(Of T)
	Implements IAFNamedCollection(Of T), ICollection(Of T), 
	IEnumerable(Of T), IEnumerable, IList(Of T)

Dim instance As AFNamedCollection(Of T)

generic<typename T>
where T : AFObject
public ref class AFNamedCollection abstract : public AFCollection<T>, 
	IAFNamedCollection<T>, ICollection<T>, IEnumerable<T>, IEnumerable, IList<T>

[<AbstractClassAttribute>]
type AFNamedCollection<'T when 'T : AFObject> =  
    class
        inherit AFCollection<'T>
        interface IAFNamedCollection<'T>
        interface ICollection<'T>
        interface IEnumerable<'T>
        interface IEnumerable
        interface IList<'T>
    end

Type Parameters

T: The type of the item in the list must derive from AFObject and have a Name property.

The AFNamedCollectionT type exposes the following members.

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.)
	ItemString	Returns the specified object from the collection by name.
	ItemIdentity	This read-only property specifies the identity of the objects within the collection. (Inherited from AFCollection.)
	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.)
	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.)
	Contains(String)	This method determines whether the collection contains a specific item referenced by name.
	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.)
	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.)
	Remove(String)	The Remove method removes the item from the collection by name.
	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.)

Extension Methods

	Name	Description
	AggregateT	Performs all requested aggregates on the specified items. (Defined by AFAggregate.)
	AggregateAsyncT	Performs all requested aggregates on the specified items asynchronously. (Defined by AFAggregate.)
	BinnedSummaryT, TBin	Generates a summary broken down by the specified bins for items matching the search criteria. (Defined by AFAggregate.)
	BinnedSummaryAsyncT, TBin	Generates a summary broken down by the specified bins for items matching the search criteria asynchronously. (Defined by AFAggregate.)
	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.)
	FrequencyDistributionT	Generates a frequency distribution for the specified items. (Defined by AFAggregate.)
	FrequencyDistributionAsyncT	Generates a frequency distribution for the specified items asynchronously. (Defined by AFAggregate.)
	GroupedSummaryT	Generates a summary broken down by group for the specified items. (Defined by AFAggregate.)
	GroupedSummaryAsyncT	Generates a histogram for the specified items asynchronously. (Defined by AFAggregate.)
	HistogramT, TBin	Generates a histogram for the specified items with the specified weighting. (Defined by AFAggregate.)
	HistogramAsyncT, TBin	Generates a histogram for the specified items with the specified weighting asynchronously. (Defined by AFAggregate.)
	SummaryT(String, AFSummaryTypes)	Overloaded. Summarizes the specified items. (Defined by AFAggregate.)
	SummaryT(String, AFSummaryTypes, String)	Overloaded. Summarizes the specified items with the specified weighting. (Defined by AFAggregate.)
	SummaryAsyncT(String, AFSummaryTypes, CancellationToken)	Overloaded. Summarizes the specified items asynchronously. (Defined by AFAggregate.)
	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 and name.

Version Information

AFSDK

Inheritance Hierarchy

AF SDK Reference

AFNamedCollection(T) Class

Table of Contents

AFNamedCollection(T) Class

Inheritance Hierarchy

Syntax

Type Parameters

Properties

Methods

Extension Methods

Remarks

Version Information

AFSDK

See Also

Reference

Other Resources

Inheritance Hierarchy

In This Topic

Related Links