nl::Weave::الملفات الشخصية::DataManagement_Current::CustomCommand::المحلل اللغوي

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

طلب محلل مخصّص في محلّل WDM.

الملخّص

الاكتساب

يكتسب من: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

وظائف عامة
CheckSchemaValidity(void) const
تحقق بشكل صحيح من صياغة الرسالة بشكلٍ صحيح.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
احصل على وقت الإجراء المقرّر لهذا الأمر.
GetCommandType(uint64_t *const apCommandType) const
احصل على رقم تعريف نوع هذا الأمر.
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 باستخدام مكوِّن المسار في هذا الأمر.
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

وظائف عامة

التحقق من صلاحية المخطط

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

احصل على رقم تعريف نوع هذا الأمر.

التفاصيل
المعلَمات
[out] apCommandType
مؤشر إلى بعض المتغيّرات للحصول على رقم تعريف نوع الأمر عند النجاح
قيم الإرجاع
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
إذا كان هناك هذا العنصر ولكن لم يكن عددًا صحيحًا موقّعًا

الحصول على نسخة إصدارات تجريبية

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
مؤشر إلى المسار::المحلل اللغوي الذي سيتم إعداده مع مكوّن المسار المضمّن عند النجاح
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح
WEAVE_END_OF_TLV
في حال عدم توفّر هذا العنصر
WEAVE_ERROR_WRONG_TLV_TYPE
إذا كان هناك هذا العنصر ولكنه ليس مسارًا

الوسيط GetReaderOn

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
عند النجاح