HourGlass.h

/* This file is part of the UniSet project
 * Copyright (c) 2002 Free Software Foundation, Inc.
 * Copyright (c) 2002 Pavel Vainerman
 *
 * 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.
 *
 * 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.
 *
 * 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.
 */
// --------------------------------------------------------------------------
// idea: lav@etersoft.ru
// realisation: pv@etersoft.ru, lav@etersoft.ru
// --------------------------------------------------------------------------
#ifndef HourGlass_H_
#define HourGlass_H_
// --------------------------------------------------------------------------
#include "PassiveTimer.h"
// --------------------------------------------------------------------------
class HourGlass
{
    public:
        HourGlass(): _state(false), _sand(0), _size(0) {}
        ~HourGlass() {}

        // запустить часы (заново)
        inline void run( timeout_t msec )
        {
            t.setTiming(msec);
            _state   = true;
            _sand    = msec;
            _size    = msec;
        }

        inline void reset()
        {
            run(_size);
        }

        // "ёмкость" песочных часов..
        inline int duration()
        {
            return _size;
        }
        // перевернуть часы
        // true - засечь время
        // false - перевернуть часы (обратный ход)
        // возвращает аргумент (т.е. идёт ли отсчёт времени)
        inline bool rotate( bool st )
        {
            if( st == _state )
                return st;

            _state = st;

            // TODO 24.10.2015 Lav: follow code is very simular to remain function
            if( !_state )
            {
                timeout_t cur = t.getCurrent();

                if( cur > _size )
                    cur = _size;

                _sand = ( _sand > cur ) ? (_sand - cur) : 0;

                t.setTiming(cur);
            }
            else
            {
                timeout_t cur = t.getCurrent();

                if( cur > _size )
                    cur = _size;

                _sand += cur;

                if( _sand > _size )
                    _sand = _size;

                t.setTiming(_sand);
            }

            return st;
        }

        // получить прошедшее время
        inline timeout_t current()
        {
            return t.getCurrent();
        }

        // получить заданное время
        inline timeout_t interval()
        {
            return t.getInterval();
        }

        // проверить наступление
        inline bool check()
        {
            // пока часы не "стоят"
            // всегда false
            if( !_state )
                return false;

            return t.checkTime();
        }

        inline bool enabled()
        {
            return _state;
        }

        // текущее "насыпавшееся" количество "песка" (прошедшее время)
        inline timeout_t amount()
        {
            return ( _size - remain() );
        }

        // остаток песка (времени) (оставшееся время)
        inline timeout_t remain()
        {
            timeout_t c = t.getCurrent();

            if( c > _size )
                c = _size;

            // _state=false - означает, что песок пересыпается обратно..
            if( !_state )
            {
                timeout_t ret = ( _sand + c );

                if( ret > _size )
                    return _size;

                return ret;
            }

            // _state=true  - означает, что песок пересыпается..
            int ret = ( _sand - c );

            if( ret < 0 )
                return 0;

            return ret;
        }

    protected:
        PassiveTimer t;   
        bool _state;      
        timeout_t _sand;  
        timeout_t _size;  
};
// --------------------------------------------------------------------------
#endif
// --------------------------------------------------------------------------