AFAttributeTrait Class

An AFAttributeTrait can be assigned to an AFAttributeTemplate or AFAttribute to define a trait with a well-known relationship to other attributes. The following methods can be used for accessing an attribute template or attribute by trait:

• GetAttributeTemplateByTrait(AFAttributeTrait)
• GetAttributeTemplatesByTrait(ICollectionAFAttributeTrait)
• GetAttributeByTrait(AFAttributeTrait)
• GetAttributesByTrait(ICollectionAFAttributeTrait)

A trait can be found by name or abbreviation using the FindAttributeTrait(String) method. Traits may also have well-known behaviors. For example, limit traits will have the same Type (see IsTypeInherited) and DefaultUOM (see IsUOMInherited) as the parent AFAttribute.

Traits are divided in to the following categories:

• Analysis
• Health
• Limit
• Location
• Other

The Analysis traits allow the attributes that define special information about an AFAnalysis to be indicated. For example, the AnalysisStartTriggerName and AnalysisStartTriggerExpression specify which attributes contain the start trigger name and expression for the analysis. You can use the AllAnalyses property to get the list of all the analysis traits. This is a list of the analysis traits:

• AnalysisStartTriggerExpression
• AnalysisStartTriggerName

The Health traits allow the attributes that indicate information about the health of an asset. For example, the HealthStatus will indicate the health status of the associated asset. You can use the AllHealth property to get the list of all the health traits. This is a list of the health traits:

• HealthScore
• HealthStatus

The Limit traits allow the attributes that define the expected range of a process variable or measurement to be defined. Limit traits have a priority with LimitMinimum having the lowest priority and LimitMaximum having the highest priority. If a limit attribute is missing, client applications will need to determine the proper behavior. For example, the absence of LimitHi could fall back to LimitHiHi which falls back to LimitMaximum. You can use the AllLimits property to get the list of all the limit traits. This is a list of the limit traits:

• LimitMinimum
• LimitLoLo
• LimitLo
• LimitTarget
• LimitHi
• LimitHiHi
• LimitMaximum

The Location traits allow attributes to define information about the location of an asset. This information could then be used to identify the location of the asset on a map. You can use the AllLocations property to get the list of all the location traits. This is a list of the location traits:

• LocationLatitude
• LocationLongitude
• LocationAltitude

The Other traits are the ones that don't fit in another specific category of traits. It contains the Forecast trait which allows a predicted attribute to be placed under the measured attribute. Client applications can then automatically know how to relate these attributes. For example, the attributes could be trended together so show the actual versus the predicted values. Multiple forecast attributes can be defined for a single parent attribute and they are not required to be a future value. It also includes the Reason trait indicating the attribute that contains a reason for the state of the object. You can use the AllOther property to get the list of all the other traits. This is a list of the other traits:

• Forecast
• Reason

The following chart shows the traits grouped by their category and indicates which behavior rules are defined for each trait.

AFSDK

Reference