AFAnalysis Methods
- Last UpdatedNov 18, 2025
- 11 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFAnalysis type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddCase | |
| AddCase(AFTime) |
The AddCase method creates a new AFCase
for the analysis after the specified start time.
|
| AddCase(AFTimeRuleEvent) |
The AddCase method creates a new AFCase
for the analysis after the specified AFTimeRuleEvent.
|
 | ApplyChanges |
This method applies the changes to the object and makes
those changes available to other objects for the current user.
|
| CheckIn |
This method checks in (commits) all the changes to the object by saving
the information to persistent storage.
|
| CheckOut |
This method locks the object so that its configuration can be modified.
|
 | CheckOutAnalyses |
Check out the objects with the specified unique identifiers at the specified query date.
|
| 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.
|
| Delete |
Deletes this analysis from the AFDatabase.
|
| DeleteAnalyses |
Delete the objects with the specified unique identifiers.
|
| 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.) |
| FindAnalyses(PISystem, Guid, Object) |
Performs a search within the PISystem to retrieve a collection
of AFAnalysis objects with the specified list of unique identifiers.
|
| FindAnalyses(AFObject, AFSortField, AFSortOrder, Int32) | Obsolete.
Performs a non-paged search within the AFDatabase to retrieve a collection
of AFAnalysis objects with the specified target.
|
| FindAnalyses(AFDatabase, String, AFSearchField, AFSortField, AFSortOrder, Int32) |
Performs a non-paged text search within the AFDatabase to retrieve a collection
of AFAnalysis objects which have a field that match the specified query string.
|
| FindAnalyses(AFObject, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Performs a paged search within the AFDatabase to retrieve a collection
of AFAnalysis objects with the specified target.
|
| FindAnalyses(AFDatabase, String, AFSearchField, AFSortField, AFSortOrder, Int32, Int32, Int32) |
Performs a paged search within the AFDatabase to retrieve a collection
of AFAnalysis objects which have a field that match the specified query string.
|
| FindAnalyses(AFDatabase, String, String, NullableInt16, AFCategory, AFAnalysisTemplate, AFElement, AFStatus, AFSortField, AFSortOrder, Int32, Int32) | Obsolete.
Performs a paged search within the AFDatabase to retrieve a collection
of AFAnalysis objects that match the specified query strings and
additional filters.
|
| FindAnalysesByGroupID(AFDatabase, Int16, AFSortField, AFSortOrder, Int32) | Obsolete.
Performs a non-paged search within the AFDatabase to retrieve a collection
of AFAnalysis objects with the specified group identifier.
|
| FindAnalysesByGroupID(PISystem, Int16, AFSortField, AFSortOrder, Int32) | Obsolete.
Performs a non-paged search to retrieve a collection of all AFAnalysis objects
in the specified PISystem with the specified group identifier.
|
| FindAnalysesByGroupID(AFDatabase, Int16, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Performs a paged search within the AFDatabase to retrieve a collection
of AFAnalysis objects with the specified group identifier.
|
| FindAnalysesByGroupID(PISystem, Int16, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Performs a paged search to retrieve a collection of all AFAnalysis objects
in the specified PISystem with the specified group identifier.
|
| FindAnalysesByTemplate(AFDatabase, AFAnalysisTemplate, AFSortField, AFSortOrder, Int32, Int32) | Obsolete.
Retrieves a paged collection of AFAnalysis objects that are instantiated from the specified
AFAnalysisTemplate without returning the total count.
|
| FindAnalysesByTemplate(AFDatabase, AFAnalysisTemplate, AFSortField, AFSortOrder, Int32, Int32, Int32) | Obsolete.
Retrieves a paged collection of AFAnalysis objects that are instantiated from the specified
AFAnalysisTemplate.
|
| FindAnalysis(PISystem, Guid) |
Retrieves the AFAnalysis object with the specified unique identifier
at the AFTime.MaxValue query date.
|
| FindAnalysis(PISystem, Guid, Object) |
Retrieves the AFAnalysis object with the specified unique identifier
at the specified query date.
|
| FindAnalysisGroupIDs | |
| GetCounts(AFDatabase) |
Get the number of analyses for each status.
|
| GetCountsT(AFDatabase) |
Get the number of analyses for each filter.
|
| 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.
|
| 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.
|
| 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.
|
| 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.
|
| GetSecurity |
Gets the AFSecurity information of the specified security item
associated with the object.
|
| GetStatus |
Get the analysis Status property immediately from the PI AF Server.
|
| GetStatus(IListAFAnalysis) |
Get the status for the list of specified analyses from the PI AF Server.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsTraced |
Indicates if a specified level is being traced.
|
| LoadAnalyses(IListAFAnalysis) |
Loads the specified list AFAnalysis objects.
|
| LoadAnalyses(PISystem, Guid, Object) |
Loads the AFAnalysis objects with the specified unique identifiers
at the specified query date.
|
| LoadTargets |
Loads the Target of the specified list of AFAnalysis objects.
|
| 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.
|
| RemoveCase |
Removes an existing AFCase from the analysis.
|
| ResetToTemplate |
This method will reset the AFAnalysis back to its template default values.
|
| Run |
Execute the analysis with default values.
|
| Run(AFCase) |
Execute the analysis for the specific AFCase.
|
| SetStatus(AFStatus) |
Set the analysis Status property immediately in the server.
|
| SetStatus(IListAFAnalysis, AFStatus) |
Set the list of analyses to the specified status.
|
| SetStatus(AFDatabase, AFObject, AFStatus, AFStatus) |
Sets all the analyses based upon a filter object to the specified status.
|
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) |
| TraceData |
Output a data trace event.
|
| TraceDetail |
Output a detail trace event.
|
| TraceError |
Output an error trace event.
|
| TraceEvent(AFTraceSwitchLevel, String) |
Output a trace event with a message.
|
| TraceEvent(AFTraceSwitchLevel, String, Int32) |
Output a trace event with a message and a duration.
|
| TraceEvent(AFTraceSwitchLevel, String, Object) |
Output a trace event as a formatted message with a variable number of arguments.
|
| TraceInformation |
Output an information trace event.
|
| TraceSummary |
Output a summary trace event.
|
| TraceWarning |
Output a warning trace event.
|
| 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.
|
See Also
In This Topic
Related Links
- AddCase Method
- ApplyChanges Method
- CheckIn Method
- CheckOut Method
- CheckOutAnalyses Method
- CreateAnalysisTemplate Method
- Delete Method
- DeleteAnalyses Method
- FindAnalyses Method
- FindAnalysesByGroupID Method
- FindAnalysesByTemplate Method
- FindAnalysis Method
- FindAnalysisGroupIDs Method
- GetCounts Method
- GetLastCase Method
- GetResults Method
- GetSecurity Method
- GetStatus Method
- IsTraced Method
- LoadAnalyses Method
- LoadTargets Method
- Refresh Method
- RemoveCase Method
- ResetToTemplate Method
- Run Method
- SetStatus Method
- TraceData Method
- TraceDetail Method
- TraceError Method
- TraceEvent Method
- TraceInformation Method
- TraceSummary Method
- TraceWarning Method
- UndoCheckOut Method