InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IPerformanceMetric Class Referenceabstract

#include <IPerformanceMetric.h>

Inheritance diagram for IPerformanceMetric:
IPMUnknownHypPerformanceMetric

Public Types

enum  { kDefaultIID = IID_IPERFORMANCEMETRIC }
 
typedef K2Vector
< PerformanceMetricID > 		PerformanceMetricIDList
 

Public Member Functions

virtual void GetMetricInfo (PerformanceMetricIDList &metricIDs)=0
 
virtual PMString GetMetricShortName (PerformanceMetricID metricID)=0
 
virtual PMString GetMetricLongName (PerformanceMetricID metricID)=0
 
virtual void DeRegisterMetric (PerformanceMetricID metricID)=0
 
virtual uint64 GetMetricValue (PerformanceMetricID metricID)=0
 
virtual void ResetMetric (PerformanceMetricID metricID)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Abstract base class for a performance metric service provider implementation.

This implementation is queried for at startup on kPerformanceMetricService service providers. The performance metric they describe will be registered with the performance monitoring framework.

Member Function Documentation

virtual void IPerformanceMetric::DeRegisterMetric (PerformanceMetricID metricID)
pure virtual

Called when the specified performance metric is about to be de-registered.

Parameters
metricID[IN] - the id of the metric being deregistered; will be one of the ids returned from GetMetricInfo.

Implemented in HypPerformanceMetric.

virtual void IPerformanceMetric::GetMetricInfo (PerformanceMetricIDList & metricIDs)
pure virtual

Return a list of performance metric ids this implementation defines. Called at services startup time.

Returns
PerformanceMetricIDList.

Implemented in HypPerformanceMetric.

virtual PMString IPerformanceMetric::GetMetricLongName (PerformanceMetricID metricID)
pure virtual

Return the long name of the specified performance metric id. This is used as the description of the performance counter registered with PerfMon on Windows.

Parameters
metricID[IN] - the id of the metric being queried for; will be one of the ids returned from GetMetricInfo.
Returns
long name PMString.

Implemented in HypPerformanceMetric.

virtual PMString IPerformanceMetric::GetMetricShortName (PerformanceMetricID metricID)
pure virtual

Return the short name of the specified performance metric id. This is used as the name of the performance counter registered with PerfMon on Windows.

Parameters
metricID[IN] - the id of the metric being queried for; will be one of the ids returned from GetMetricInfo.
Returns
short name PMString.

Implemented in HypPerformanceMetric.

virtual uint64 IPerformanceMetric::GetMetricValue (PerformanceMetricID metricID)
pure virtual

Called to get the current value of the specified metric.

Parameters
metricID[IN] - the id of the metric being queried for; will be one of the ids returned from GetMetricInfo.
Returns
current value scaled to fit in a uint64.

Implemented in HypPerformanceMetric.

virtual void IPerformanceMetric::ResetMetric (PerformanceMetricID metricID)
pure virtual

Reset the current value of the specified performance metric.

Parameters
metricID[IN] - the id of the metric being reset; will be one of the ids returned from GetMetricInfo.
Returns
nothing.

Implemented in HypPerformanceMetric.