Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

OSIsoft.AF.Analysis Namespace

  • Last UpdatedNov 18, 2025
  • 8 minute read
OSIsoft.AF.Analysis Namespace
The OSIsoft.AF.Analysis namespace provides a set of classes for creating, scheduling, and executing analyses.

Classes

  ClassDescription
Public classCode example
AFAdjustment
The AFAdjustment defines a modification made to an AFAttribute value used during within an analysis in case run.
Public classCode example
AFAdjustments
This is a collection of AFAdjustment objects made to an AFAttribute value used during the run of a case.
Public classCode example
AFAnalyses
The collection of AFAnalysis objects is maintained by the AFDatabase.
Public classCode example
AFAnalysis
The AFAnalysis is used to execute an analysis on a set of data values for a Target.
Public class
AFAnalysisException
AFAanlysisException Class used for analysis errors and warnings during configuration or run time
Public class
AFAnalysisInputRange
Defines input data ranges information for an input on AFAnalysisRule.
Public class
AFAnalysisRule
The AFAnalysisRule defines the information needed for an analysis of the data within a case, and executes that analysis.
Public class
AFAnalysisRuleIsModelAnalysisRuleAttribute
Attribute used on an AFAnalysisRule to indicate that it only supports an analysis on an AFModel target.
Public class
AFAnalysisRuleSupportsChildAnalysisRuleAttribute
Attribute used on an AFAnalysisRule to indicate that it supports child analysis rules to be created under it.
Public class
AFAnalysisRuleConfiguration
The AFAnalysisRuleConfiguration object is populated by an analysis rule to describe the inputs and outputs the analysis rule needs to run.
Public class
AFAnalysisRuleInputDefinition
Defines an input to an AFAnalysisRule.
Public class
AFAnalysisRuleOutputDefinition
Defines an output from an AFAnalysisRule.
Public class
AFAnalysisRuleResolvedInput
Class for exposing the input that will be used in calculation
Public class
AFAnalysisRuleResolvedOutput
Class for exposing the output that will be used in a calculation
Public classCode example
AFAnalysisRules
The collection of AFAnalysisRule objects is maintained by the an AFAnalysisRule.
Public class
AFAnalysisRuleState
A reference implementation of IAFAnalysisRuleState for passing target-specific state to an AFAnalysisRule.
Public class
AFAnalysisRuleVariableDefinitions
The AFAnalysisRuleConfiguration object is populated by an analysis rule to describe the inputs and outputs the analysis rule needs to run.
Public class
AFAnalysisService
The AFAnalysisService object is used to provide information and perform operations on the analysis service associated with the owning PISystem.
Public class
AFAnalysisServiceRuntimeFieldValue
Public classCode example
AFAnalysisTemplate
The AFAnalysisTemplate represents a template of information used to create an AFAnalysis.
Public classCode example
AFAnalysisTemplates
The collection of AFAnalysisTemplate objects is maintained by the AFDatabase.
Public class
AFAttributeVariable
The AFAttributeVariable defines an attribute variable used in an analysis rule.
Public class
AFAttributeVariableMap
Attribute variable mapping class.
Public class
AFAttributeVariables
The AFAttributeVariables represents a collection of AFAttributeVariable objects.
Public classCode example
AFCase
The AFCase is used by an AFAnalysis to store the data results of an analysis.
Public class
AFCaseCancelEventArgs
Provides data for the before AFCase action events.
Public class
AFCaseEventArgs
Provides data for the after AFCase action events.
Public class
AFCaseLog Obsolete.
The AFCaseLog is used to store the information about validating or running a case's analysis.
Public classCode example
AFModelAnalysis
The AFModelAnalysis is used to execute an analysis on a set of data values for a Target that is an AFModel.
Public classCode example
AFResult
An AFResult represents the result of a model analysis for a specific attribute specified by the Attribute property.
Public classCode example
AFResults
The collection of AFResult objects for an attribute created during the run of a case is maintained by the AFCase.
Public class
AFVariableMap
The variable mapping configuration for an AFAnalysisRule.
Public class
AFVariableMappingData
Immutable type that defines a attribute that can be used in an analysis.

Structures

  StructureDescription
Public structure
AFInputCountData
Encapsulates information about required input value count before and after a time such as the trigger time.
Public structure
AFInputRangeData
Encapsulates information about required time range for data.

Interfaces

  InterfaceDescription
Public interface
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.
Public interface
IAFLocalizedErrorProvider
An interface for a method that returns localized string for analysis rule plugin error

Delegates

Enumerations

  EnumerationDescription
Public enumeration
AFAnalysisCalculationType
The calculation type of an analysis.
Public enumeration
AFAnalysisError
Analysis error codes to be use with AFAnaysisException for configuration and run time exceptions Error codes are used to map to resource strings
Public enumeration
AFAnalysisErrorSeverity
AnalysisErrorSeverity
Public enumeration
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.
Public enumeration
AFAnalysisOutputType
Output type of AFAnalysis rule
Public enumeration
AFAnalysisRuleBehaviors
The AFDataReferenceMethod is an enumeration of the possible methods which a data reference supports. It is returned by the AFDataReference.SupportedMethods property.
Public enumeration
AFAnalysisRuleStatus
Status of an AFAnalysisRule
Public enumeration
AFAnalysisServiceCalculationMode
Mode for queuing calculations on the analysis service.
Public enumeration
AFAttributeVariableType
Enumeration indicates the type of an analysis rule variable.
Public enumeration
AFCaseAFActiveTransferStatus
The active status of a transfer within a AFCase.
Public enumeration
AFCaseAction
Specifies the AFCase action that caused the event.
Public enumeration
AFPriority
Priority of an analysis
Public enumeration
AFStatus
Status of an analysis.
TitleResults for “How to create a CRG?”Also Available in