AFAnalysisRule Properties
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFAnalysisRule type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Analysis |
This property returns the analysis that owns this object.
| |
| AnalysisRules |
This read-only property returns the child analysis rules.
| |
| AnalysisTemplate |
This property returns the analysis template that owns this object.
| |
| ConfigString |
This property represents the current configuration of the Analysis Rule as a string suitable
for displaying to an end-user and/or setting its configuration.
| |
| CurrentCase |
This property returns the current case associated with the AnalysisRule.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
| |
| Description |
Read-only property that provides more detailed description of the object.
| |
| DisplayString |
Returns the configuration of the AFAnalysisRule for display purposes.
| |
| EditorType |
This method returns the Type of the editor that is used to
configure this analysis rule.
| |
| HasChildren |
This read-only property returns if the analysis rule has child analysis rules.
| |
| ID |
Read-only property that provides a unique identifier for the object to be used for
quick access that is not dependent upon the index.
(Inherited from AFObject.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) | |
| IsConfigured |
This method returns if the analysis rule instance is properly configured.
| |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsInitializing |
Indicates that the AFAnalysisRule is in the process
of being initialized.
| |
| Name |
Read-only property that identifies the name of the object.
| |
| Parent |
Returns the parent analysis rule which owns this analysis rule.
| |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| PlugIn |
This read-only property returns the AFPlugIn used to create
this instance of the plugin.
| |
| SimplifiedConfigString |
This property presents a simplified view of the current configuration of the Analysis Rule
that is easier for users to edit and that does not contain redundant information (e.g. IDs for resolution).
| |
| SimplifiedVariableMapping |
This property represents a simplified view of the current variable mapping for the Analysis Rule.
Setting this property will update the VariableMapping string with updated IDs.
| |
| SupportedBehaviors |
Defines the behavior supported by this analysis rule. If the analysis rule supports child analysis rules, their supported behavior is accounted for.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) | |
| VariableMap |
A collection of AFVariableMappingDatas defined for this AFAnalysisRule.
Modifying this collection is preferred to editing the VariableMapping string directly.
| |
| VariableMapping |
This property represents the current variable mapping for the Analysis Rule.
|
See Also
In This Topic
Related Links
- Analysis Property
- AnalysisRules Property
- AnalysisTemplate Property
- ConfigString Property
- CurrentCase Property
- Database Property
- Description Property
- DisplayString Property
- EditorType Property
- HasChildren Property
- IsConfigured Property
- IsInitializing Property
- Name Property
- Parent Property
- PlugIn Property
- SimplifiedConfigString Property
- SimplifiedVariableMapping Property
- SupportedBehaviors Property
- VariableMap Property
- VariableMapping Property