AFVariableMap Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The variable mapping configuration for an AFAnalysisRule.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.AnalysisAFVariableMap
OSIsoft.AF.AnalysisAFVariableMap
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public abstract class AFVariableMap
Public MustInherit Class AFVariableMap Dim instance As AFVariableMap
public ref class AFVariableMap abstract
[<AbstractClassAttribute>] type AFVariableMap = class end
The AFVariableMap type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Item |
Gets or sets the AFVariableMappingData associated with the specified variable name.
|
Methods
| Name | Description | |
|---|---|---|
 | Clear |
Clears all defined variable mappings.
|
| ClearAllExceptSpecified |
Clears all AFVariableMappingDatas defined in this AFVariableMap except for the variable names specified.
|
 | Create |
Gets an AFVariableMap with empty configuration.
|
| Create(String) |
Gets an AFVariableMap with values from the serialized configuration.
|
| Create(AFAnalysisRule) |
Gets a disconnected AFVariableMap with the configuration loaded from the specified analysis rule.
Changes to the returned instance will not be written back to the analysis rule.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsVariableMapped |
Returns true if there is an AFVariableMappingData configured for the specified variable name and false otherwise.
|
| RefreshMappings |
Refreshes variablemappings and updates it with resolved attributes if needed.
|
| RemoveMapping |
Remove any mapping for the specified variable name
|
| RemoveMappings |
Clears all AFVariableMappingDatas defined in this AFVariableMap whose name appears in the variablesToRemove enumeration.
|
| SetMapping |
Sets the AFVariableMappingData associated with the specified variable name.
|
| SetVariableMap |
Overwrites this AFVariableMap with the contents of passed variable map.
|
| ToString |
Gets the serialized form of the variable mapping.
(Overrides ObjectToString.) |
| TryGetMapping |
Tries to find an AFVariableMappingData for the specified variable name.
|