AFAttributeTrait.GetDefaultUOM Method

Save PDF

Feedback

HomeAF SDK Reference...NamespacesOSIsoft.AF.AssetAFAttributeTrait ClassAFAttributeTrait MethodsAFAttributeTrait.GetDefaultUOM Method

TABLE OF CONTENTS

AFAttributeTrait.GetDefaultUOM Method

Save PDF

Feedback

Last UpdatedSep 18, 2024

Gets the default UOM that is specified for the AFAttribute.

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

Syntax

public UOM GetDefaultUOM(
	PISystem system = null
)

Public Function GetDefaultUOM ( 
	Optional system As PISystem = Nothing
) As UOM

Dim instance As AFAttributeTrait
Dim system As PISystem
Dim returnValue As UOM

returnValue = instance.GetDefaultUOM(system)

public:
UOM^ GetDefaultUOM(
	PISystem^ system = nullptr
)

member GetDefaultUOM : 
        ?system : PISystem 
(* Defaults:
        let _system = defaultArg system null
*)
-> UOM

Parameters

system (Optional): Type: OSIsoft.AF.PISystem
The PISystem that is used to find the UOM to be returned. If null, then the DefaultPISystem will be used.

Return Value

Type: UOM
Returns the default UOM for AFAttribute. Returns null if no default UOM is defined.

Remarks

If a default UOM is defined, then the DefaultUOM for the AFAttribute must be specified and belong to the same UOMClass as defined by this trait.

Version Information

AFSDK

Supported in: 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, 2.9, 2.8.5

AF SDK Reference

Filters

Product Family