TimerMetricTraits.hpp

/*------------------------------------------------------------------------*/
/*                 Copyright 2010, 2011 Sandia Corporation.                     */
/*  Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive   */
/*  license for use of this work by or on behalf of the U.S. Government.  */
/*  Export of this program may require a license from the                 */
/*  United States Government.                                             */
/*------------------------------------------------------------------------*/

#ifndef stk_util_diag_TimerMetricTraits_hpp
#define stk_util_diag_TimerMetricTraits_hpp

#include <string>

namespace stk_classic {
namespace diag {

typedef unsigned long MetricsMask;

void setTimerTimeFormat(int time_format);

int getTimerTimeFormat();

enum Metrics {
  METRICS_LAP_COUNT      = 0x0001,              
  METRICS_CPU_TIME       = 0x0002,              
  METRICS_WALL_TIME      = 0x0004,              
  METRICS_MPI_COUNT      = 0x0008,              
  METRICS_MPI_BYTE_COUNT = 0x0010,              
  METRICS_HEAP_ALLOC     = 0x0020,              
  METRICS_ALL            = 0x7FFF,

  METRICS_FORCE          = 0x8000               
};


struct LapCount {};                             
struct CPUTime {};                              
struct WallTime {};                             
struct MPICount {};                             
struct MPIByteCount {};                         
struct HeapAlloc {};                            

template <class T>
struct MetricTraits;

template<>
struct MetricTraits<LapCount>
{
  typedef unsigned Type;
  enum {METRIC = METRICS_LAP_COUNT};
  static Type value_now();
  static std::string table_header();
  static std::string format(Type time);
};

template<>
struct MetricTraits<CPUTime>
{
  typedef double Type;
  enum {METRIC = METRICS_CPU_TIME};
  static Type value_now();
  static std::string table_header();
  static std::string format(Type time);
};

template<>
struct MetricTraits<WallTime>
{
  typedef double Type;
  enum {METRIC = METRICS_WALL_TIME};
  static Type value_now();
  static std::string table_header();
  static std::string format(Type time);
};

template<>
struct MetricTraits<MPICount>
{
  typedef double Type;
  enum {METRIC = METRICS_MPI_COUNT};
  static Type value_now();
  static std::string table_header();
  static std::string format(Type count);
};

template<>
struct MetricTraits<MPIByteCount>
{
  typedef double Type;
  enum {METRIC = METRICS_MPI_BYTE_COUNT};
  static Type value_now();
  static std::string table_header();
  static std::string format(Type count);
};


template<>
struct MetricTraits<HeapAlloc>
{
  typedef double Type;
  enum {METRIC = METRICS_HEAP_ALLOC};
  static Type value_now();
  static std::string table_header();
  static std::string format(Type count);
};

template <class T>
typename MetricTraits<T>::Type now() {
  return MetricTraits<T>::value_now();
}

} // namespace diag
} // namespace stk_classic

#endif // stk_util_diag_TimerMetricTraits_hpp