nl::Weave::Profiles::Time::TimeZoneUtcOffset

#include <src/lib/profiles/time/WeaveTime.h>

タイムゾーンの UTC オフセット用のコーデック。

概要

コンストラクタとデストラクタ
TimeZoneUtcOffset()

パブリック属性
mSize
uint8_t
mUtcOffsetRecord 内の有効なエントリ数
mUtcOffsetRecord[WEAVE_CONFIG_TIME_NUM_UTC_OFFSET_RECORD]
UTC オフセットのエントリ

公開静的属性
BufferSizeForEncoding = 2 + 8 + 4 + (WEAVE_CONFIG_TIME_NUM_UTC_OFFSET_RECORD - 1) * 8
const uint32_t
TimeZoneUtcOffset::BufferSizeForEncoding はコンパイル時の定数で、バイト配列の宣言に使用できます。

パブリック関数
Decode(const uint8_t *const aInputBuf, const uint32_t aDataSize)
Weave の TLV から抽出したバイト文字列の UTC オフセットをデコードします。
Encode(uint8_t *const aOutputBuf, uint32_t *const aDataSize)
UTC オフセットをバッファにエンコードします。
GetCurrentLocalTime(timesync_t *const aLocalTime, const timesync_t aUtcTime) const
保存されている UTC オフセットを使用して、UTC 時間を現地時間に変換します。

構造体
nl::Weave::Profiles::Time::TimeZoneUtcOffset::UtcOffsetRecord

コンバージョン情報

パブリック属性

mSize

uint8_t mSize

mUtcOffsetRecord 内の有効なエントリ数

mUtcOffsetRecord

UtcOffsetRecord mUtcOffsetRecord[WEAVE_CONFIG_TIME_NUM_UTC_OFFSET_RECORD]

UTC オフセットのエントリ

公開静的属性

BufferSizeForEncoding

const uint32_t BufferSizeForEncoding = 2 + 8 + 4 + (WEAVE_CONFIG_TIME_NUM_UTC_OFFSET_RECORD - 1) * 8

TimeZoneUtcOffset::BufferSizeForEncoding はコンパイル時の定数で、バイト配列の宣言に使用できます。

呼び出し元は、エンコードが正常に完了するために十分なバッファサイズを準備する必要があります。BufferSizeForEncoding は、必要となる可能性がある最長のバッファです。

パブリック関数

Decode

WEAVE_ERROR Decode(
  const uint8_t *const aInputBuf,
  const uint32_t aDataSize
)

Weave の TLV から抽出したバイト文字列の UTC オフセットをデコードします。

size のデータ型は WeaveTLV.h と同じです。

詳細
パラメータ
[in] aInputBuf
入力データ バッファへのポインタ
[in] aDataSize
使用可能なバイト数
戻り値
成功時の WEAVE_NO_ERROR

Encode

WEAVE_ERROR Encode(
  uint8_t *const aOutputBuf,
  uint32_t *const aDataSize
)

UTC オフセットをバッファにエンコードします。

size のデータ型は WeaveTLV.h と同じです。

詳細
パラメータ
[out] aOutputBuf
出力データ バッファへのポインタ
[in,out] aDataSize
呼び出し時に aOutputBuf で使用可能なバイト数へのポインタ。関数が戻った後に使用されるバイト数を示すように変更されます。
戻り値
成功時の WEAVE_NO_ERROR

GetCurrentLocalTime

WEAVE_ERROR GetCurrentLocalTime(
  timesync_t *const aLocalTime,
  const timesync_t aUtcTime
) const

保存されている UTC オフセットを使用して、UTC 時間を現地時間に変換します。

詳細
パラメータ
[out] aLocalTime
結果の現地時間へのポインタ
[in] aUtcTime
UTC 時間
戻り値
WEAVE_NO_ERROR 成功の場合。適切な結果が見つからない場合は WEAVE_ERROR_KEY_NOT_FOUND

TimeZoneUtcOffset

 TimeZoneUtcOffset()