reverted changes in Statistics.[hh][cci] from rev.1829 to anable
[senf.git] / senf / Utils / Statistics.hh
index 4148ba1..cdea0da 100644 (file)
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2008
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Stefan Bund <g0dil@berlios.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):
+//   Stefan Bund <g0dil@berlios.de>
 
 /** \file
     \brief Statistics public header */
 #include <boost/utility.hpp>
 #include <boost/ptr_container/ptr_vector.hpp>
 #include <boost/signals.hpp>
-#include "Exception.hh"
 #include <senf/Utils/Logger/Logger.hh>
-#include <senf/Utils/Console/Console.hh>
+#include <senf/Utils/Console/ScopedDirectory.hh>
+#include "StatisticAccumulator.hh"
+#include "Exception.hh"
 
 //#include "Statistics.mpp"
 //-/////////////////////////////////////////////////////////////////////////////////////////////////
@@ -49,6 +55,7 @@ namespace senf {
         The statistics functionality has two parts:
 
         \li the senf::Statistics class
+        \li the senf::StatisticsAccumulator class
         \li statistics sources
 
         Each senf::Statistics instance collects information about a single parameter. Which
@@ -222,6 +229,12 @@ namespace senf {
                                              \param[in] n size of sliding average window */
 
         //\}
+        StatisticsData data();      ///< Get the Statistics data as senf::StatisticsData
+                                    /**< Return a Statistic Data object containing values
+                                         from this instance.
+                                     */
+
+
         //-////////////////////////////////////////////////////////////////////////
         // Exceptions
 
@@ -463,6 +476,18 @@ namespace senf {
                                         ///< Same as operator() with \a min == \a avg == \a max
                                         /**< Provided so a Statistics instance can be directly used
                                              as a signal target. */
+        void operator()(StatisticsData const & data);
+                                        ///< Same as operator(), but imports statistics data from a StatisticsData object
+                                        /**< Provided so a Statistics instance can be directly used
+                                             as a signal target. */
+        template <class Value>
+        void operator()(unsigned n, StatisticAccumulator<Value> & sa);
+                                        ///< Same as operator() gathers values from StatisticAccumulator
+                                        /**< Provided so a Statistics instance can be directly used
+                                             as a signal target. Caution: Clears values in
+                                             StatisticAccumulator afterwards
+                                             \param[in] n number of time-slices
+                                             \param[in] sa StatisticAccumulator*/
 
         StatisticsBase::OutputProxy<Statistics> output(unsigned n = 1u);