AFModelAnalysis Properties
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFModelAnalysis type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| AnalysisRule |
The instance of the analysis rule used by the AFAnalysis to
run the analysis.
(Inherited from AFAnalysis.) | |
| AnalysisRulePlugIn |
The analysis rule plugin property is used to specify which
analysis rule will be used by the AFAnalysis to run the analysis.
(Inherited from AFAnalysis.) | |
| AutoCreated |
This read-only property indicates if this analysis was automatically created by the server.
(Inherited from AFAnalysis.) | |
| CaseTemplate |
The AFElementTemplate that is used when creating a new AFCase
using one of the AddCase Overload methods.
(Inherited from AFAnalysis.) | |
| Categories |
This is a user-defined collection of categories for the object that can be used for
querying and/or reporting purposes.
(Inherited from AFAnalysis.) | |
| CategoriesString |
This read-only property returns the list of categories in a string separated by semicolons.
(Inherited from AFAnalysis.) | |
| CheckOutInfo |
This read-only property returns the checked out status information for the object.
(Inherited from AFAnalysis.) | |
| Database |
This read-only property returns the AFDatabase where this object is defined.
(Inherited from AFAnalysis.) | |
| Description |
Read/write property that provides a more detailed description of the object.
(Inherited from AFAnalysis.) | |
| ExtendedProperties |
A dictionary of extended properties that can be used to store application specific information.
(Inherited from AFAnalysis.) | |
| GroupID |
Indicates the group identifier for the analysis.
(Inherited from AFAnalysis.) | |
| HasNotification |
This read-only property indicates if there is an AFNotification
associated with this analysis.
(Inherited from AFAnalysis.) | |
| HasTarget |
This read-only property indicates if there is a target
associated with this analysis.
(Inherited from AFAnalysis.) | |
| HasTemplate |
This read-only property indicates if this analysis is defined by an AFAnalysisTemplate.
(Inherited from AFAnalysis.) | |
| ID |
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.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) | |
| IsConfigured |
This method returns if the analysis rule instance is properly configured.
(Inherited from AFAnalysis.) | |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsDirty |
This read-only property indicates whether the object has been modified since the
last save to the PI AF Server.
(Inherited from AFAnalysis.) | |
| IsNew |
This read-only property indicates whether the object is new and has never been saved
to the PI AF Server.
(Inherited from AFAnalysis.) | |
| IsTimeRuleDefinedByTemplate |
This read-only property indicates if the TimeRule is fully
defined by the AFAnalysisTemplate.
(Inherited from AFAnalysis.) | |
| MaximumQueueSize |
The maximum queue size for the analysis.
(Inherited from AFAnalysis.) | |
| Model | ||
| Name |
This property defines the name that identifies the object.
(Inherited from AFAnalysis.) | |
| Notification |
This property returns the AFNotification that is associated with
this AFAnalysis.
(Inherited from AFAnalysis.) | |
| OutputTime |
The analysis output time offset.
(Inherited from AFAnalysis.) | |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| Priority |
The priority of the analysis.
(Inherited from AFAnalysis.) | |
| PublishResults |
This property indicates if the case results should automatically be published after
an analysis is run.
(Inherited from AFAnalysis.) | |
| Security |
This read-only property returns the AFSecurity information for the object.
(Inherited from AFAnalysis.) | |
| Status |
The current analysis status.
(Inherited from AFAnalysis.) | |
| Target |
Gets and sets the target of the analysis.
(Inherited from AFAnalysis.) | |
| Template |
This property returns the AFAnalysisTemplate
that was used to create this AFAnalysis.
(Inherited from AFAnalysis.) | |
| TimeRule |
The instance of the time rule used by the AFAnalysis to
determine when the next analysis should be run.
(Inherited from AFAnalysis.) | |
| TimeRulePlugIn |
The time rule plugin property is used to specify which
time rule will be used by the AFAnalysis to determine when the
analysis runs.
(Inherited from AFAnalysis.) | |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |