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

コンバージョン情報

パブリック属性

M サイズ

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 オフセットをデコードします。

サイズのデータ型が WeaveTLV.h と同じ

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

エンコーディング

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

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

サイズのデータ型が 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()