AFPlugIns Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
This collection contains the list of AFPlugIn objects
that are installed on the server's workstation.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFPlugIn
OSIsoft.AFAFNamedCollectionAFPlugIn
OSIsoft.AFAFPlugIns
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFPlugIn
OSIsoft.AFAFNamedCollectionAFPlugIn
OSIsoft.AFAFPlugIns
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class AFPlugIns : AFNamedCollection<AFPlugIn>
<SerializableAttribute> Public NotInheritable Class AFPlugIns Inherits AFNamedCollection(Of AFPlugIn) Dim instance As AFPlugIns
[SerializableAttribute] public ref class AFPlugIns sealed : public AFNamedCollection<AFPlugIn^>
[<SealedAttribute>] [<SerializableAttribute>] type AFPlugIns = class inherit AFNamedCollection<AFPlugIn> end
The AFPlugIns 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.
(Inherited from AFNamedCollectionT.) |
| 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.
(Inherited from AFNamedCollectionT.) |
| 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.
(Inherited from AFNamedCollectionT.) |
| 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
The PISystem maintains the list of the four
categories of plugins that are supported by the AF SDK:
data references, which inherit from the AFDataReference base class;
time rules, which inherit from the AFTimeRule base class;
analysis engines, which inherit from the AFAnalysisRule base class.
and delivery channels, which inherit from the AFDeliveryChannel base class;
Examples
// This example will display information on the Data Reference PlugIns. // Get the Default System PISystems myPISystems = new PISystems(); PISystem myPISystem = myPISystems.DefaultPISystem; // Display the Name and Description of each Data Reference Rule PlugIn foreach (AFPlugIn CurDataReferencePlugIn in myPISystem.DataReferencePlugIns) { Console.WriteLine("Name = {0}", CurDataReferencePlugIn.Name); Console.WriteLine("Description = {0}", CurDataReferencePlugIn.Description); Console.WriteLine("UniqueID = {0}", CurDataReferencePlugIn.UniqueID); }
' This example will display information on the Data Reference PlugIns. ' Get the Default System Dim myPISystems As New PISystems Dim myPISystem As PISystem = myPISystems.DefaultPISystem ' Display the Name and Description of each Data Reference Rule PlugIn Dim CurDataReferencePlugIn As AFPlugIn For Each CurDataReferencePlugIn In myPISystem.DataReferencePlugIns Console.WriteLine("Name = {0}", CurDataReferencePlugIn.Name) Console.WriteLine("Description = {0}", CurDataReferencePlugIn.Description) Console.WriteLine("UniqueID = {0}", CurDataReferencePlugIn.UniqueID) Next CurDataReferencePlugIn
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.