Gateway to the definitions of available IC statistics.

Namespace: ININ.IceLib.Statistics
Assembly: ININ.IceLib.Statistics (in ININ.IceLib.Statistics.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public class StatisticCatalog : IStatisticCatalogWatcher
Visual Basic
Public Class StatisticCatalog _
	Implements IStatisticCatalogWatcher

Remarks

Prior to doing any work with the StatisticCatalog, StartWatching()()()() or StartWatchingAsync(AsyncCompletedEventHandler, Object) must be called.

Statistics can be retrieved by StatisticKey with GetStatisticDefinition(StatisticIdentifier), by StatisticCategory with GetStatisticDefinitions(String) or as a complete list with GetStatisticDefinitions()()()().

A StatisticCategory can be retrieved by ID with GetStatisticCategory(String) or the complete list of categories can be retrieved with GetStatisticCategories()()()().

A list of all ParameterType objects available can be retrieved with GetParameterTypes()()()() or an individual ParameterType can be retrieved by ID with GetParameterType(ParameterTypeId). GetParameterDisplayString(ParameterTypeId) will retrieve the human readable display string for a given ParameterType.

Note
For more information on getting started with statistics see Getting Started With Statistics.
Note
For for the list of available statistics see Statistics Catalog.

Examples

The IceLib SDK includes example application references to the StatisticCatalog class. Some examples are listed below.
ProjectLocation
TutorialExampleSystemStatisticsViewModel.cs, line 64, in SystemStatisticsViewModel.SessionConnectionStateChanged
SystemStatisticsViewModel.cs, line 102, in SystemStatisticsViewModel.StartWatchingCatalogCompleted
SystemStatisticsViewModel.cs, line 32, in SystemStatisticsViewModel.#ctor
SystemStatisticsViewModel._StatisticCatalog
StatisticCatalogViewModel.cs, line 153, in StatisticCatalogViewModel.SessionConnectionStateChanged
StatisticCatalogViewModel.cs, line 236, in StatisticCatalogViewModel.StartWatchingCompleted
StatisticCatalogViewModel.cs, line 32, in StatisticCatalogViewModel.#ctor
StatisticCatalogViewModel.cs, line 109, in StatisticCatalogViewModel.set_SelectedStatisticCategory
StatisticCatalogViewModel._StatisticCatalog

Inheritance Hierarchy

System..::..Object
  ININ.IceLib.Statistics..::..StatisticCatalog

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.

See Also