AFAnalysis Properties

The instance of the analysis rule used by the AFAnalysis to run the analysis.

The analysis rule plugin property is used to specify which analysis rule will be used by the AFAnalysis to run the analysis.

This read-only property indicates if this analysis was automatically created by the server.

The AFElementTemplate that is used when creating a new AFCase using one of the AddCase Overload methods.

This is a user-defined collection of categories for the object that can be used for querying and/or reporting purposes.

This read-only property returns the list of categories in a string separated by semicolons.

This read-only property returns the checked out status information for the object.

This read-only property returns the AFDatabase where this object is defined.

Read/write property that provides a more detailed description of the object.

A dictionary of extended properties that can be used to store application specific information.

Indicates the group identifier for the analysis.

This read-only property indicates if there is an AFNotification associated with this analysis.

This read-only property indicates if there is a target associated with this analysis.

This read-only property indicates if this analysis is defined by an AFAnalysisTemplate.

Read-only property that provides a unique identifier for the object to be used for quick access that is not dependent upon the index.

This read-only property contains identity of the object.

This method returns if the analysis rule instance is properly configured.

This read-only property indicates whether the object has been deleted.

This read-only property indicates whether the object has been modified since the last save to the PI AF Server.

This read-only property indicates whether the object is new and has never been saved to the PI AF Server.

This read-only property indicates if the TimeRule is fully defined by the AFAnalysisTemplate.

The maximum queue size for the analysis.

This property defines the name that identifies the object.

This property returns the AFNotification that is associated with this AFAnalysis.

The analysis output time offset.

This read-only property allows access to the PISystem associated with this object.

The priority of the analysis.

This property indicates if the case results should automatically be published after an analysis is run.

This read-only property returns the AFSecurity information for the object.

The current analysis status.

Gets and sets the target of the analysis.

This property returns the AFAnalysisTemplate that was used to create this AFAnalysis.

The instance of the time rule used by the AFAnalysis to determine when the next analysis should be run.

The time rule plugin property is used to specify which time rule will be used by the AFAnalysis to determine when the analysis runs.

Read-only property that provides the object's ID as a String.