Timer.h

Go to the documentation of this file.

// -*- C++ -*-
/* GG is a GUI for SDL and OpenGL.
   Copyright (C) 2003 T. Zachary Laine

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public License
   as published by the Free Software Foundation; either version 2.1
   of the License, or (at your option) any later version.
   
   This library 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 library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA

   If you do not wish to comply with the terms of the LGPL please
   contact the author as other terms are available for a fee.
    
   Zach Laine
   whatwasthataddress@hotmail.com */

#ifndef _GG_Timer_h_
#define _GG_Timer_h_

#include <GG/Base.h>

#include <set>


namespace GG {

class Wnd;

class GG_API Timer
{
public: 

    explicit Timer(int interval, int start_time = 0);

    ~Timer(); 

 
    bool Connected() const;             
    int Interval() const;               
    bool Running() const;               
    bool ShouldFire(int ticks) const;   
    const std::set<Wnd*>& Wnds() const; 

 
    void Reset(int start_time = 0); 
    void SetInterval(int interval); 
    void Connect(Wnd* wnd);         
    void Disconnect(Wnd* wnd);      
    void Start();                   
    void Stop();                    


private:
    Timer();
    Timer(const Timer&); // disabled

    std::set<Wnd*> m_wnds;
    int            m_interval;
    bool           m_running;
    int            m_last_fire;

    friend class boost::serialization::access;
    template <class Archive>
    void serialize(Archive& ar, const unsigned int version);
};

} // namespace GG

// template implementations
template <class Archive>
void GG::Timer::serialize(Archive& ar, const unsigned int version)
{
    ar  & BOOST_SERIALIZATION_NVP(m_wnds)
        & BOOST_SERIALIZATION_NVP(m_interval)
        & BOOST_SERIALIZATION_NVP(m_last_fire)
        & BOOST_SERIALIZATION_NVP(m_running);
}

#endif

---