Click or drag to resize
OSIsoft, LLC

AFAnalysis Properties

The AFAnalysis type exposes the following members.

Properties
  NameDescription
Public propertyAnalysisRule
The instance of the analysis rule used by the AFAnalysis to run the analysis.
Public propertyAnalysisRulePlugIn
The analysis rule plugin property is used to specify which analysis rule will be used by the AFAnalysis to run the analysis.
Public propertyAutoCreated
This read-only property indicates if this analysis was automatically created by the server.
Public propertyCaseTemplate
The AFElementTemplate that is used when creating a new AFCase using one of the AddCase Overload methods.
Public propertyCategories
This is a user-defined collection of categories for the object that can be used for querying and/or reporting purposes.
Public propertyCategoriesString
This read-only property returns the list of categories in a string separated by semicolons.
Public propertyCheckOutInfo
This read-only property returns the checked out status information for the object.
Public propertyDatabase
This read-only property returns the AFDatabase where this object is defined.
Public propertyDescription
Read/write property that provides a more detailed description of the object.
Public propertyExtendedProperties
A dictionary of extended properties that can be used to store application specific information.
Public propertyGroupID
Indicates the group identifier for the analysis.
Public propertyHasNotification
This read-only property indicates if there is an AFNotification associated with this analysis.
Public propertyHasTarget
This read-only property indicates if there is a target associated with this analysis.
Public propertyHasTemplate
This read-only property indicates if this analysis is defined by an AFAnalysisTemplate.
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 propertyIsDirty
This read-only property indicates whether the object has been modified since the last save to the PI AF Server.
Public propertyIsNew
This read-only property indicates whether the object is new and has never been saved to the PI AF Server.
Public propertyIsTimeRuleDefinedByTemplate
This read-only property indicates if the TimeRule is fully defined by the AFAnalysisTemplate.
Public propertyMaximumQueueSize
The maximum queue size for the analysis.
Public propertyName
This property defines the name that identifies the object.
Public propertyNotification
This property returns the AFNotification that is associated with this AFAnalysis.
Public propertyOutputTime
The analysis output time offset.
Public propertyPISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public propertyPriority
The priority of the analysis.
Public propertyPublishResults
This property indicates if the case results should automatically be published after an analysis is run.
Public propertySecurity
This read-only property returns the AFSecurity information for the object.
Public propertyStatus
The current analysis status.
Public propertyTarget
Gets and sets the target of the analysis.
Public propertyTemplate
This property returns the AFAnalysisTemplate that was used to create this AFAnalysis.
Public propertyTimeRule
The instance of the time rule used by the AFAnalysis to determine when the next analysis should be run.
Public propertyTimeRulePlugIn
The time rule plugin property is used to specify which time rule will be used by the AFAnalysis to determine when the analysis runs.
Public propertyUniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)
Top
See Also
Enabling Operational Intelligence