Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

TABLE OF CONTENTS

UOMGroups Class

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 8 minute read
UOMGroups Class
The collection of UOMGroup objects.

Inheritance Hierarchy

SystemObject
  OSIsoft.AFAFCollection
    OSIsoft.AFAFCollectionUOMGroup
      OSIsoft.AFAFNamedCollectionUOMGroup
        OSIsoft.AF.UnitsOfMeasureUOMGroups

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

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

  NameDescription
Public property
Count
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.)
Public property
Database
This read-only property allows access to the UOMDatabase associated with this object.
Public property
Identity
This read-only property contains identity of the object.
(Inherited from AFCollection.)
Public property
IsDeleted
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.)
Public property
ItemGuid
Returns the item in the collection associated with the passed in ID.
(Inherited from AFCollectionT.)
Public property
ItemInt32
Returns the item located at the passed in index.
(Inherited from AFCollectionT.)
Public property
ItemString
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.)
Public property
ItemIdentity
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.)
Public property
PISystem
This read-only property allows access to the PISystem associated with this collection.
(Inherited from AFCollection.)

Methods

  NameDescription
Public method
Add(T)
Adds an object to the end of the collection.
(Inherited from AFCollectionT.)
Public method
Add(String)
The Add method creates a new object and adds it to the collection.
Public method
Clear
Removes all items from the collection.
(Inherited from AFCollectionT.)
Public method
Contains(Guid)
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.)
Public method
Contains(T)
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.)
Public method
Contains(String)
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.)
Public method
CopyTo
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from AFCollectionT.)
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetEnumerator
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.)
Public method
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.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
(Inherited from AFCollectionT.)
Public method
Remove(Guid)
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.)
Public method
Remove(T)
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.)
Public method
Remove(String)
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.)
Public method
RemoveAt
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.)
Public method
Sort
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.)
Public method
Sort(IComparerT)
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.)
Public method
Sort(Int32, Int32, IComparerT)
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.)
Public method
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);
' This example will create a UOM Group with mappings, display its information,
'  and then perform some conversions.

' Get the Database
Dim myPISystems As New PISystems()
Dim myDB As UOMDatabase = myPISystems.DefaultPISystem.UOMDatabase

' Create a UOM Group
Dim MyCustomGroup As UOMGroup = 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
For Each group As UOMGroup In myDB.UOMGroups
    Console.WriteLine("Name of UOM Group = {0}", group.Name)
    Console.WriteLine("Description = {0}", group.Description)
    Console.WriteLine("Mappings:")
    For Each item As KeyValuePair(Of UOM, UOM) In group.Mappings
        Console.WriteLine("    {0} ==> {1}", item.Key, item.Value)
    Next
Next

' Perform some conversions
Dim origAFValue As New AFValue(55.3, AFTime.Now, myDB.UOMs("mi"))
Dim mappedValue As Double = MyCustomGroup.Convert(100.0, myDB.UOMs("yd"))
Console.WriteLine("Convert 100.0 ft ==> {0}", mappedValue)
Dim mappedAFValue As AFValue = 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)

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.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in