libGizmod/GizmodTimer.cpp

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. 
  
*/

#include "GizmodTimer.hpp"
#include "GizmoEventLIRC.hpp"
#include "../libH/Debug.hpp"
#include "../libH/Exception.hpp"
#include "../libH/UtilTime.hpp"
#include <boost/shared_ptr.hpp>
#include <boost/thread/thread.hpp>

using namespace std;
using namespace boost;
using namespace H;
using namespace Gizmod;

// Type Defs
        
#define TIMER_GRANULARITY       0.05f

// Construction

GizmodTimer::GizmodTimer(float Seconds, boost::python::object TimerFunction) : mThreadProc(this) {
        mCancel = false;
        mRepeats = 0;
        mTotalRepeats = 0;
        mSleepTime = Seconds;
        mTimerFunction = TimerFunction;
}

GizmodTimer::GizmodTimer(float Seconds, boost::python::object TimerFunction, boost::python::object UserData) : mThreadProc(this) {
        mCancel = false;
        mRepeats = 0;
        mTotalRepeats = 0;
        mSleepTime = Seconds;
        mTimerFunction = TimerFunction;
        setUserData(UserData);
}

GizmodTimer::GizmodTimer(float Seconds, boost::python::object TimerFunction, int Repeats, boost::python::object UserData) : mThreadProc(this) {
        mCancel = false;
        mRepeats = 0;
        mTotalRepeats = Repeats;
        mSleepTime = Seconds;
        mTimerFunction = TimerFunction;
        setUserData(UserData);
}

GizmodTimer::~GizmodTimer() {
}

// Class Body

void GizmodTimer::start() {
        cdbg4 << "GizmodTimer :: start" << endl;
        boost::thread thrd(mThreadProc);
}

void GizmodTimer::cancel() {
        cdbg4 << "GizmodTimer :: cancel" << endl;
        mCancel = true;
}

void GizmodTimer::resetTimer() {
        mTotalSlept = 0.0f;
}

void GizmodTimer::setUserData(boost::python::object UserData) {
        mUserData = UserData;
}

void GizmodTimer::setTime(float Seconds) {
        mSleepTime = Seconds;
}

void GizmodTimer::threadProc() {
        cdbg4 << "GizmodTimer :: Sleeping [" << mSleepTime << "s]" << endl;
        
        mRepeats = -1;
        do {
                // count the number of times we've repeated
                mRepeats ++;
                
                // sleep the desired amount of time
                mTotalSlept = 0.0f;
                mCancel = false;
                while ( (!mCancel) && (mTotalSlept < mSleepTime) ) {
                        float SleepStep = TIMER_GRANULARITY;
                        if (mTotalSlept + SleepStep > mSleepTime)
                                SleepStep = mSleepTime - mTotalSlept;
                        cdbg5 << "GizmodTimer :: Slept [" << mTotalSlept<< "s] of [" << mSleepTime << "s] -- Sleeping [" << SleepStep << "s]" << endl;
                        UtilTime::sleep(SleepStep);
                        mTotalSlept += SleepStep + 0.0001f;
                }
                
                if (mCancel) {
                        cdbg5 << "GizmodTimer :: Cancel Called" << endl;
                        return;
                }               
                
                // call the python timer function
                cdbg4 << "GizmodTimer :: Calling Python timerFunction" << endl;
                mutex::scoped_lock lock(mMutexScript);
                mTimerFunction(mUserData);              
                cdbg5 << "GizmodTimer :: Python timerFunction exited." << endl;
                cdbg5 << "GizmodTimer :: Repeating: " << mRepeats << " of " << mTotalRepeats << endl;
        } while ( (!mCancel) && ( (mTotalRepeats == -1) || (mRepeats <= mTotalRepeats) ) );
}

---