UOM.Update Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
This method updates the conversion factors for this unit of measure (UOM).
Namespace: OSIsoft.AF.UnitsOfMeasure
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public void Update( UOM refUOM, double refFactor, double refOffset )
Public Sub Update ( refUOM As UOM, refFactor As Double, refOffset As Double ) Dim instance As UOM Dim refUOM As UOM Dim refFactor As Double Dim refOffset As Double instance.Update(refUOM, refFactor, refOffset)
public: void Update( UOM^ refUOM, double refFactor, double refOffset )
member Update : refUOM : UOM * refFactor : float * refOffset : float -> unit
Parameters
- refUOM
- Type: OSIsoft.AF.UnitsOfMeasureUOM
The reference unit of measure for this UOM conversion. This UOM must belong to the same UOM class and must not create any circular references. Specify to update the canonical UOM. - refFactor
- Type: SystemDouble
The factor to multiply the reference UOM by to obtain this UOM. - refOffset
- Type: SystemDouble
The optional offset to add to the factored reference UOM to obtain this UOM. The default value is 0.
Remarks
This method replaces the conversion factors for this UOM. Avoid creating circular references. Enter the conversion factors according to the following formula: [X in this UOM] = [X in Reference UOM] * RefFactor + RefOffset;
The reference UOM must belong to the same UOM class as this UOM. Conversions to the canonical unit for this UOM class are automatically computed.