ACE/ace/Basic_Stats.h

   1
   2 //=============================================================================
   3 /**
   4  *  @file    Basic_Stats.h
   5  *
   6  *  @author Carlos O'Ryan <coryan@uci.edu>
   7  */
   8 //=============================================================================
   9
  10 #ifndef ACE_BASIC_STATS_H
  11 #define ACE_BASIC_STATS_H
  12 #include /**/ "ace/pre.h"
  13
  14 #include /**/ "ace/config-all.h"
  15 #include "ace/Basic_Types.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  22
  23 /// Collect basic stats about a series of samples
  24 /**
  25  * Compute the average and standard deviation (aka jitter) for an
  26  * arbitrary number of samples, using constant space.
  27  * Normally used for latency statistics.
  28  */
  29 class ACE_Export ACE_Basic_Stats
  30 {
  31 public:
  32 #if !defined (ACE_WIN32)
  33    typedef ACE_UINT32 scale_factor_type;
  34 #else
  35    typedef ACE_UINT64 scale_factor_type;
  36 #endif
  37
  38   /// Constructor
  39   /**
  40    * The number of samples is pre-allocated, and cannot changes once
  41    * the class is initialized.
  42    */
  43   ACE_Basic_Stats (void);
  44
  45   /// The number of samples received so far
  46   ACE_UINT32 samples_count (void) const;
  47
  48   /// Record one sample.
  49   void sample (ACE_UINT64 value);
  50
  51   /// Update the values to reflect the stats in @a rhs.
  52   void accumulate (const ACE_Basic_Stats &rhs);
  53
  54   /// Dump all the samples
  55   /**
  56    * Prints out the results, using @a msg as a prefix for each message and
  57    * scaling all the numbers by @a scale_factor. The latter is useful because
  58    * high resolution timer samples are acquired in clock ticks, but often
  59    * presented in microseconds.
  60    */
  61   void dump_results (const ACE_TCHAR *msg,
  62                      scale_factor_type scale_factor) const;
  63
  64   /// The number of samples
  65   ACE_UINT32 samples_count_;
  66
  67   /// The minimum value
  68   ACE_UINT64 min_;
  69
  70   /// The number of the sample that had the minimum value
  71   ACE_UINT32 min_at_;
  72
  73   /// The maximum value
  74   ACE_UINT64 max_;
  75
  76   /// The number of the sample that had the maximum value
  77   ACE_UINT32 max_at_;
  78
  79   /// The sum of all the values
  80   ACE_UINT64 sum_;
  81 };
  82
  83 ACE_END_VERSIONED_NAMESPACE_DECL
  84
  85 #if defined (__ACE_INLINE__)
  86 #include "ace/Basic_Stats.inl"
  87 #endif /* __ACE_INLINE__ */
  88
  89 #include /**/ "ace/post.h"
  90 #endif /* ACE_BASIC_STATS_H */