AFAnalysis.GetCounts(T) Method (AFDatabase)
- Last UpdatedJan 12, 2026
- 3 minute read
- PI System
- AF SDK 3.2.0
- Developer
Get the number of analyses for each filter.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.2.0.7
Syntax
public static IList<KeyValuePair<T, int>> GetCounts<T>( AFDatabase database ) where T : AFObject
Public Shared Function GetCounts(Of T As AFObject) ( database As AFDatabase ) As IList(Of KeyValuePair(Of T, Integer)) Dim database As AFDatabase Dim returnValue As IList(Of KeyValuePair(Of T, Integer)) returnValue = AFAnalysis.GetCounts(database)
public: generic<typename T> where T : AFObject static IList<KeyValuePair<T, int>>^ GetCounts( AFDatabase^ database )
static member GetCounts : database : AFDatabase -> IList<KeyValuePair<'T, int>> when 'T : AFObject
Parameters
- database
- Type: OSIsoft.AFAFDatabase
The database to search for analysis counts by filter.
Type Parameters
- T
- The type of objects used to filter analyses. The following types are supported: AFAnalysisTemplate, AFCategory.
Return Value
Type: IListKeyValuePairT, Int32Returns a list of KeyValuePairTKey, TValue items where the key is the filter object of the analyses and the value is the number of analyses associated to the filter object. The key will be for the analyses that do not have the filter object.
Remarks
This method will make one call to the server to get the number of analyses
associated with each filter object.
For a filter type of AFAnalysisTemplate, this method will return
the number of analyses created from each analysis template.
For a filter type of AFCategory, this method will return
the number of analyses for each analysis category.
Examples
// This example demonstrates how to call the GetCounts method to return // the number of analyses based upon different filters. // Get the Database PISystems myPISystems = new PISystems(); PISystem myPISystem = myPISystems.DefaultPISystem; AFDatabase myDB = myPISystem.Databases.DefaultDatabase; // Create some filter objects AFCategory myCategory1 = myDB.AnalysisCategories.Add("MyCategory#1"); AFCategory myCategory2 = myDB.AnalysisCategories.Add("MyCategory#2"); AFAnalysisTemplate myTemplate = myDB.AnalysisTemplates.Add("MyTemplate#1"); myTemplate.Categories.Add(myCategory1); // Create some Analyses AFAnalysis myAnalysis0 = new AFAnalysis(myDB, "MyAnalysis#0"); myAnalysis0.Description = "This is the analysis with no categories or template"; myAnalysis0.SetStatus(AFStatus.Enabled); AFAnalysis myAnalysis1 = new AFAnalysis(myDB, "MyAnalysis#1", myTemplate); myAnalysis1.Description = "This is the first analysis example"; myAnalysis1.Categories.Add(myCategory2); myAnalysis1.SetStatus(AFStatus.Enabled); AFAnalysis myAnalysis2 = new AFAnalysis(myDB, "MyAnalysis#2"); myAnalysis2.Description = "This is the second analysis example"; myAnalysis2.Categories.Add(myCategory2); myAnalysis2.SetStatus(AFStatus.NotReady); myDB.CheckIn(); // Get analysis counts by Status and display results IList<KeyValuePair<AFStatus, int>> statusCounts = AFAnalysis.GetCounts(myDB); foreach (var item in statusCounts) { Console.WriteLine("{0} = {1}", item.Key, item.Value); } // Get analysis counts by Category and display results IList<KeyValuePair<AFCategory, int>> catCounts = AFAnalysis.GetCounts<AFCategory>(myDB); foreach (var item in catCounts) { Console.WriteLine("{0} = {1}", item.Key, item.Value); } // Get analysis counts by Template and display results IList<KeyValuePair<AFAnalysisTemplate, int>> tmplCounts = AFAnalysis.GetCounts<AFAnalysisTemplate>(myDB); foreach (var item in tmplCounts) { Console.WriteLine("{0} = {1}", item.Key, item.Value); }