本頁面由 Cloud Translation API 翻譯而成。

nl::Weave::Profiles::DataManagement_Current::CustomCommand::Parser

#include <src/lib/profiles/data-management/Current/MessageDef.h>

WDM 自訂指令要求剖析器定義。

摘要

繼承

沿用自： nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

公開函式
`CheckSchemaValidity(void) const`	`WEAVE_ERROR` 請盡量驗證訊息的格式是否正確。
`GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const`	`WEAVE_ERROR` 取得這項指令的排定動作時間。
`GetCommandType(uint64_t *const apCommandType) const`	`WEAVE_ERROR` 取得這個指令的指令類型 ID。
`GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const`	`WEAVE_ERROR` 取得這個指令的到期時間。
`GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const`	`WEAVE_ERROR` 取得這個指令的啟動時間。
`GetMustBeVersion(uint64_t *const apMustBeVersion) const`	`WEAVE_ERROR` 取得這個指令的必備版本。
`GetPath(Path::Parser *const apPath) const`	`WEAVE_ERROR` 使用這個指令中的路徑元件初始化 Path::Parser。
`GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` 請在這個指令中初始化 TLVReader 以指向引數元件的開頭。
`GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` 在這個指令中初始化 TLVReader 以指向路徑元件的開頭。
`Init(const nl::Weave::TLV::TLVReader & aReader)`	`WEAVE_ERROR` 使用 TLVReader 初始化剖析器物件。

公開函式

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

請盡量驗證訊息的格式是否正確。

詳細資料

傳回值

WEAVE_NO_ERROR

成功時

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

取得這項指令的排定動作時間。

詳細資料

參數

[out] apActionTimeMicroSecond

指向某些變數的指標，在成功時接收「Command」動作時間

傳回值

`WEAVE_NO_ERROR`	成功時
`WEAVE_END_OF_TLV`	(如果沒有這類元素)
`WEAVE_ERROR_WRONG_TLV_TYPE`	如果有這類元素，但不是帶正負號整數

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

取得這個指令的指令類型 ID。

詳細資料

參數

[out] apCommandType

指向某些變數的指標，可在成功時接收指令類型 ID

傳回值

`WEAVE_NO_ERROR`	成功時
`WEAVE_END_OF_TLV`	(如果沒有這類元素)
`WEAVE_ERROR_WRONG_TLV_TYPE`	如果有這類元素，但不是無正負號的整數

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

取得這個指令的到期時間。

詳細資料

參數

[out] apExpiryTimeMicroSecond

指向某些變數的指標，用來接收成功的到期時間

傳回值

`WEAVE_NO_ERROR`	成功時
`WEAVE_END_OF_TLV`	(如果沒有這類元素)
`WEAVE_ERROR_WRONG_TLV_TYPE`	如果有這類元素，但不是帶正負號整數

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

取得這個指令的啟動時間。

詳細資料

參數

[out] apInitiationTimeMicroSecond

指向某些變數的指標，在成功時接收 Command 啟動時間

傳回值

`WEAVE_NO_ERROR`	成功時
`WEAVE_END_OF_TLV`	(如果沒有這類元素)
`WEAVE_ERROR_WRONG_TLV_TYPE`	如果有這類元素，但不是帶正負號整數

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

取得這個指令的必備版本。

詳細資料

參數

[out] apMustBeVersion

指向某些變數的指標，在成功時接收必要的版本

傳回值

`WEAVE_NO_ERROR`	成功時
`WEAVE_END_OF_TLV`	(如果沒有這類元素)
`WEAVE_ERROR_WRONG_TLV_TYPE`	如果有這類元素，但不是無正負號的整數

GetPath

WEAVE_ERROR GetPath(
  Path::Parser *const apPath
) const

使用這個指令中的路徑元件初始化 Path::Parser。

詳細資料

參數

[out] apPath

指向「Path::Parser」的指標，在成功時將使用嵌入式路徑元件初始化

傳回值

`WEAVE_NO_ERROR`	成功時
`WEAVE_END_OF_TLV`	(如果沒有這類元素)
`WEAVE_ERROR_WRONG_TLV_TYPE`	如果有這類元素，但並非路徑

GetReaderOnArgument

WEAVE_ERROR GetReaderOnArgument(
  nl::Weave::TLV::TLVReader *const apReader
) const

請在這個指令中初始化 TLVReader 以指向引數元件的開頭。

詳細資料

參數

[out] apReader

指向 TLVReader 的指標，系統會在成功時在引數 TLV 元素中初始化

傳回值

WEAVE_NO_ERROR

成功時

GetReaderOnPath

WEAVE_ERROR GetReaderOnPath(
  nl::Weave::TLV::TLVReader *const apReader
) const

在這個指令中初始化 TLVReader 以指向路徑元件的開頭。

詳細資料

參數

[out] apReader

指向 TLVReader 的指標，系統會在成功時在引數 TLV 元素中初始化

傳回值

WEAVE_NO_ERROR

成功時

Init

WEAVE_ERROR Init(
  const nl::Weave::TLV::TLVReader & aReader
)

使用 TLVReader 初始化剖析器物件。

詳細資料

參數

[in] aReader

指向 TLVReader 的指標，應指向這項要求的開頭

傳回值

WEAVE_NO_ERROR

成功時