AFAttributeTrait.GetRequiredEnumerationSet Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Gets the required AFEnumerationSet that is specified for the AFAttribute.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFEnumerationSet GetRequiredEnumerationSet( AFDatabase database = null )
Public Function GetRequiredEnumerationSet ( Optional database As AFDatabase = Nothing ) As AFEnumerationSet Dim instance As AFAttributeTrait Dim database As AFDatabase Dim returnValue As AFEnumerationSet returnValue = instance.GetRequiredEnumerationSet(database)
public: AFEnumerationSet^ GetRequiredEnumerationSet( AFDatabase^ database = nullptr )
member GetRequiredEnumerationSet : ?database : AFDatabase (* Defaults: let _database = defaultArg database null *) -> AFEnumerationSet
Parameters
- database (Optional)
- Type: OSIsoft.AFAFDatabase
The AFDatabase that is used to find the AFEnumerationSet to be returned. If , then the DefaultDatabase of the DefaultPISystem will be used.
Return Value
Type: AFEnumerationSetReturns the required AFEnumerationSet for AFAttribute. Returns if no required AFEnumerationSet is defined.
Remarks
If a required AFEnumerationSet is defined, then the TypeQualifier
for the AFAttribute will be set to this value and the attribute's value must be an
AFEnumerationValue from the enumeration set as defined by this trait.