engagement_recognition: engagement_recognition/src/recognition/statistics/timeline.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 #ifndef _TIMELINE_H
00035 #define _TIMELINE_H
00036 
00037 #include <vector>
00038 #include <ros/ros.h>
00039 #include "../lib/engagement_macros.h"
00040 
00041 #include "window.h"
00042 #include "duration.h"
00043 
00055 class Timeline
00056 {
00057 private:
00059   unsigned long interaction_start_time_;
00060 
00062   double window_size_;
00063 
00065   int num_failures_;
00066 
00068   Window all_events_;
00069   Window success_events_;
00070 
00072   Duration delay_time_;
00074   Duration duration_time_;
00076   Duration between_time_;
00077 
00081   void updateWindow();
00082 public:
00086   Timeline();
00087 
00093   void setWindowSize(double window_size);
00094 
00100   double getWindowSize();
00101 
00112   void addEvent(std::string type, bool success, unsigned long start,
00113                 unsigned long delay, unsigned long duration, std::string data);
00114 
00120   unsigned long getMeanDelay();
00121 
00127   unsigned long getMaxDelay();
00128 
00134   unsigned long getRecentMeanDelay();
00135 
00141   unsigned long getRecentMaxDelay();
00142 
00148   unsigned long getMeanDuration();
00149 
00155   unsigned long getMaxDuration();
00156 
00162   unsigned long getRecentMeanDuration();
00163 
00169   unsigned long getRecentMaxDuration();
00170 
00176   unsigned long getMeanTBCE();
00177 
00183   unsigned long getMaxTBCE();
00184 
00190   unsigned long getRecentMeanTBCE();
00191 
00197   unsigned long getRecentMaxTBCE();
00198 
00204   int getFailureRate();
00205 
00211   int getRecentFailureRate();
00212 };
00213 
00214 #endif // _TIMELINE_H