User Manual, Developers Guide and API Documentation

SlidingWindow.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 5, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#ifndef WNS_SLIDINGWINDOW_HPP
#define WNS_SLIDINGWINDOW_HPP


#include <WNS/simulator/ISimulator.hpp>
#include <WNS/events/scheduler/Interface.hpp>

#include <WNS/Assure.hpp>

#include <list>

namespace wns {

    class SlidingWindow
    {
        struct Helper
        {
            Helper(simTimeType _time, double _value) :
                time(_time),
                value(_value)
            {
            }

            simTimeType time;
            double value;
        };

    public:
        explicit
        SlidingWindow(simTimeType _windowSize, bool _includeNow=false) :
            windowSize(_windowSize),
            includeNow(_includeNow),
            queue()
        {
            assure(this->windowSize > 0.0, "Window size must be > 0.0");
        }

        virtual
        ~SlidingWindow()
        {
            this->reset();
        }

        virtual void
        put(double value)
        {
            this->removeOutdatedValues();
            simTimeType now = wns::simulator::getEventScheduler()->getTime();
            // add new value
            this->queue.push_back(Helper(now, value));
        }


        virtual double
        getPerSecond()
        {
            return this->getAbsolute() / this->windowSize;
        }


        virtual double
        getAbsolute()
        {
            this->removeOutdatedValues();
            double absolute = 0.0;
            simTimeType now = wns::simulator::getEventScheduler()->getTime();
            for(
                std::list<Helper>::const_iterator itr = this->queue.begin();
                itr != this->queue.end();
                ++itr)
            {
                if ((itr->time < now) || includeNow)
                {
                    absolute += itr->value;
                }
            }

            return absolute;
        }

        virtual void
        reset()
        {
            queue.clear();
        }
        
        virtual int
        getNumSamples()
        {
            this->removeOutdatedValues();
            int numSamples = 0;
            simTimeType now = wns::simulator::getEventScheduler()->getTime();
            for(std::list<Helper>::const_iterator itr = this->queue.begin();
                         itr != this->queue.end();
                         ++itr)
            {
                if((itr->time < now) || includeNow)
                {
                    ++numSamples;
                }
            }
            return numSamples;
        }

    private:

        void
        removeOutdatedValues()
        {
            simTimeType now = wns::simulator::getEventScheduler()->getTime();
            while(
                (this->queue.empty() == false) &&
                (this->queue.front().time < now - this->windowSize)
                )
            {
                this->queue.pop_front();
            }
        }


        simTimeType windowSize;
        
        bool includeNow;

        std::list<Helper> queue;
    };

} // wns

#endif // WNS_SLIDINGWINDOW_HPP

---