nl :: Dệt :: Hồ sơ :: DataManagement_Current :: CustomCommand :: Phân tích cú pháp

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

Định nghĩa trình phân tích cú pháp Yêu cầu lệnh tùy chỉnh WDM.

Tóm lược

Di sản

Kế thừa từ: nl :: Weave :: Profiles :: DataManagement_Current :: DataElement :: Parser

Chức năng công cộng
`CheckSchemaValidity (void) const`	`WEAVE_ERROR` Xác minh sơ bộ thông báo được hình thành chính xác.
`GetActionTimeMicroSecond (int64_t *const apActionTimeMicroSecond) const`	`WEAVE_ERROR` Nhận thời gian hành động đã lên lịch cho lệnh này.
`GetCommandType (uint64_t *const apCommandType) const`	`WEAVE_ERROR` Nhận id loại lệnh cho lệnh này.
`GetExpiryTimeMicroSecond (int64_t *const apExpiryTimeMicroSecond) const`	`WEAVE_ERROR` Nhận thời gian hết hạn cho lệnh này.
`GetInitiationTimeMicroSecond (int64_t *const apInitiationTimeMicroSecond) const`	`WEAVE_ERROR` Lấy thời gian bắt đầu cho lệnh này.
`GetMustBeVersion (uint64_t *const apMustBeVersion) const`	`WEAVE_ERROR` Nhận phiên bản phải có cho lệnh này.
`GetPath ( Path::Parser *const apPath) const`	`WEAVE_ERROR` Khởi tạo một Path :: Parser với thành phần đường dẫn trong lệnh này.
`GetReaderOnArgument (nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` Khởi tạo một TLVReader để trỏ đến phần đầu của thành phần đối số trong lệnh này.
`GetReaderOnPath (nl::Weave::TLV::TLVReader *const apReader) const`	`WEAVE_ERROR` Khởi tạo một TLVReader để trỏ đến phần đầu của thành phần đường dẫn trong lệnh này.
`Init (constnl::Weave::TLV::TLVReader & aReader)`	`WEAVE_ERROR` Khởi tạo đối tượng phân tích cú pháp bằng TLVReader.

Chức năng công cộng

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Xác minh sơ bộ thông báo được hình thành chính xác.

Chi tiết

Giá trị trả lại

WEAVE_NO_ERROR

thành công

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Nhận thời gian hành động đã lên lịch cho lệnh này.

Chi tiết

Thông số

[out] apActionTimeMicroSecond

Một con trỏ đến một số biến để nhận thời gian hành động Lệnh thành công

Giá trị trả lại

`WEAVE_NO_ERROR`	thành công
`WEAVE_END_OF_TLV`	nếu không có yếu tố đó
`WEAVE_ERROR_WRONG_TLV_TYPE`	nếu có phần tử như vậy nhưng nó không phải là số nguyên có dấu

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Nhận id loại lệnh cho lệnh này.

Chi tiết

Thông số

[out] apCommandType

Một con trỏ đến một số biến để nhận id loại lệnh khi thành công

Giá trị trả lại

`WEAVE_NO_ERROR`	thành công
`WEAVE_END_OF_TLV`	nếu không có yếu tố đó
`WEAVE_ERROR_WRONG_TLV_TYPE`	nếu có phần tử như vậy nhưng nó không phải là số nguyên không dấu

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Nhận thời gian hết hạn cho lệnh này.

Chi tiết

Thông số

[out] apExpiryTimeMicroSecond

Một con trỏ đến một số biến để nhận thời gian hết hạn thành công

Giá trị trả lại

`WEAVE_NO_ERROR`	thành công
`WEAVE_END_OF_TLV`	nếu không có yếu tố đó
`WEAVE_ERROR_WRONG_TLV_TYPE`	nếu có phần tử như vậy nhưng nó không phải là số nguyên có dấu

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Lấy thời gian bắt đầu cho lệnh này.

Chi tiết

Thông số

[out] apInitiationTimeMicroSecond

Một con trỏ đến một số biến để nhận thời gian bắt đầu Lệnh thành công

Giá trị trả lại

`WEAVE_NO_ERROR`	thành công
`WEAVE_END_OF_TLV`	nếu không có yếu tố đó
`WEAVE_ERROR_WRONG_TLV_TYPE`	nếu có phần tử như vậy nhưng nó không phải là số nguyên có dấu

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Nhận phiên bản phải có cho lệnh này.

Chi tiết

Thông số

[out] apMustBeVersion

Một con trỏ đến một số biến để nhận được phiên bản phải có khi thành công

Giá trị trả lại

`WEAVE_NO_ERROR`	thành công
`WEAVE_END_OF_TLV`	nếu không có yếu tố đó
`WEAVE_ERROR_WRONG_TLV_TYPE`	nếu có phần tử như vậy nhưng nó không phải là số nguyên không dấu

GetPath

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

Khởi tạo một Path :: Parser với thành phần đường dẫn trong lệnh này.

Chi tiết

Thông số

[out] apPath

Một con trỏ tới Path :: Parser , sẽ được khởi tạo với thành phần đường dẫn nhúng khi thành công

Giá trị trả lại

`WEAVE_NO_ERROR`	thành công
`WEAVE_END_OF_TLV`	nếu không có yếu tố đó
`WEAVE_ERROR_WRONG_TLV_TYPE`	nếu có yếu tố như vậy nhưng nó không phải là một Đường dẫn

GetReaderOnArgument

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

Khởi tạo một TLVReader để trỏ đến đầu thành phần đối số trong lệnh này.

Chi tiết

Thông số

[out] apReader

Một con trỏ tới TLVReader, sẽ được khởi tạo tại phần tử TLV đối số về thành công

Giá trị trả lại

WEAVE_NO_ERROR

thành công

GetReaderOnPath

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

Khởi tạo một TLVReader để trỏ đến đầu thành phần đường dẫn trong lệnh này.

Chi tiết

Thông số

[out] apReader

Một con trỏ tới TLVReader, sẽ được khởi tạo tại phần tử TLV đối số về thành công

Giá trị trả lại

WEAVE_NO_ERROR

thành công

Trong đó

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

Khởi tạo đối tượng phân tích cú pháp bằng TLVReader.

Chi tiết

Thông số

[in] aReader

Một con trỏ tới TLVReader, con trỏ này sẽ trỏ đến đầu yêu cầu này

Giá trị trả lại

WEAVE_NO_ERROR

thành công