OSIsoft.AF.Analysis Namespace
- Last UpdatedNov 18, 2025
- 8 minute read
- PI System
- AF SDK 2024 R2
- Developer
The OSIsoft.AF.Analysis namespace provides a set of classes for creating, scheduling, and executing analyses.
Classes
| Class | Description | |
|---|---|---|
| AFAdjustment |
The AFAdjustment defines a modification made to an
AFAttribute value used during within an analysis in case run.
| |
| AFAdjustments |
This is a collection of AFAdjustment objects made to
an AFAttribute value used during the run of a case.
| |
| AFAnalyses |
The collection of AFAnalysis objects is maintained
by the AFDatabase.
| |
| AFAnalysis |
The AFAnalysis is used to execute an analysis on a set of
data values for a Target.
| |
| AFAnalysisException |
AFAanlysisException Class
used for analysis errors and warnings during configuration or run time
| |
| AFAnalysisInputRange |
Defines input data ranges information for an input on AFAnalysisRule.
| |
| AFAnalysisRule |
The AFAnalysisRule defines the information needed for an
analysis of the data within a case, and executes that analysis.
| |
| AFAnalysisRuleIsModelAnalysisRuleAttribute |
Attribute used on an AFAnalysisRule to indicate that it only
supports an analysis on an AFModel target.
| |
| AFAnalysisRuleSupportsChildAnalysisRuleAttribute |
Attribute used on an AFAnalysisRule to indicate that it supports
child analysis rules to be created under it.
| |
| AFAnalysisRuleConfiguration |
The AFAnalysisRuleConfiguration object is populated by an analysis rule to describe the inputs and outputs
the analysis rule needs to run.
| |
| AFAnalysisRuleInputDefinition |
Defines an input to an AFAnalysisRule.
| |
| AFAnalysisRuleOutputDefinition |
Defines an output from an AFAnalysisRule.
| |
| AFAnalysisRuleResolvedInput |
Class for exposing the input that will be used in calculation
| |
| AFAnalysisRuleResolvedOutput |
Class for exposing the output that will be used in a calculation
| |
| AFAnalysisRules |
The collection of AFAnalysisRule objects is maintained
by the an AFAnalysisRule.
| |
| AFAnalysisRuleState |
A reference implementation of IAFAnalysisRuleState for passing target-specific state to an AFAnalysisRule.
| |
| AFAnalysisRuleVariableDefinitions |
The AFAnalysisRuleConfiguration object is populated by an analysis rule to describe the inputs and outputs
the analysis rule needs to run.
| |
| AFAnalysisService |
The AFAnalysisService object is used to provide information and perform
operations on the analysis service associated with the owning PISystem.
| |
| AFAnalysisServiceRuntimeFieldValue |
Encapsulates values that are retrieved by QueryRuntimeInformation(String, String) or QueryRuntimeInformationTObject(String, String, FuncIListAFAnalysisServiceRuntimeFieldValue, TObject) for
a simple conversion into the appropriate types for the respective fields.
| |
| AFAnalysisTemplate |
The AFAnalysisTemplate represents a template of information used
to create an AFAnalysis.
| |
| AFAnalysisTemplates |
The collection of AFAnalysisTemplate objects is maintained
by the AFDatabase.
| |
| AFAttributeVariable |
The AFAttributeVariable defines an attribute variable used in an analysis rule.
| |
| AFAttributeVariableMap |
Attribute variable mapping class.
| |
| AFAttributeVariables |
The AFAttributeVariables represents a collection of AFAttributeVariable objects.
| |
| AFCase |
The AFCase is used by an AFAnalysis to store
the data results of an analysis.
| |
| AFCaseCancelEventArgs |
Provides data for the before AFCase action events.
| |
| AFCaseEventArgs |
Provides data for the after AFCase action events.
| |
| AFCaseLog | Obsolete.
The AFCaseLog is used to store the information about validating
or running a case's analysis.
| |
| AFModelAnalysis |
The AFModelAnalysis is used to execute an analysis on a set of
data values for a Target that is an AFModel.
| |
| AFResult |
An AFResult represents the result of a model analysis for a specific
attribute specified by the Attribute property.
| |
| AFResults | ||
| AFVariableMap |
The variable mapping configuration for an AFAnalysisRule.
| |
| AFVariableMappingData |
Immutable type that defines a attribute that can be used in an analysis.
|
Structures
| Structure | Description | |
|---|---|---|
| AFInputCountData |
Encapsulates information about required input value count before and after a time such as the trigger time.
| |
| AFInputRangeData |
Encapsulates information about required time range for data.
|
Interfaces
| Interface | Description | |
|---|---|---|
| IAFAnalysisRuleState |
Defines the interface for running an analysis against the state object.
The analysis rule Run method utilizes this object to maintain state between evaluations.
| |
| IAFLocalizedErrorProvider |
An interface for a method that returns localized string for analysis rule plugin error
|
Delegates
| Delegate | Description | |
|---|---|---|
| AFAnalysisRuleSaveConfigChangesHandler |
A handler to save configuration changes.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
| AFAnalysisCalculationType |
The calculation type of an analysis.
| |
| AFAnalysisError |
Analysis error codes to be use with AFAnaysisException for configuration and run time exceptions
Error codes are used to map to resource strings
| |
| AFAnalysisErrorSeverity |
AnalysisErrorSeverity
| |
| AFAnalysisInputType |
The AFAnalysisInputType is an enumeration of the possible input types an AFAnalysisRule can define.
It specified when constructing a AFAnalysisRuleInputDefinition instance and returned by the
AFAnalysisRuleInputDefinition.InputType property.
The AFAnalysisInputType is used to decide how to populate the IAFAnalysisRuleState.Inputs
collection on the IAFAnalysisRuleState instance
passed to AFAnalysisRule.Run.
| |
| AFAnalysisOutputType |
Output type of AFAnalysis rule
| |
| AFAnalysisRuleBehaviors |
The AFDataReferenceMethod is an enumeration of the possible methods which a
data reference supports. It is returned by the
AFDataReference.SupportedMethods property.
| |
| AFAnalysisRuleStatus |
Status of an AFAnalysisRule | |
| AFAnalysisServiceCalculationMode |
Mode for queuing calculations on the analysis service.
| |
| AFAttributeVariableType |
Enumeration indicates the type of an analysis rule variable.
| |
| AFCaseAFActiveTransferStatus |
The active status of a transfer within a AFCase.
| |
| AFCaseAction |
Specifies the AFCase action that caused the event.
| |
| AFPriority |
Priority of an analysis
| |
| AFStatus |
Status of an analysis.
|
In This Topic
Related Links
- AFAdjustment Class
- AFAdjustments Class
- AFAnalyses Class
- AFAnalysis Class
- AFAnalysisCalculationType Enumeration
- AFAnalysisError Enumeration
- AFAnalysisErrorSeverity Enumeration
- AFAnalysisException Class
- AFAnalysisInputRange Class
- AFAnalysisInputType Enumeration
- AFAnalysisOutputType Enumeration
- AFAnalysisRule Class
- AFAnalysisRule.IsModelAnalysisRuleAttribute Class
- AFAnalysisRule.SaveConfigChangesHandler Delegate
- AFAnalysisRule.SupportsChildAnalysisRuleAttribute Class
- AFAnalysisRuleBehaviors Enumeration
- AFAnalysisRuleConfiguration Class
- AFAnalysisRuleInputDefinition Class
- AFAnalysisRuleOutputDefinition Class
- AFAnalysisRuleResolvedInput Class
- AFAnalysisRuleResolvedOutput Class
- AFAnalysisRules Class
- AFAnalysisRuleState Class
- AFAnalysisRuleStatus Enumeration
- AFAnalysisRuleVariableDefinitions Class
- AFAnalysisService Class
- AFAnalysisService.CalculationMode Enumeration
- AFAnalysisService.RuntimeFieldValue Class
- AFAnalysisTemplate Class
- AFAnalysisTemplates Class
- AFAttributeVariable Class
- AFAttributeVariableMap Class
- AFAttributeVariables Class
- AFAttributeVariableType Enumeration
- AFCase Class
- AFCase.AFActiveTransferStatus Enumeration
- AFCaseAction Enumeration
- AFCaseCancelEventArgs Class
- AFCaseEventArgs Class
- AFInputCountData Structure
- AFInputRangeData Structure
- AFModelAnalysis Class
- AFPriority Enumeration
- AFResult Class
- AFResults Class
- AFStatus Enumeration
- AFVariableMap Class
- AFVariableMappingData Class
- IAFAnalysisRuleState Interface
- IAFLocalizedErrorProvider Interface