AFAnalysisRule Methods
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFAnalysisRule type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| ClearVariableMapForPasteOperation |
Clear the variable map logic when pasting the analysis rule.
| |
| CollectElements |
This method collects the elements that are active for the current case.
| |
| CollectInputs |
This method is an optional method which allows the analysis rule to obtain the
input values necessary to start an analysis.
| |
| CollectTransfers |
This method collects the transfers that are active for the current case.
| |
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) | |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) | |
| DefaultSaveConfigChanges |
Called by the protected SaveConfigChanges method to perform the default actions to save
the configuration changes.
| |
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) | |
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) | |
| FindAnalysisRule(AFAnalysis, Guid) |
Retrieves the AFAnalysisRule object from the AFAnalysis
with the specified unique identifier.
| |
| FindAnalysisRule(AFAnalysisTemplate, Guid) |
Retrieves the AFAnalysisRule object from the AFAnalysisTemplate
with the specified unique identifier.
| |
| GetAttributeVariables |
Returns all the attribute variables.
| |
| GetConfiguration |
Get the configuration defined by this AFAnalysisRule for its current target.
| |
| GetConfiguration(AFObject) |
Get the configuration defined by this AFAnalysisRule for the specified target.
| |
| GetEditorT |
Returns an instance of an editor of the specified 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.
(Inherited from AFObject.) | |
| GetInputs |
This method provides the analysis rule a mechanism to specify the attributes
it will use during its analysis.
| |
| GetLocalizedError |
This method gets a localized string for errors associated with the AFAnalysisRule.
| |
| GetOutputs |
This method provides the analysis rule a mechanism to specify the attributes
it will output during its analysis.
| |
| GetOutputsForAnalyses |
Returns a mapping of AFAttributes to the AFAnalysis that outputs values to them.
| |
| GetOutputsForAnalysisTemplates |
Returns a mapping of AFAttributeTemplates to the AFAnalysisTemplate that outputs values to them.
| |
| GetPath |
Returns the full path to the object, using just the names.
(Inherited from AFObject.) | |
| GetPath(AFObject) |
Returns the path to the object relative from another object.
(Inherited from AFObject.) | |
| GetPath(AFEncodeType, AFObject) |
Returns the path to the object relative from another object,
using the name and/or id as specified
by encodeType.
(Inherited from AFObject.) | |
| GetTarget |
Get the target associated with the specified AFAnalysisRule.
| |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| GetVariableDefinitions |
Get the configuration defined by this AFAnalysisRule | |
| GetVariableDefinitions(AFObject) |
Get the configuration defined by this AFAnalysisRule.
| |
| IsCompatibleAsOutput |
This method returns if the specified AFAttributeTemplate
or AFAttribute is compatible as an output.
| |
| IsModelAnalysisRule | ||
| IsTraced |
Indicates if a specified level is being traced.
| |
| MapVariable(String, AFAttribute) |
Maps a variable to the specified AFAttribute.
| |
| MapVariable(String, String) |
Maps a variable to a new attribute name.
| |
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) | |
| Publish |
The output AFAttribute values of the analysis case run are published
to the locations specified by the attribute's data reference configuration.
| |
| RecoverAnalysisRuleState |
Initializes the analysis rule state using the specified state IAFAnalysisRuleState that needs to be recovered
for this AFAnalysisRule and its children.
| |
| RefreshConfigurationAndVariableMapping |
Refresh the configuration string and variable mapping of the AFAnalysisRule, and it's child analysis rules.
| |
| Reset |
Resets any dynamic state associated with the analysis rule.
| |
| Run |
This method executes the analysis and generates analysis results.
| |
| Run(IAFAnalysisRuleState) |
Runs the analysis using the specified IAFAnalysisRuleState object.
| |
| SetSaveConfigChangesHandler |
Set the handler used for saving ConfigString changes.
| |
| SupportsChildAnalysisRule |
Determines if the specified AFPlugIn supports adding child analysis rules.
| |
| ToString |
Returns a String that represents the current object.
(Overrides AFObjectToString.) | |
| TraceData |
Output a data trace event.
| |
| TraceDetail |
Output a detail trace event.
| |
| TraceError |
Output an error trace event.
| |
| TraceEvent(AFTraceSwitchLevel, String) |
Output a trace event with a message.
| |
| TraceEvent(AFTraceSwitchLevel, String, Int32) |
Output a trace event with a message and a duration.
| |
| TraceEvent(AFTraceSwitchLevel, String, Object) |
Output a trace event as a formatted message with a variable number of arguments.
| |
| TraceInformation |
Output an information trace event.
| |
| TraceSummary |
Output a summary trace event.
| |
| TraceWarning |
Output a warning trace event.
|
See Also
In This Topic
Related Links
- ClearVariableMapForPasteOperation Method
- CollectElements Method
- CollectInputs Method
- CollectTransfers Method
- DefaultSaveConfigChanges Method
- FindAnalysisRule Method
- GetAttributeVariables Method
- GetConfiguration Method
- GetEditor(T) Method
- GetInputs Method
- GetLocalizedError Method
- GetOutputs Method
- GetOutputsForAnalyses Method
- GetOutputsForAnalysisTemplates Method
- GetTarget Method
- GetVariableDefinitions Method
- IsCompatibleAsOutput Method
- IsModelAnalysisRule Method
- IsTraced Method
- MapVariable Method
- Publish Method
- RecoverAnalysisRuleState Method
- RefreshConfigurationAndVariableMapping Method
- Reset Method
- Run Method
- SetSaveConfigChangesHandler Method
- SupportsChildAnalysisRule Method
- ToString Method
- TraceData Method
- TraceDetail Method
- TraceError Method
- TraceEvent Method
- TraceInformation Method
- TraceSummary Method
- TraceWarning Method