タイムスタンプ管理機能のインターフェース
More...
#include <TimestampInterface.hpp>
|
|
using | Rep = std::uint64_t |
| | タイムスタンプの表現に用いる整数型
|
| |
|
using | ClockRep = std::uint64_t |
| | クロックの表現に用いる整数型
|
| |
◆ ConvertFromClock()
| virtual bool zao::endpoint::TimestampInterface::ConvertFromClock |
( |
ClockRep |
clock, |
|
|
Rep & |
timestamp |
|
) |
| const |
|
pure virtualnoexcept |
クロック値をタイムスタンプに変換する。
- Parameters
-
| clock | クロック値 |
| timestamp | タイムスタンプ値 |
- Return values
-
| true | 変換成功 |
| false | 変換失敗(変換に必要なパラメータが不足している) |
◆ ConvertToClock()
| virtual bool zao::endpoint::TimestampInterface::ConvertToClock |
( |
Rep |
timestamp, |
|
|
ClockRep & |
clock |
|
) |
| const |
|
pure virtualnoexcept |
タイムスタンプをクロック値に変換する。
- Parameters
-
| timestamp | タイムスタンプ値 |
| clock | クロック値 |
- Return values
-
| true | 変換成功 |
| false | 変換失敗(変換に必要なパラメータが不足している) |
◆ GetCurrentTimestamp()
| virtual bool zao::endpoint::TimestampInterface::GetCurrentTimestamp |
( |
Rep & |
timestamp | ) |
const |
|
pure virtualnoexcept |
現在のタイムスタンプ値を計算して取得する。
- Note
- 計算のオーバーヘッドが発生するため、 本関数の呼び出し回数は可能な限り少なくすべき。
-
本関数はスレッドセーフに実装される。
- Parameters
-
- Return values
-
| true | 有効なタイムスタンプ有り |
| false | タイムスタンプが無効(計算不可) |
◆ GetRatio()
| virtual void zao::endpoint::TimestampInterface::GetRatio |
( |
std::intmax_t & |
numerator, |
|
|
std::intmax_t & |
denominator |
|
) |
| const |
|
pure virtualnoexcept |
進み具合(1秒に対する比率)を取得する。
- Note
- 返却される値は、約分されている可能性がある。
-
本関数はスレッドセーフに実装される。
- Parameters
-
| numerator | 分子の格納先 |
| denominator | 分母の格納先 |
◆ SetCurrentTimestamp()
| virtual void zao::endpoint::TimestampInterface::SetCurrentTimestamp |
( |
Rep |
timestamp | ) |
|
|
pure virtualnoexcept |
現在のタイムスタンプ値を通知する。
- Note
- ハードウェアから得られる値の範囲が Repの表現できる値より小さい場合、 ロールオーバーを適切に処理してRepの表現範囲に拡張して渡すこと。
-
本関数はスレッドセーフに実装される。
- Parameters
-
The documentation for this class was generated from the following file:
- /home/jenkins/workspace/J2412.zao_sdk_jetson.build/zep_sdk/libzao-endpoint/include/zao/endpoint/TimestampInterface.hpp
