nl:: بافت:: پروفایل ها:: DataManagement_Current:: Custom Command:: تجزیه کننده

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

WDM Command Custom درخواست تعریف تجزیه کننده.

خلاصه

وراثت

ارث می برد از: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

توابع عمومی

CheckSchemaValidity (void) const
تقریباً تأیید کنید که پیام به درستی شکل گرفته است.
GetActionTimeMicroSecond (int64_t *const apActionTimeMicroSecond) const
زمان عمل برنامه ریزی شده برای این دستور را دریافت کنید.
GetCommandType (uint64_t *const apCommandType) const
id نوع فرمان را برای این دستور دریافت کنید.
GetExpiryTimeMicroSecond (int64_t *const apExpiryTimeMicroSecond) const
زمان انقضای این دستور را دریافت کنید.
GetInitiationTimeMicroSecond (int64_t *const apInitiationTimeMicroSecond) const
زمان شروع این دستور را دریافت کنید.
GetMustBeVersion (uint64_t *const apMustBeVersion) const
نسخه ضروری این دستور را دریافت کنید.
GetPath ( Path::Parser *const apPath) const
یک Path::Parser را با مولفه path در این دستور مقداردهی کنید.
GetReaderOnArgument ( nl::Weave::TLV::TLVReader *const apReader) const
یک TLVReader را راه اندازی کنید تا به ابتدای جزء آرگومان در این دستور اشاره کند.
GetReaderOnPath ( nl::Weave::TLV::TLVReader *const apReader) const
یک TLVReader را راه اندازی کنید تا در این دستور به ابتدای جزء مسیر اشاره کند.
Init (const nl::Weave::TLV::TLVReader & aReader)
شی تجزیه کننده را با 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
اشاره گر به برخی از متغیرها برای دریافت زمان شروع فرمان در هنگام موفقیت
ارزش های بازگشتی
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 را با مولفه path در این دستور مقداردهی کنید.

جزئیات
مولفه های
[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
در مورد موفقیت

شروع کنید

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

شی تجزیه کننده را با TLVReader مقداردهی کنید.

جزئیات
مولفه های
[in] aReader
اشاره گر به TLVReader که باید به ابتدای این درخواست اشاره کند
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت