GHOST_TimerTask.h

Go to the documentation of this file.

/*
 * $Id: GHOST_TimerTask.h 35152 2011-02-25 11:28:33Z jesterking $
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef _GHOST_TIMER_TASK_H_
#define _GHOST_TIMER_TASK_H_

#include "GHOST_ITimerTask.h"


class GHOST_TimerTask : public GHOST_ITimerTask
{
public:
        GHOST_TimerTask(GHOST_TUns64 start, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData = 0)
                : m_start(start), m_interval(interval), m_next(start), m_timerProc(timerProc), m_userData(userData), m_auxData(0)
        {
        }

        inline virtual GHOST_TUns64 getStart() const
        {
                return m_start;
        }

        virtual void setStart(GHOST_TUns64 start)
        { 
                m_start = start;
        }

        inline virtual GHOST_TUns64 getInterval() const
        {
                return m_interval;
        }

        virtual void setInterval(GHOST_TUns64 interval)
        { 
                m_interval = interval;
        }

        inline virtual GHOST_TUns64 getNext() const
        {
                return m_next;
        }

        virtual void setNext(GHOST_TUns64 next)
        { 
                m_next = next;
        }

        inline virtual GHOST_TimerProcPtr getTimerProc() const
        {
                return m_timerProc;
        }

        inline virtual void setTimerProc(const GHOST_TimerProcPtr timerProc)
        {
                m_timerProc = timerProc;
        }

        inline virtual GHOST_TUserDataPtr getUserData() const
        {
                return m_userData;
        }
        
        virtual void setUserData(const GHOST_TUserDataPtr userData)
        {
                m_userData = userData;
        }

        inline virtual GHOST_TUns32 getAuxData() const
        {
                return m_auxData;
        }

        virtual void setAuxData(GHOST_TUns32 auxData)
        { 
                m_auxData = auxData;
        }

protected:
        GHOST_TUns64 m_start;

        GHOST_TUns64 m_interval;

        GHOST_TUns64 m_next;

        GHOST_TimerProcPtr m_timerProc;

        GHOST_TUserDataPtr m_userData;

        GHOST_TUns32 m_auxData;
};

#endif // _GHOST_TIMER_TASK_H_