engagement_recognition: engagement_recognition/src/recognition/statistics/window.h Source File

00001 /*
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Copyright (c) 2010, Worcester Polytechnic Institute
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions
00009  *  are met:
00010  *
00011  *   * Redistributions of source code must retain the above copyright
00012  *     notice, this list of conditions and the following disclaimer.
00013  *   * Redistributions in binary form must reproduce the above
00014  *     copyright notice, this list of conditions and the following
00015  *     disclaimer in the documentation and/or other materials provided
00016  *     with the distribution.
00017  *   * Neither the name of Worcester Polytechnic Institute. nor the names
00018  *     of its contributors may be used to endorse or promote products
00019  *     derived from this software without specific prior written permission.
00020  *
00021  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032  *  POSSIBILITY OF SUCH DAMAGE.
00033  */
00034 
00035 #ifndef WINDOW_H_
00036 #define WINDOW_H_
00037 
00038 #include <vector>
00039 #include "connection_event.h"
00040 #include "../lib/engagement_macros.h"
00041 
00042 /*
00043  * The Window class is responsible for storing a series of events and
00044  * providing the ability to query statistics on the events for both
00045  * the entire set of events as well as just a recent window.
00046  *
00047  *  Created on: Sep 8, 2010
00048  *      Author: Brett Ponsler (bponsler (at) wpi (dot) edu)
00049  */
00050 class Window
00051 {
00052 private:
00054   std::vector<ConnectionEvent> events_;
00055 
00057   int earliest_;
00058 
00060   double window_size_;
00061 public:
00065   Window();
00066 
00070   void updateWindow();
00071 
00077   void setWindowSize(double window_size);
00078 
00084   void addEvent(ConnectionEvent event);
00085 
00091   unsigned long getTimeBetween();
00092 
00098   unsigned long getRecentMeanDelay();
00099 
00105   unsigned long getRecentMaxDelay();
00106 
00112   unsigned long getRecentMeanDuration();
00113 
00119   unsigned long getRecentMaxDuration();
00120 
00126   unsigned long getRecentMeanTBCE();
00127 
00133   unsigned long getRecentMaxTBCE();
00134 
00140   int getRecentFailureRate();
00141 };
00142 
00143 #endif /* WINDOW_H_ */