~~NOTOC~~
---json
{
    "canonical":"projects:bbs_pm:docs:bbs:timer",
    "title":"Timer",
    "description":"Timer"
}
---
\\
====== Timer ======

タイマーモジュールはタイミングを管理するための汎用モジュールです。\\

<blockquote>
^ 関数名                  ^ 説明   ^
| [[.:new|new()]]             | オブジェクトを作成します               |
| [[.:init|_init()]]          | 属性を初期化します                     |
| [[.:reset|reset()]]         | 起点時間をリセットします               |
| [[.:elapse|elapse()]]       | 起点時刻からの経過時間を求めます       |
| [[.:timeleft|timeleft()]]   | タイムアウトまでの残り時間を取得します |
| [[.:timeout|timeout()]]     | タイムアウトを判定します               |
| [[.:addtime|addtime()]]     | 起点時刻に時差を加算した時刻を求めます |
| [[.:timediff|timediff()]]   | ２つの時刻の時間差を求めます           |
</blockquote>

\\
===== 使い方 =====

オブジェクトを作成すると現在時刻（起点時刻）が保存されカウントが開始されます。\\
オブジェクト作成時、引数を指定すると現在時刻（起点時刻）にあわせて、現在時刻（起点時刻）から指定した時間分経過した時刻をタイムアウト時刻として設定します。\\
タイムアウト値の再設定は関数[[.:reset|reset()]]で行えます。\\

タイムアウト値が設定されている場合は関数[[.:timeleft|timeleft()]]をよびだすとタイムアウトまでの残り時間を得ることができ、
また関数[[.:timeout|timeout()]]は、タイムアウトしているか否かをフラグ値で得ることができます。\\

タイムアウト値が設定されていない場合は関数[[.:timeleft|timeleft()]],関数[[.:timeout|timeout()]]を呼び出しても値を取得できません。\\

関数[[.:elapse|elapse()]]は現在時刻（起点時刻）からの経過時間を求めることができます。\\

~~DISCUSSION~~