AFData.InterpolatedValue Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Returns a single AFValue whose value is
interpolated at the passed time.
Namespace: OSIsoft.AF.Data
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFValue InterpolatedValue( AFTime time, UOM desiredUOM )
Public Function InterpolatedValue ( time As AFTime, desiredUOM As UOM ) As AFValue Dim instance As AFData Dim time As AFTime Dim desiredUOM As UOM Dim returnValue As AFValue returnValue = instance.InterpolatedValue(time, desiredUOM)
public: AFValue^ InterpolatedValue( AFTime time, UOM^ desiredUOM )
member InterpolatedValue : time : AFTime * desiredUOM : UOM -> AFValue
Parameters
- time
- Type: OSIsoft.AF.TimeAFTime
The time at which the value is desired. - desiredUOM
- Type: OSIsoft.AF.UnitsOfMeasureUOM
The desired unit of measure for the returned value. If , then the value is returned in the unit of measure specified by the associated attribute's DefaultUOM property.
Return Value
Type: AFValueReturns the AFValue for the attribute. If AFValue.IsGood returned by the data reference is , then the returned value is converted to the proper UOM and Type. The timestamp of the value will be at the requested time.
Exceptions
| Exception | Condition |
|---|---|
| NotSupportedException | The data reference does not support this method. |
Remarks
To retrieve recorded values for multiple attributes, use the
AFListData.InterpolatedValue to achieve better performance.
| This method, property, or class is not available in the legacy .NET 3.5 version of the SDK. |
| You must have ReadData security rights to read a data value. |