AFEnumerationValues Class
- Last UpdatedNov 18, 2025
- 8 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFEnumerationValues is a collection of enumeration values.

Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFEnumerationValue
OSIsoft.AFAFNamedCollectionAFEnumerationValue
OSIsoft.AF.AssetAFEnumerationValues
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionAFEnumerationValue
OSIsoft.AFAFNamedCollectionAFEnumerationValue
OSIsoft.AF.AssetAFEnumerationValues
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFEnumerationValues : AFNamedCollection<AFEnumerationValue>
Public NotInheritable Class AFEnumerationValues Inherits AFNamedCollection(Of AFEnumerationValue) Dim instance As AFEnumerationValues
public ref class AFEnumerationValues sealed : public AFNamedCollection<AFEnumerationValue^>
[<SealedAttribute>] type AFEnumerationValues = class inherit AFNamedCollection<AFEnumerationValue> end
The AFEnumerationValues type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Count |
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.) | |
| EnumerationSet |
The enumeration that this collection is a member of.
| |
| 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.) | |
| Parent |
The parent of the collection of child hierarchical enumeration values.
| |
| PISystem |
This read-only property allows access to the PISystem
associated with this collection.
(Inherited from AFCollection.) |
Methods
| Name | Description | |
|---|---|---|
| Add(T) |
Adds an object to the end of the collection.
(Inherited from AFCollectionT.) | |
| Add(String, Int32) |
The Add method creates a new AFEnumerationValue and adds it to
the collection with the specified name and value.
| |
| 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.) | |
| GetByValue |
Gets the specified AFEnumerationValue from the collection
by its value.
| |
| 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
This collection is used to represent child enumeration values in
a hierarchal relationship within an AFEnumerationSet.
Use the Add
method to add a child enumeration value.
Examples
// This example demonstrates how to create an enumeration // value type and add it as the type of an attribute, // as well as setting a value with it. // Get the Database PISystems myPISystems = new PISystems(); AFDatabase myDB = myPISystems.DefaultPISystem.Databases.DefaultDatabase; // Create the Enumeration Set AFEnumerationSet myEnumerationSet = myDB.EnumerationSets.Add("Speed"); myEnumerationSet.Description = "Motor Speeds"; // Add the Enumeration Values myEnumerationSet.Add("Stop", 0); myEnumerationSet.Add("Slow", 1); myEnumerationSet.Add("Medium", 5); myEnumerationSet.Add("Fast", 10); // Display the Name and Description of the EnumerationSet Console.WriteLine("Name of EnumerationSet = {0}", myEnumerationSet.Name); Console.WriteLine("Description = {0}", myEnumerationSet.Description); // Display each value in the EnumerationSet foreach (AFEnumerationValue eVal in myEnumerationSet) { Console.WriteLine("Name in set = {0}", eVal.Name); Console.WriteLine("Value in set = {0}", eVal.Value); } // Create an Element AFElement myElement = myDB.Elements.Add("MyElement"); // Create an Attribute AFAttribute myAttribute = myElement.Attributes.Add("MyAttribute"); // Set the EnumerationSet for an Attibute myAttribute.TypeQualifier = myEnumerationSet; myAttribute.SetValue(myEnumerationSet["Stop"], null);
' This example demonstrates how to create an enumeration ' value type and add it as the type of an attribute, ' as well as setting a value with it. ' Get the Database Dim myPISystems As New PISystems() Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases.DefaultDatabase ' Create the Enumeration Set Dim myEnumerationSet As AFEnumerationSet = myDB.EnumerationSets.Add("Speed") myEnumerationSet.Description = "Motor Speeds" ' Add the Enumeration Values myEnumerationSet.Add("Stop", 0) myEnumerationSet.Add("Slow", 1) myEnumerationSet.Add("Medium", 5) myEnumerationSet.Add("Fast", 10) ' Display the Name and Description of the EnumerationSet Console.WriteLine("Name of EnumerationSet = {0}", myEnumerationSet.Name) Console.WriteLine("Description = {0}", myEnumerationSet.Description) ' Display each value in the EnumerationSet Dim eVal As AFEnumerationValue For Each eVal In myEnumerationSet Console.WriteLine("Name in set = {0}", eVal.Name) Console.WriteLine("Value in set = {0}", eVal.Value) Next eVal ' Create an Element Dim myElement As AFElement = myDB.Elements.Add("MyElement") ' Create an Attribute Dim myAttribute As AFAttribute = myElement.Attributes.Add("MyAttribute") ' Set the EnumerationSet for an Attribute myAttribute.TypeQualifier = myEnumerationSet myAttribute.SetValue(myEnumerationSet("Stop"), Nothing)
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.