HypPerformanceMetric Class Reference

Inheritance diagram for HypPerformanceMetric:

Public Member Functions
	HypPerformanceMetric (IPMUnknown *boss)
virtual void	GetMetricInfo (PerformanceMetricIDList &metricIDs)
virtual PMString	GetMetricShortName (PerformanceMetricID metricID)
virtual PMString	GetMetricLongName (PerformanceMetricID metricID)
virtual void	DeRegisterMetric (PerformanceMetricID metricID)
virtual uint64	GetMetricValue (PerformanceMetricID metricID)
virtual void	ResetMetric (PerformanceMetricID metricID)

Additional Inherited Members
Public Types inherited from IPerformanceMetric
enum	{ kDefaultIID = IID_IPERFORMANCEMETRIC }
typedef K2Vector < PerformanceMetricID >	PerformanceMetricIDList

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * HypPerformanceMetric::HypPerformanceMetric

(

IPMUnknown *

boss

)

constructor.

Member Function Documentation

void HypPerformanceMetric::DeRegisterMetric ( PerformanceMetricID  metricID )

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.

DeRegisterMetric Cleans up

Implements IPerformanceMetric.

void HypPerformanceMetric::GetMetricInfo ( PerformanceMetricIDList &  metricIDs )

virtual

GetMetricInfo Add this plug-ins metric ids to the end of the id list

Implements IPerformanceMetric.

PMString HypPerformanceMetric::GetMetricLongName ( PerformanceMetricID  metricID )

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.

GetMetricLongName returns the description of the metric

Implements IPerformanceMetric.

PMString HypPerformanceMetric::GetMetricShortName ( PerformanceMetricID  metricID )

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.

GetMetricShortName returns the short name for the metric

Implements IPerformanceMetric.

uint64 HypPerformanceMetric::GetMetricValue ( PerformanceMetricID  metricID )

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.

GetMetricValue returns the value of the metric

Implements IPerformanceMetric.

void HypPerformanceMetric::ResetMetric ( PerformanceMetricID  metricID )

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.

ResetMetric resets the metrics to zero

Implements IPerformanceMetric.