YiTimer.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_TIMER_H_
#define _YI_TIMER_H_

#include "binding/YiScriptableObject.h"
#include "framework/YiPredef.h"
#include "signal/YiSignalHandler.h"
#include "signal/YiSignal.h"


class CYITimerPriv;


class CYITimer : public CYISignalHandler, public CYIScriptableObject
{
public:
    enum STATE
    {
        OFF = 0, 
        RUNNING, 
        SUSPENDED 
    };

    CYITimer();

    CYITimer(int32_t nTimerID);
    virtual ~CYITimer();

    uint64_t GetInterval() const;

    STATE GetState() const;

    bool IsSingleShot() const;

    void SetInterval(uint64_t uIntervalMs);

    void SetSingleShot (bool bSingleShot);

    void Start(uint64_t uIntervalMs);

    void Start();

    void Stop();

    void Suspend();

    void Resume();

    void SetTimerID(int32_t nTimerID);

    int32_t GetTimerID() const;

    CYISignal<int32_t> TimedOut;

private:
    CYITimerPriv *m_pPriv;

    YI_DISALLOW_COPY_AND_ASSIGN(CYITimer)
};

#endif /* _YI_TIMER_H_ */