UOMGroups Class
- Last UpdatedJan 12, 2026
- 7 minute read
- PI System
- AF SDK 3.2.0
- Developer
The collection of UOMGroup objects.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionUOMGroup
OSIsoft.AFAFNamedCollectionUOMGroup
OSIsoft.AF.UnitsOfMeasureUOMGroups
OSIsoft.AFAFCollection
OSIsoft.AFAFCollectionUOMGroup
OSIsoft.AFAFNamedCollectionUOMGroup
OSIsoft.AF.UnitsOfMeasureUOMGroups
Namespace: OSIsoft.AF.UnitsOfMeasure
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.2.0.7
Syntax
public sealed class UOMGroups : AFNamedCollection<UOMGroup>
Public NotInheritable Class UOMGroups Inherits AFNamedCollection(Of UOMGroup) Dim instance As UOMGroups
public ref class UOMGroups sealed : public AFNamedCollection<UOMGroup^>
[<SealedAttribute>] type UOMGroups = class inherit AFNamedCollection<UOMGroup> end
The UOMGroups 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) |
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 UOMGroups collection maintained by the Units Of Measure Database
represents all the defined unit-of-measure groups on an
UOMDatabase. You add a UOM group to the global list of UOM
groups only by using the Add(String) method of the
UOMGroups collection.
Examples
// This example will create a UOM Group with mappings, display its information, // and then perform some conversions. // Get the Database PISystems myPISystems = new PISystems(); UOMDatabase myDB = myPISystems.DefaultPISystem.UOMDatabase; // Create a UOM Group UOMGroup MyCustomGroup = myDB.UOMGroups.Add("MyCustomUOMGroup*"); MyCustomGroup.Description = "Custom UOM Group for Length"; // Add mappings to group MyCustomGroup.Mappings[myDB.UOMs["ft"]] = myDB.UOMs["m"]; MyCustomGroup.Mappings[myDB.UOMs["in"]] = myDB.UOMs["cm"]; MyCustomGroup.Mappings[myDB.UOMs["nmi"]] = myDB.UOMs["km"]; MyCustomGroup.Mappings[myDB.UOMs["mi"]] = myDB.UOMs["km"]; MyCustomGroup.Mappings[myDB.UOMs["mm"]] = myDB.UOMs["cm"]; MyCustomGroup.Mappings[myDB.UOMs["sxi"]] = myDB.UOMs["cm"]; MyCustomGroup.Mappings[myDB.UOMs["yd"]] = myDB.UOMs["m"]; myDB.CheckIn(); // Display the UOM Groups foreach (UOMGroup group in myDB.UOMGroups) { Console.WriteLine("Name of UOM Group = {0}", group.Name); Console.WriteLine("Description = {0}", group.Description); Console.WriteLine("Mappings:"); foreach (KeyValuePair<UOM, UOM> item in group.Mappings) { Console.WriteLine(" {0} ==> {1}", item.Key, item.Value); } } // Perform some conversions AFValue origAFValue = new AFValue(55.3, AFTime.Now, myDB.UOMs["mi"]); double mappedValue = MyCustomGroup.Convert(100.0, myDB.UOMs["yd"]); Console.WriteLine("Convert 100.0 ft ==> {0}", mappedValue); AFValue mappedAFValue = origAFValue.Convert(MyCustomGroup); Console.WriteLine("Convert {0} {1} ==> {2} {3}", origAFValue.Value, origAFValue.UOM, mappedAFValue.Value, mappedAFValue.UOM); // Display attribute value using Display UOM myDB.DisplayUOMGroup = MyCustomGroup; origAFValue = MyAttr.GetValue(); mappedAFValue = MyAttr.GetValue(MyAttr.DisplayUOM); Console.WriteLine("GetValue {0} {1} ==> {2} {3}", origAFValue.Value, origAFValue.UOM, mappedAFValue.Value, mappedAFValue.UOM);