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

AF SDK Reference

AFAttributeTrait.HealthStatus Property

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFAttributeTrait.HealthStatus Property
The AFAttributeTrait that defines the Health Status attribute trait.

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

Syntax

public static AFAttributeTrait HealthStatus { get; }
Public Shared ReadOnly Property HealthStatus As AFAttributeTrait
	Get

Dim value As AFAttributeTrait

value = AFAttributeTrait.HealthStatus
public:
static property AFAttributeTrait^ HealthStatus {
	AFAttributeTrait^ get ();
}
static member HealthStatus : AFAttributeTrait with get

Property Value

Type: AFAttributeTrait
Returns the AFAttributeTrait that defines the Health Status attribute trait.

Remarks

The value of the health status must be an enumeration value from the system-defined Health Status enumeration set.

When using the FindAttributeTrait(String) method to find this trait, you can use the name 'HealthScore'. This trait has the following behaviors:

Important note Important
If the 'Health Status'AFEnumerationSet does not exist, then it will be automatically created for the database when the GetRequiredEnumerationSet(AFDatabase) method is called for this trait. The AFHealthStatus enumeration can be used to look up values in the 'Health Status' enumeration set by value (e.g. 'set.GetByValue((int)AFHealthStatus.InMaintenance);').

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10

See Also

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