libGizmod/GizmodTimer.hpp

Go to the documentation of this file.

/*
  
  Copyright (c) 2007, Tim Burrell
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at 

        http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and 
  limitations under the License. 
  
*/

#ifndef __GizmodTimer_h
#define __GizmodTimer_h

#if HAVE_CONFIG_H
#include "config.h"
#endif

#include "GizmodShared.hpp"
#include <boost/python.hpp>

// Namespace

namespace Gizmod {

// Typedef, enum's
        
// Class Definition

class GizmodTimer : public GizmodShared {
public:
        // public functions
        void                            cancel();               
        void                            resetTimer();           
        void                            setUserData(boost::python::object UserData); 
        void                            setTime(float Seconds); 
        void                            start();                
        
        // construction / deconstruction        
        GizmodTimer(float Seconds, boost::python::object TimerFunction); 
        GizmodTimer(float Seconds, boost::python::object TimerFunction, boost::python::object UserData); 
        GizmodTimer(float Seconds, boost::python::object TimerFunction, int Repeats, boost::python::object UserData); 
        virtual ~GizmodTimer();                                 

private:
        // private functions
        void                            threadProc();           
        
        // private member variables
        bool                            mCancel;                
        int                             mRepeats;               
        float                           mSleepTime;             
        boost::python::object           mTimerFunction;         
        int                             mTotalRepeats;          
        float                           mTotalSlept;            
        boost::python::object           mUserData;              
        
        struct GizmodTimerThreadProc {
                GizmodTimerThreadProc(GizmodTimer * pGizmodTimer) : mpGizmodTimer(pGizmodTimer) {
                        mpGizmodTimer->mThreading = false;
                };
                
                void operator()() {
                        mpGizmodTimer->mThreading = true;
                        mpGizmodTimer->threadProc();
                        mpGizmodTimer->mThreading = false;
                }
                
                GizmodTimer *           mpGizmodTimer;
        };              
        bool                            mThreading;     
        GizmodTimerThreadProc           mThreadProc;    
};


} // Gizmod namespace

#endif // __GizmodTimer_h

---