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

AF SDK Reference

AFAnalysisRuleVariableDefinitions Class

  • Last UpdatedNov 18, 2025
  • 4 minute read
AFAnalysisRuleVariableDefinitions Class
The AFAnalysisRuleConfiguration object is populated by an analysis rule to describe the inputs and outputs the analysis rule needs to run.

Inheritance Hierarchy

SystemObject
  OSIsoft.AF.AnalysisAFAnalysisRuleVariableDefinitions

Namespace:  OSIsoft.AF.Analysis
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public sealed class AFAnalysisRuleVariableDefinitions
Public NotInheritable Class AFAnalysisRuleVariableDefinitions

Dim instance As AFAnalysisRuleVariableDefinitions
public ref class AFAnalysisRuleVariableDefinitions sealed
[<SealedAttribute>]
type AFAnalysisRuleVariableDefinitions =  class end

The AFAnalysisRuleVariableDefinitions type exposes the following members.

Constructors

  NameDescription
Public method
AFAnalysisRuleVariableDefinitions(AFAnalysisRule)
Constructs an instance of AFAnalysisRuleVariableDefinitions using the specified AFAnalysisRule.
Public method
AFAnalysisRuleVariableDefinitions(AFAnalysisRule, AFObject)
Constructs an instance of AFAnalysisRuleVariableDefinitions using the specified AFAnalysisRule and the specified target.

Properties

  NameDescription
Public property
AnalysisRule
The AFAnalysisRule this configuration was done against.
Public property
ChildAnalysisRuleVariableDefinitions
A list of the configuration of child analysis rules to use in configuring the specified analysis rule.
Public property
ConfigurationExceptions
A collection of configuration exceptions reported by the AFAnalysisRule during initialization.
Public property
HasExceptions
True if the analysis rule reported any configuration exceptions.
Public property
Inputs
A collection of input variables used by an AFAnalysisRule.
Public property
IsInputResolutionSuppressed
True if the outputs of the analysis rule should be resolved
Public property
IsOutputResolutionSuppressed
True if the outputs of the analysis rule should be resolved
Public property
Outputs
A collection of output variables used by an AFAnalysisRule.
Public property
PrivateData
A location for a stateful AFAnalysisRule to store its instance-specific data.
Public property
Target
The target that the AFAnalysisRule should configure itself against.

Methods

  NameDescription
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
ToString
Returns a string that represents the current object.
(Inherited from Object.)

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

See Also

TitleResults for “How to create a CRG?”Also Available in