UOMClasses Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The collection of UOMClass objects.

Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionUOMClass
OSIsoft.AFAFNamedCollectionUOMClass
OSIsoft.AF.UnitsOfMeasureUOMClasses
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionUOMClass
OSIsoft.AFAFNamedCollectionUOMClass
OSIsoft.AF.UnitsOfMeasureUOMClasses
Namespace: OSIsoft.AF.UnitsOfMeasure
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class UOMClasses : AFNamedCollection<UOMClass>
Public NotInheritable Class UOMClasses Inherits AFNamedCollection(Of UOMClass) Dim instance As UOMClasses
public ref class UOMClasses sealed : public AFNamedCollection<UOMClass^>
[<SealedAttribute>] type UOMClasses = class inherit AFNamedCollection<UOMClass> end
The UOMClasses type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Count |
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.) | |
| Database |
This read-only property allows access to the UOMDatabase associated with this
object.
| |
| 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(T) |
Adds an object to the end of the collection.
(Inherited from AFCollectionT.) | |
| Add(String, String, String) |
The Add method creates a new object and adds it to the 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.) | |
| 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 global UOMClasses collection maintained by the Units Of Measure Database
represents all the defined unit-of-measure classes on an
UOMDatabase. You add a UOM class to the global list of UOM
classes only by using the Add(String, String, String) method of the
UOMDatabase.UOMClasses collection.
Examples
// This example will create a base UOM Class and then display its information. // Get the Database PISystems myPISystems = new PISystems(); UOMDatabase myDB = myPISystems.DefaultPISystem.UOMDatabase; // Create a UOM Class UOMClass LengthUOMClass = myDB.UOMClasses.Add("QALength", "QAmeter", "QAm"); LengthUOMClass.Description = "UOM Class representing length"; // Display the name, description, and Canonical UOM of each UOM Class Console.WriteLine("Name of UOM Class = {0}", LengthUOMClass.Name); Console.WriteLine("Description = {0}", LengthUOMClass.Description); Console.WriteLine("Canonical unit of measure = {0}", LengthUOMClass.CanonicalUOM.Name); // Display a message telling if this is a Base Class if (LengthUOMClass.IsBaseClass) Console.WriteLine("This UOM Class is a Base Class"); else Console.WriteLine("This UOM Class is NOT a Base Class");
' This example will create a base UOM Class and then display its information. ' Get the Database Dim myPISystems As New PISystems Dim myDB As UOMDatabase = myPISystems.DefaultPISystem.UOMDatabase ' Create a UOM Class Dim LengthUOMClass As UOMClass = myDB.UOMClasses.Add("QALength", "QAmeter", "QAm") LengthUOMClass.Description = "UOM Class representing length" ' Display the name, description, and Canonical UOM of each UOM Class Console.WriteLine("Name of UOM Class = {0}", LengthUOMClass.Name) Console.WriteLine("Description = {0}", LengthUOMClass.Description) Console.WriteLine("Canonical unit of measure = {0}", LengthUOMClass.CanonicalUOM.Name) ' Display a message telling if this is a Base Class If LengthUOMClass.IsBaseClass = True Then Console.WriteLine("This UOM Class is a Base Class") Else Console.WriteLine("This UOM Class is NOT a Base Class") End If
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.