Click or drag to resize
OSIsoft, LLC

AFAnalysisRule Class

The AFAnalysisRule defines the information needed for an analysis of the data within a case, and executes that analysis.

Inheritance Hierarchy
SystemObject
  OSIsoft.AFAFObject
    OSIsoft.AF.AnalysisAFAnalysisRule

Namespace:  OSIsoft.AF.Analysis
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
[SerializableAttribute]
public abstract class AFAnalysisRule : AFObject, 
	IComparable<AFAnalysisRule>, IAFTrace, IAFLocalizedErrorProvider

The AFAnalysisRule type exposes the following members.

Properties
  NameDescription
Public propertyAnalysis
This property returns the analysis that owns this object.
Public propertyAnalysisRules
This read-only property returns the child analysis rules.
Public propertyAnalysisTemplate
This property returns the analysis template that owns this object.
Public propertyConfigString
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.
Public propertyCurrentCase
This property returns the current case associated with the AnalysisRule.
Public propertyDatabase
This read-only property returns the AFDatabase where this object is defined.
Public propertyDescription
Read-only property that provides more detailed description of the object.
Public propertyDisplayString
Returns the configuration of the AFAnalysisRule for display purposes.
Public propertyEditorType
This method returns the Type of the editor that is used to configure this analysis rule.
Public propertyHasChildren
This read-only property returns if the analysis rule has child analysis rules.
Public propertyID
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.)
Public propertyIdentity
This read-only property contains identity of the object.
(Inherited from AFObject.)
Public propertyIsConfigured
This method returns if the analysis rule instance is properly configured.
Public propertyIsDeleted
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.)
Public propertyIsInitializing
Indicates that the AFAnalysisRule is in the process of being initialized.
Public propertyName
Read-only property that identifies the name of the object.
Public propertyParent
Returns the parent analysis rule which owns this analysis rule.
Public propertyPISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public propertyPlugIn
This read-only property returns the AFPlugIn used to create this instance of the plugin.
Public propertySimplifiedConfigString
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).
Public propertySimplifiedVariableMapping
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.
Public propertySupportedBehaviors
Defines the behavior supported by this analysis rule. If the analysis rule supports child analysis rules, their supported behavior is accounted for.
Public propertyUniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)
Public propertyVariableMap
A collection of AFVariableMappingDatas defined for this AFAnalysisRule. Modifying this collection is preferred to editing the VariableMapping string directly.
Public propertyVariableMapping
This property represents the current variable mapping for the Analysis Rule.
Top
Methods
  NameDescription
Public methodClearVariableMapForPasteOperation
Clear the variable map logic when pasting the analysis rule.
Public methodCollectElements
This method collects the elements that are active for the current case.
Public methodCollectInputs
This method is an optional method which allows the analysis rule to obtain the input values necessary to start an analysis.
Public methodCollectTransfers
This method collects the transfers that are active for the current case.
Public methodCompareTo(Object)
Compares this instance with a specified Object.
(Inherited from AFObject.)
Public methodCompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public methodDefaultSaveConfigChanges
Called by the protected SaveConfigChanges method to perform the default actions to save the configuration changes.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.)
Public methodEquals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public methodStatic memberFindAnalysisRule(AFAnalysis, Guid)
Retrieves the AFAnalysisRule object from the AFAnalysis with the specified unique identifier.
Public methodStatic memberFindAnalysisRule(AFAnalysisTemplate, Guid)
Retrieves the AFAnalysisRule object from the AFAnalysisTemplate with the specified unique identifier.
Public methodGetAttributeVariables
Returns all the attribute variables.
Public methodGetConfiguration
Get the configuration defined by this AFAnalysisRule for its current target.
Public methodGetConfiguration(AFObject)
Get the configuration defined by this AFAnalysisRule for the specified target.
Public methodGetEditorT
Returns an instance of an editor of the specified type.
Public methodGetHashCode
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.)
Public methodGetInputs
This method provides the analysis rule a mechanism to specify the attributes it will use during its analysis.
Public methodGetLocalizedError
This method gets a localized string for errors associated with the AFAnalysisRule.
Public methodGetOutputs
This method provides the analysis rule a mechanism to specify the attributes it will output during its analysis.
Public methodStatic memberGetOutputsForAnalyses
Returns a mapping of AFAttributes to the AFAnalysis that outputs values to them.
Public methodStatic memberGetOutputsForAnalysisTemplates
Returns a mapping of AFAttributeTemplates to the AFAnalysisTemplate that outputs values to them.
Public methodGetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public methodGetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public methodGetPath(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.)
Public methodStatic memberGetTarget
Get the target associated with the specified AFAnalysisRule.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetVariableDefinitions
Get the configuration defined by this AFAnalysisRule
Public methodGetVariableDefinitions(AFObject)
Get the configuration defined by this AFAnalysisRule.
Public methodStatic memberIsCompatibleAsOutput
This method returns if the specified AFAttributeTemplate or AFAttribute is compatible as an output.
Public methodStatic memberIsModelAnalysisRule
Determines if the specified AFPlugIn only supports an analysis on an AFModel target.
Public methodIsTraced
Indicates if a specified level is being traced.
Public methodMapVariable(String, AFAttribute)
Maps a variable to the specified AFAttribute.
Public methodMapVariable(String, String)
Maps a variable to a new attribute name.
Public methodPersist
This method returns the persistence string for the object.
(Inherited from AFObject.)
Public methodPublish
The output AFAttribute values of the analysis case run are published to the locations specified by the attribute's data reference configuration.
Public methodRecoverAnalysisRuleState
Initializes the analysis rule state using the specified state IAFAnalysisRuleState that needs to be recovered for this AFAnalysisRule and its children.
Public methodRefreshConfigurationAndVariableMapping
Refresh the configuration string and variable mapping of the AFAnalysisRule, and it's child analysis rules.
Public methodReset
Resets any dynamic state associated with the analysis rule.
Public methodRun
This method executes the analysis and generates analysis results.
Public methodRun(IAFAnalysisRuleState)
Runs the analysis using the specified IAFAnalysisRuleState object.
Public methodSetSaveConfigChangesHandler
Set the handler used for saving ConfigString changes.
Public methodStatic memberSupportsChildAnalysisRule
Determines if the specified AFPlugIn supports adding child analysis rules.
Public methodToString
Returns a String that represents the current object.
(Overrides AFObjectToString.)
Public methodTraceData
Output a data trace event.
Public methodTraceDetail
Output a detail trace event.
Public methodTraceError
Output an error trace event.
Public methodTraceEvent(AFTraceSwitchLevel, String)
Output a trace event with a message.
Public methodTraceEvent(AFTraceSwitchLevel, String, Int32)
Output a trace event with a message and a duration.
Public methodTraceEvent(AFTraceSwitchLevel, String, Object)
Output a trace event as a formatted message with a variable number of arguments.
Public methodTraceInformation
Output an information trace event.
Public methodTraceSummary
Output a summary trace event.
Public methodTraceWarning
Output a warning trace event.
Top
Remarks
Analysis Rules are defined and implemented by AFPlugIns which inherit from this abstract class.
Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
See Also
Enabling Operational Intelligence