switch to new MPL based Fraunhofer FOKUS Public License

[senf.git] / senf / Utils / StatisticAccumulator.hh

diff --git a/senf/Utils/StatisticAccumulator.hh b/senf/Utils/StatisticAccumulator.hh
index 8bd2b32..ab76979 100644 (file)
--- a/senf/Utils/StatisticAccumulator.hh
+++ b/senf/Utils/StatisticAccumulator.hh
@@ -2,24 +2,28 @@
 //
 // Copyright (C) 2010
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Thorsten Horstmann <thorsten.horstmann@fokus.fraunhofer.de>
 //
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at 
+// http://senf.berlios.de/license.html
 //
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
 //
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the
-// Free Software Foundation, Inc.,
-// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-
+// Software distributed under the License is distributed on an "AS IS" basis, 
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+//   Thorsten Horstmann <tho@berlios.de>
 /** \file
     \brief StatisticAccumulator public header */
 
@@ -31,29 +35,40 @@
 #include <boost/cstdint.hpp>
 ///////////////////////////////hh.p////////////////////////////////////////
 namespace senf {
-    /** \brief Accumulate measurement values
-
-        The accumulator mainly do the prelimenary work for the senf::Statistic class.
-        It accumulates certain values with in an interval to be used by senf::Statistics
-
-        \li the senf::Statistics class
-        \li statistics sources
-
-        This class provides the average, standard deviation, min, max values over one
-        interval, means until clear() is called. It rather directly calculates the results
-        then collection all single values provided by calling accumulate().
-        \see senf::Statistics to process accumulated values
-        \ingroup senf_statistics
-        */
-
-  struct StatisticsData{
-    float min;
-    float max;
-    float avg;
-    float stddev;
-    boost::uint32_t count;
-  };
 
+     struct StatisticsData
+     {
+        StatisticsData( float min_, float avg_, float max_, float stddev_, boost::uint32_t count_)
+            : min(min_), avg(avg_), max(max_), stddev(stddev_), count(count_){
+        };
+        StatisticsData( StatisticsData const & other)
+            : min(other.min), avg(other.avg), max(other.max), stddev(other.stddev), count(other.count){
+        };
+        StatisticsData()
+            : min(0.0), avg(0.0), max(0.0), stddev(0.0), count(0){
+        };
+
+         float min;
+         float avg;
+         float max;
+         float stddev;
+         boost::uint32_t count;
+     };
+
+     /** \brief Accumulate measurement values
+
+         The accumulator mainly do the prelimenary work for the senf::Statistic class.
+         It accumulates certain values with in an interval to be used by senf::Statistics
+
+         \li the senf::Statistics class
+         \li statistics sources
+
+         This class provides the average, standard deviation, min, max values over one
+         interval, means until clear() is called. It rather directly calculates the results
+         then collection all single values provided by calling accumulate().
+         \see senf::Statistics to process accumulated values
+         \ingroup senf_statistics
+      */
     template <class T>
     class StatisticAccumulator
     {
@@ -66,8 +81,12 @@ namespace senf {
         /**< This member reset all values. */
         void accumulate(T value);
         ///< Gather value to be accumulated.
-        /**< This method accumulate a value.
+        /**< This method accumulates a value.
              \param[in] value to be accumulated value*/
+        void setLastAvg(T value);
+        ///< If no real data was collected, this method specifies the min/avg/max value to be returned.
+        /**< This method specifies the the min/avg/max value to be returned if no real data was colelcted
+             \param[in] value to be returned*/
 
     public:
         T     min() const;