AFAnalysisService Class
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFAnalysisService object is used to provide information and perform
operations on the analysis service associated with the owning PISystem.
Inheritance Hierarchy
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class AFAnalysisService : AFObject, IAFChangedEvent, IEquatable<AFAnalysisService>
<SerializableAttribute> Public NotInheritable Class AFAnalysisService Inherits AFObject Implements IAFChangedEvent, IEquatable(Of AFAnalysisService) Dim instance As AFAnalysisService
[SerializableAttribute] public ref class AFAnalysisService sealed : public AFObject, IAFChangedEvent, IEquatable<AFAnalysisService^>
[<SealedAttribute>] [<SerializableAttribute>] type AFAnalysisService = class inherit AFObject interface IAFChangedEvent interface IEquatable<AFAnalysisService> end
The AFAnalysisService type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Host |
This property is the name of the host machine where PI Analysis Service
for this PISystem is executing.
|
| 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.) |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) |
| RuntimeInformationFields |
This property is a collection of all the fields supported by PI Analysis Service for runtime query
for this PISystem.
|
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |
Methods
| Name | Description | |
|---|---|---|
 | CanQueueCalculation |
Test if the queuing calculation option is available.
|
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) |
| Equals(AFAnalysisService) |
Indicates whether the current object is equal to another object of the same type.
|
| 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.) |
| 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.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) |
 | QueryRuntimeInformation(String, String) |
This method queries fields of analyses from PI Analysis Service for this PISystem.
|
| QueryRuntimeInformationTObject(String, String, FuncIListAFAnalysisServiceRuntimeFieldValue, TObject) |
This method allows you to customize the output after querying fields of analyses from PI Analysis Service.
|
| QueueCalculation |
This method queues analyses for calculation on PI Analysis Service for the given time range and mode.
|
| Refresh |
Refreshes the client with any changes that have been made to the analysis service since loaded.
|
| ToString |
Returns a String that represents the current object.
(Overrides AFObjectToString.) |
Events
| Name | Description | |
|---|---|---|
 | Changed |
Event is raised when the object or one of its sub-objects is changed.
|
Remarks
The analysis service is registered with the PISystem during installation.
This class can be used to interact with the analysis service in two ways: to queue calculations and query runtime information about the analysis service. For the latter, use RuntimeInformationFields to determine supported fields for the version of analysis service associated with the PISystem.