PerformanceStats.h

//========================================================================================
// 
// $File$
// 
// Owner: jshankar
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Contains API for getting performance statistics.
// 
//========================================================================================

#ifndef __PerformanceStats__
#define __PerformanceStats__

#include "OMTypes.h"
#include "IPerformanceMetric.h"

class PerformanceStats
{
public:
 enum EDoWhat { eGetValue, eResetValue /* if applicable */};

 typedef uint64 (*CallBack)(EDoWhat doWhat, void *refPtr, PerformanceMetricID counter);

 static uint64 GetValue(PerformanceMetricID counter);
 static void ResetValue(PerformanceMetricID counter);

 static void RegisterCounter(PerformanceMetricID counter, CallBack callback, void* refPtr, const PMString &shortName, const PMString &longName);
 static void RegisterCounter(PerformanceMetricID counter, ClassID counterProvider, const PMString &shortName, const PMString &longName);

 static void DeRegisterCounter(PerformanceMetricID counter);


 static void GetAllMetricIDs(IPerformanceMetric::PerformanceMetricIDList &metrics);
 static PMString GetMetricShortName(PerformanceMetricID counter);
 static PMString GetMetricLongName(PerformanceMetricID counter);
 static void Startup();
 static void Shutdown();
};

class StaticPerfCallbackRegister
{
public:
 StaticPerfCallbackRegister(PerformanceMetricID counter, PerformanceStats::CallBack callback, void* refPtr, const PMString &shortName, const PMString &longName) :
 fCounterID(counter)
 {
 PerformanceStats::RegisterCounter(counter, callback, refPtr, shortName, longName);
 }
 ~StaticPerfCallbackRegister()
 {
 PerformanceStats::DeRegisterCounter(fCounterID) ;
 }
private:
 PerformanceMetricID fCounterID;
};

#endif // __PerformanceStats__