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

AF SDK Reference

AFAttribute.GetValue Method (AFCase, UOM)

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFAttribute.GetValue Method (AFCase, UOM)
This method gets the value for an attribute based upon the data reference configuration and the specified AFCase context in the specified units-of-measure.

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

Syntax

public AFValue GetValue(
	AFCase caseContext,
	UOM desiredUOM
)
Public Function GetValue ( 
	caseContext As AFCase,
	desiredUOM As UOM
) As AFValue

Dim instance As AFAttribute
Dim caseContext As AFCase
Dim desiredUOM As UOM
Dim returnValue As AFValue

returnValue = instance.GetValue(caseContext, 
	desiredUOM)
public:
AFValue^ GetValue(
	AFCase^ caseContext, 
	UOM^ desiredUOM
)
member GetValue : 
        caseContext : AFCase * 
        desiredUOM : UOM -> AFValue 

Parameters

caseContext
Type: OSIsoft.AF.AnalysisAFCase
The case context to be used when getting the attribute's value. If the case context is , then no context is used when getting the attribute's value. If the case context is not and the case context is not supported by this attribute's configuration, as indicated by the SupportedContexts property, then the context will be changed to an AFTimeRange context represented by the case's start and end times.
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 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.

Exceptions

ExceptionCondition
InvalidCastException Thrown when the conversion to the desired UOM or configured Type cannot be performed.

Remarks

The data reference configuration specifies how to read the value of the attribute. The AFDataReference.UOM property specifies the actual UOM of the external data value referenced by this attribute.

When obtaining values for multiple attributes, consider using one of the AFAttributeList.GetValue Overload methods as it can perform more efficiently in many instances.

Important note Important
Once a value has been added to a case's result set, either through one of the AFCase.AddInput Overload methods or by setting its value with an AFCase context, then subsequent calls to GetValue with the same case context will not invoke the data reference but return the stored result value.

Version Information

AFSDK


See Also

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