AFModelAnalysis Methods
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFModelAnalysis type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddCase | (Inherited from AFAnalysis.) |
| AddCase(AFTime) |
The AddCase method creates a new AFCase
for the analysis after the specified start time.
(Inherited from AFAnalysis.) |
| AddCase(AFTimeRuleEvent) |
The AddCase method creates a new AFCase
for the analysis after the specified AFTimeRuleEvent.
(Inherited from AFAnalysis.) |
 | ApplyChanges |
This method applies the changes to the object and makes
those changes available to other objects for the current user.
(Inherited from AFAnalysis.) |
| CheckIn |
This method checks in (commits) all the changes to the object by saving
the information to persistent storage.
(Inherited from AFAnalysis.) |
| CheckOut |
This method locks the object so that its configuration can be modified.
(Inherited from AFAnalysis.) |
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| CreateAnalysisTemplate |
Create an AFAnalysisTemplate based upon the analysis.
(Inherited from AFAnalysis.) |
| Delete |
Deletes this analysis from the AFDatabase.
(Inherited from AFAnalysis.) |
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) |
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) |
| GetHashCode |
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.) |
| GetLastCase |
Use this method to get the case with the latest start time for the analysis.
(Inherited from AFAnalysis.) |
| GetPath |
Returns the full path to the object, using just the names.
(Inherited from AFObject.) |
| GetPath(AFObject) |
Returns the path to the object relative from another object.
(Inherited from AFObject.) |
| GetPath(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.) |
| GetResults(Object, Int32, Boolean, AFAttribute, UOM) |
Use this method to get all the stored results for the attribute
of cases of the analysis limited to the specified
count beginning at the requested start time in the specified direction.
(Inherited from AFAnalysis.) |
| GetResults(AFSearchMode, Object, Object, Double, AFAttribute, UOM) | Obsolete.
Use this method to get all the stored results for the attribute
of cases of the analysis based upon the specified search criteria.
(Inherited from AFAnalysis.) |
| GetResults(AFSearchMode, Object, Object, Int32, AFAttribute, UOM) |
Use this method to get all the stored results for the attribute
of cases of the analysis between the specified start and
end times.
(Inherited from AFAnalysis.) |
| GetSecurity |
Gets the AFSecurity information of the specified security item
associated with the object.
(Inherited from AFAnalysis.) |
| GetStatus |
Get the analysis Status property immediately from the PI AF Server.
(Inherited from AFAnalysis.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsTraced |
Indicates if a specified level is being traced.
(Inherited from AFAnalysis.) |
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) |
| Refresh |
Refreshes the client with any changes that have been made to the object since loaded.
(Inherited from AFAnalysis.) |
| RemoveCase |
Removes an existing AFCase from the analysis.
(Inherited from AFAnalysis.) |
| ResetToTemplate |
This method will reset the AFAnalysis back to its template default values.
(Inherited from AFAnalysis.) |
| Run |
Execute the analysis with default values.
(Inherited from AFAnalysis.) |
| Run(AFCase) |
Execute the analysis for the specific AFCase.
(Inherited from AFAnalysis.) |
| SetStatus(AFStatus) |
Set the analysis Status property immediately in the server.
(Inherited from AFAnalysis.) |
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) |
| TraceData |
Output a data trace event.
(Inherited from AFAnalysis.) |
| TraceDetail |
Output a detail trace event.
(Inherited from AFAnalysis.) |
| TraceError |
Output an error trace event.
(Inherited from AFAnalysis.) |
| TraceEvent(AFTraceSwitchLevel, String) |
Output a trace event with a message.
(Inherited from AFAnalysis.) |
| TraceEvent(AFTraceSwitchLevel, String, Int32) |
Output a trace event with a message and a duration.
(Inherited from AFAnalysis.) |
| TraceEvent(AFTraceSwitchLevel, String, Object) |
Output a trace event as a formatted message with a variable number of arguments.
(Inherited from AFAnalysis.) |
| TraceInformation |
Output an information trace event.
(Inherited from AFAnalysis.) |
| TraceSummary |
Output a summary trace event.
(Inherited from AFAnalysis.) |
| TraceWarning |
Output a warning trace event.
(Inherited from AFAnalysis.) |
| UndoCheckOut |
This method discards all the changes to the object and all sub-objects since the
last call to CheckOut. Any changes since the check out will be lost.
(Inherited from AFAnalysis.) |