AFAttributeVariable Class
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFAttributeVariable defines an attribute variable used in an analysis rule.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.AnalysisAFAttributeVariable
OSIsoft.AF.AnalysisAFAttributeVariable
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class AFAttributeVariable : IComparable, IComparable<AFAttributeVariable>, IEquatable<AFAttributeVariable>
<SerializableAttribute> Public NotInheritable Class AFAttributeVariable Implements IComparable, IComparable(Of AFAttributeVariable), IEquatable(Of AFAttributeVariable) Dim instance As AFAttributeVariable
[SerializableAttribute] public ref class AFAttributeVariable sealed : IComparable, IComparable<AFAttributeVariable^>, IEquatable<AFAttributeVariable^>
[<SealedAttribute>] [<SerializableAttribute>] type AFAttributeVariable = class interface IComparable interface IComparable<AFAttributeVariable> interface IEquatable<AFAttributeVariable> end
The AFAttributeVariable type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFAttributeVariable(String, String, AFAttributeVariableType, AFAttribute, AFAnalysisRule) |
Creates a new AFAttributeVariable object.
|
| AFAttributeVariable(String, String, AFAttributeVariableType, AFAttributeTemplate, AFAnalysisRule) |
Creates a new AFAttributeVariable object.
|
Properties
| Name | Description | |
|---|---|---|
 | AnalysisRuleVariableMaps |
Returns a list of analysis rules the attribute is associated with.
|
| Attribute |
Returns the mapped attribute.
|
| AttributeTemplate |
Returns the mapped attribute.
|
| IsConfigured |
Returns if the variable has been set.
|
| IsDynamic |
Returns if the attribute for the variable corresponds to a dynamic attribute.
|
| IsInput |
Returns if the variable is an input (either required or optional).
|
| IsIntermediate |
Returns if the variable is an intermediate variable.
|
| IsOptional |
Returns if the variable is an optional input.
|
| IsOutput |
Returns if the variable is an output.
|
| IsRequired |
Returns if the variable is a required input.
|
| MappedName |
Returns the full path for the mapped attribute.
|
| Name |
Returns the variable name. For an intermediate variable, it always returns the output name.
|
| VariableType |
Returns the variable type.
|
Methods
| Name | Description | |
|---|---|---|
| CompareTo(Object) |
Compares this instance with a specified Object.
|
| CompareTo(AFAttributeVariable) |
Compares this instance with a specified AFAttributeVariable.
|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).) |
| Equals(AFAttributeVariable) |
Indicates whether the current object is equal to another object of the same type.
|
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MapAttribute |
Maps the variable to the specified attribute specified by the relative path and target.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Operators
| Name | Description | |
|---|---|---|
  | Equality |
The equality operator (==) compares its operands to determine if they are equal.
|
| GreaterThan |
The greater than relation operator (>) compares its operands to determine
which one is greater than the other.
|
| GreaterThanOrEqual |
The greater than or equal relation operator (>=) compares its operands to determine
which one is greater than or equal to the other.
|
| Inequality |
The inequality operator (!=) compares its operands to determine if they are not equal.
|
| LessThan |
The less than relation operator (<) compares its operands to determine
which one is less than the other.
|
| LessThanOrEqual |
The less than or equal relation operator (<=) compares its operands to determine
which one is less than or equal to the other.
|