nl::Weave::Profiles::DataManagement_Current::TraitDataSource

これは抽象クラスです。

概要

継承

継承元: nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine::IGetDataDelegate
直系の既知のサブクラス: nl::Weave::DeviceLayer::Internal::DeviceIdentityTraitDataSource

コンストラクタとデストラクタ
TraitDataSource(const TraitSchemaEngine *aEngine)
~TraitDataSource()

公開タイプ
EventType enum

パブリック属性
mRootIsDirty
bool

プロテクト属性
mManagedVersion
bool
mSchemaEngine

パブリック関数
ClearRootDirty(void)
void
GetSchemaEngine(void) const
GetVersion(void)
uint64_t
IsRootDirty(void) const
bool
Lock(void)
OnCustomCommand(Command *aCommand, const nl::Weave::WeaveMessageInfo *aMsgInfo, nl::Weave::PacketBuffer *aPayload, const uint64_t & aCommandType, const bool aIsExpiryTimeValid, const int64_t & aExpiryTimeMicroSecond, const bool aIsMustBeVersionValid, const uint64_t & aMustBeVersion, nl::Weave::TLV::TLVReader & aArgumentReader)
virtual void
カスタム コマンドのハンドラ。
OnCustomCommand(Command *aCommand, const nl::Weave::WeaveMessageInfo *aMsgInfo, nl::Weave::PacketBuffer *aPayload, nl::Weave::TLV::TLVReader & aArgumentReader)
virtual void
カスタム コマンドのハンドラ。
OnEvent(uint16_t aType, void *aInEventParam)
virtual WEAVE_ERROR
ReadData(PropertyPathHandle aHandle, uint64_t aTagToWrite, TLV::TLVWriter & aWriter)
SetDirty(PropertyPathHandle aPropertyHandle)
void
SetRootDirty(void)
void
SetVersion(uint64_t version)
void
Unlock(void)

プロテクト関数
GetData(PropertyPathHandle aHandle, uint64_t aTagToWrite, nl::Weave::TLV::TLVWriter & aWriter, bool & aIsNull, bool & aIsPresent) __OVERRIDE
virtual WEAVE_ERROR
ノードへのパスハンドル、TLV ライター、値が null かどうかを示すブール値が与えられた場合、通知を作成するトレイト ソースからデータを取得します。
GetLeafData(PropertyPathHandle aLeafHandle, uint64_t aTagToWrite, nl::Weave::TLV::TLVWriter & aWriter) __OVERRIDE=0
virtual WEAVE_ERROR
リーフノードへのパスハンドルと TLV ライターが与えられたら、呼び出し先からデータを取得します。
IncrementVersion(void)
void

公開タイプ

EventType

 EventType

パブリック属性

mRootIsDirty

bool mRootIsDirty

プロテクト属性

mManagedVersion

bool mManagedVersion

mSchemaEngine

const TraitSchemaEngine * mSchemaEngine

パブリック関数

ClearRootDirty

void ClearRootDirty(
  void
)

GetSchemaEngine

const TraitSchemaEngine * GetSchemaEngine(
  void
) const

GetVersion

uint64_t GetVersion(
  void
)

IsRootDirty

bool IsRootDirty(
  void
) const

ロック

WEAVE_ERROR Lock(
  void
)

OnCustomCommand

virtual void OnCustomCommand(
  Command *aCommand,
  const nl::Weave::WeaveMessageInfo *aMsgInfo,
  nl::Weave::PacketBuffer *aPayload,
  const uint64_t & aCommandType,
  const bool aIsExpiryTimeValid,
  const int64_t & aExpiryTimeMicroSecond,
  const bool aIsMustBeVersionValid,
  const uint64_t & aMustBeVersion,
  nl::Weave::TLV::TLVReader & aArgumentReader
)

カスタム コマンドのハンドラ。

これは仮想的な方法です。オーバーライドしない場合、デフォルトの動作として、ステータス コード Common::kStatus_UnsupportedMessage を含むステータス レポートが返されます。

OnCustomCommand

virtual void OnCustomCommand(
  Command *aCommand,
  const nl::Weave::WeaveMessageInfo *aMsgInfo,
  nl::Weave::PacketBuffer *aPayload,
  nl::Weave::TLV::TLVReader & aArgumentReader
)

カスタム コマンドのハンドラ。

これは仮想的な方法です。オーバーライドしない場合、デフォルトの動作として、ステータス コード Common::kStatus_UnsupportedMessage を含むステータス レポートが返されます。

OnEvent

virtual WEAVE_ERROR OnEvent(
  uint16_t aType,
  void *aInEventParam
)

ReadData

WEAVE_ERROR ReadData(
  PropertyPathHandle aHandle,
  uint64_t aTagToWrite,
  TLV::TLVWriter & aWriter
)

SetDirty

void SetDirty(
  PropertyPathHandle aPropertyHandle
)

SetRootDirty

void SetRootDirty(
  void
)

SetVersion

void SetVersion(
  uint64_t version
)

TraitDataSource

 TraitDataSource(
  const TraitSchemaEngine *aEngine
)

ロック解除

WEAVE_ERROR Unlock(
  void
)

~TraitDataSource

virtual  ~TraitDataSource()

プロテクト関数

GetData

virtual WEAVE_ERROR GetData(
  PropertyPathHandle aHandle,
  uint64_t aTagToWrite,
  nl::Weave::TLV::TLVWriter & aWriter,
  bool & aIsNull,
  bool & aIsPresent
) __OVERRIDE

ノードへのパスハンドル、TLV ライター、値が null かどうかを示すブール値が与えられた場合、通知を作成するトレイト ソースからデータを取得します。

パスハンドルがリーフノードでない場合、TDM はライターへの値の書き込み（コンテナを開く、構造体を null 化するなど）を処理します。非リーフノードが null または存在しない場合、TDM はその子の GetData を呼び出しません。

この関数は、null 値許容のハンドル、オプション、エフェメラル、リーフのハンドルに対してのみ呼び出されます。これらのオプションが有効になっているハンドルを持つトレイトは、aIsNull と aIsPresent を入力するための適切なロジックを実装することが想定されています。

詳細
パラメータ
[in] aHandle
対象の PropertyPathHandle。
[in] aTagToWrite
aHandle 用に記述するタグ。
[in,out] aWriter
TLV 要素を書き込むライター。
[out] aIsNull
aHandle は null 化されていますか？「はい」の場合、TDM は null 要素を書き込みます。aHandle がリーフでない場合、TDM はその子をスキップします。
[out] aIsPresent
aHandle が存在するか「いいえ」で、かつ aHandle がリーフでない場合、TDM はパスとその子をスキップします。
戻り値
WEAVE_NO_ERROR
成功時。
other
データを取得してライターに書き込むことができませんでした。

GetLeafData

virtual WEAVE_ERROR GetLeafData(
  PropertyPathHandle aLeafHandle,
  uint64_t aTagToWrite,
  nl::Weave::TLV::TLVWriter & aWriter
) __OVERRIDE=0

リーフノードへのパスハンドルと TLV ライターが与えられたら、呼び出し先からデータを取得します。

詳細
戻り値
WEAVE_NO_ERROR
成功時。
other
データを取得してライターに書き込むことができませんでした。

IncrementVersion

void IncrementVersion(
  void
)