Click or drag to resize
OSIsoft, LLC

AFDataRecordedValue Method

Returns a single recorded AFValue based on the passed time and mode.

Namespace:  OSIsoft.AF.Data
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
public AFValue RecordedValue(
	AFTime time,
	AFRetrievalMode mode,
	UOM desiredUOM
)

Parameters

time
Type: OSIsoft.AF.TimeAFTime
The time at which the value is desired.
mode
Type: OSIsoft.AF.DataAFRetrievalMode
The mode is used to determine the value to return when a value does not exist at the exact time specified. The value is taken from the AFRetrievalMode enumeration.
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: AFValue
Returns 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 indicate the time of the recorded event. In the case of calculation based data references, it will normally indicate the closest input value's recorded value timestamp.
Exceptions
ExceptionCondition
NotSupportedException The data reference does not support this method.
Remarks
To retrieve recorded values for multiple attributes, use the AFListData.RecordedValue to achieve better performance.

Note Notes to Callers
This method, property, or class is only available in the .NET 4 version of the SDK.

Security note Security Note
You must have ReadData security rights to read a data value.

Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5
See Also
Enabling Operational Intelligence