SFXTimer

タイマーの操作を行うクラスです。

#include <SFXTimer.h.hpp>

class SFXTimer;

SFMTYPEDEFCLASS(SFXTimer)

協調図

解説

SFXTimer クラスは、指定時間が経過したときに処理を実行させるのに使います。

class MyClass {
private:
    SFXTimer _timer; 
public:
    Void Function(Void);
    CALLBACK_DECLARE_SFXTIMER(TimerCallback)
};

Void MyClass::Function(Void)
{

    ...
    
    // 4000 ミリ秒後に TimerCallback が呼び出される
    _timer.Set(CALLBACK_FUNCTION(TimerCallback));
    _timer.Schedule(4000);
}

/// コールバック関数
CALLBACK_IMPLEMENT_SFXTIMER(MyClass, TimerCallback) {
    ...
}

参照

SFXCallback | SFXTask

メンバ

コンストラクタ/デストラクタ
SFXTimer( `Void` ) SFXTimer クラスのコンストラクタです。
~SFXTimer( `Void` ) SFXTimer クラスのデストラクタです。

パブリック関数
`Void`	Cancel( `Void` ) 登録されたタイマーをキャンセルします。
static `SFXTimerConstRef`	EmptyInstance( `Void` ) 空のタイマーを取得します。
`SFXCallback::CallbackSPP`	GetProcedure( `Void` ) タイマーに設定されたコールバック関数を取得します。
`VoidPtr`	GetReference( `Void` ) タイマーに設定されたユーザーデータを取得します。
`Bool`	IsValid( `Void` ) タイマーが登録されているか調べます。
`SFCError`	Schedule( `UInt32` msec ) タイマーを登録します。
`Void`	Set( `SFXCallback::CallbackSPP` spp , `VoidPtr` reference ) タイマーの登録に必要な情報を設定します。

SFXTimer::SFXTimer

SFXTimer クラスのコンストラクタです。

[ public, explicit ]
SFXTimer(Void);

SFXTimer::~SFXTimer

SFXTimer クラスのデストラクタです。

[ public ]
~SFXTimer(Void);

解説

デストラクタでは登録されたタイマーのキャンセルを行います。

参照

SFXTimer::Cancel

SFXTimer::Cancel

登録されたタイマーをキャンセルします。

[ public ]
Void Cancel(Void);

解説

登録されたタイマーをキャンセルします。タイマーが登録されていない場合は何も行いません。

参照

SFXTimer::Set | SFXTimer::Schedule

SFXTimer::EmptyInstance

空のタイマーを取得します。

[ public, static ]
SFXTimerConstRef EmptyInstance(Void);

解説

空のタイマーを表すインスタンスを取得します。

SFXTimer::GetProcedure

タイマーに設定されたコールバック関数を取得します。

[ public, const ]
SFXCallback::CallbackSPP GetProcedure(Void);

戻り値

設定されたコールバック関数を返します。

参照

SFXTimer::GetReference | SFXTimer::Set

SFXTimer::GetReference

タイマーに設定されたユーザーデータを取得します。

[ public, const ]
VoidPtr GetReference(Void);

戻り値

タイマーに設定されたユーザーデータを返します。

参照

SFXTimer::GetProcedure | SFXTimer::Set

SFXTimer::IsValid

タイマーが登録されているか調べます。

[ public, const ]
Bool IsValid(Void);

戻り値

登録されているとき : true
登録されていないとき : false

参照

SFXTimer::Schedule

SFXTimer::Schedule

タイマーを登録します。

[ public ]
SFCError Schedule(
    UInt32 msec   // コールバック関数が呼び出されるまでの時間(ミリ秒)
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正なとき、または SFXTimer::Set 関数で必要な情報を設定していないとき : SFERR_INVALID_PARAM
失敗したとき : SFERR_FAILED

解説

タイマーが登録済みの場合は一度キャンセルされ再登録されます。

参照

SFXTimer::IsValid | SFXTimer::Cancel | SFXTimer::Set

SFXTimer::Set

タイマーの登録に必要な情報を設定します。

[ public ]
Void Set(
    SFXCallback::CallbackSPP spp   // タイマーにより呼び出されるコールバック関数
    VoidPtr reference              // コールバック関数に渡すユーザーデータ
);

参照

SFXTimer::GetProcedure | SFXTimer::GetReference | SFXTimer::Schedule