Symbols

loading...

Files

loading (2/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Settings::ChildInfoIterator

ot::Settings::ChildInfoIterator class

Defines an iterator to access all Child Info entries in the settings.

Syntax

Show:

Summary

Declaration

from settings.hpp:956

class ChildInfoIterator : public SettingsBase, public Unequatable<ChildInfoIterator> { friend class ChildInfoIteratorBuilder; public: explicit ChildInfoIterator(Instance &aInstance); bool IsDone(void) const { return mIsDone; } void operator++(void) { Advance(); } void operator++(int) { Advance(); } const ChildInfo &GetChildInfo(void) const { return mChildInfo; } Error Delete(void); const ChildInfo &operator*(void) const { return mChildInfo; } bool operator==(const ChildInfoIterator &aOther) const { return (mIsDone && aOther.mIsDone) || (!mIsDone && !aOther.mIsDone && (mIndex == aOther.mIndex)); } private: enum IteratorType : uint8_t { kEndIterator, }; ChildInfoIterator(Instance &aInstance, IteratorType) : SettingsBase(aInstance) , mIndex(0) , mIsDone(true) { } void Advance(void); void Read(void); ChildInfo mChildInfo; uint16_t mIndex; bool mIsDone; };

Fields

Field

Declared as

ot::Settings::ChildInfoIterator::mChildInfo

ot::Settings::ChildInfoIterator::mIndex

uint16_t

ot::Settings::ChildInfoIterator::mIsDone

bool

Methods

IsDone() const

Indicates whether there are no more Child Info entries in the list (iterator has reached end of the list), or the current entry is valid.

operator++()

Overloads operator `++` (pre-increment) to advance the iterator to move to the next Child Info entry in the list (if any).

operator++()

Overloads operator `++` (pre-increment) to advance the iterator to move to the next Child Info entry in the list (if any).

GetChildInfo() const

Gets the Child Info corresponding to the current iterator entry in the list.

Delete()

Deletes the current Child Info entry.

operator*() const

Overloads the `*` dereference operator and gets a reference to `ChildInfo` entry to which the iterator is currently pointing.

operator() const

Overloads operator `==` to evaluate whether or not two iterator instances are equal.

Advance()

Read()

References

Code

Location

Scope

Referrer

class ChildInfoIterator : public SettingsBase, public Unequatable<ChildInfoIterator>

settings.hpp:956

for (Settings::ChildInfoIterator iter(GetInstance()); !iter.IsDone(); iter++)

child_table.cpp:270

ot::ChildTable::RemoveStoredChild()

Settings::ChildInfoIterator::ChildInfoIterator(Instance &aInstance)

settings.cpp:285

ot::Settings::ChildInfoIterator::ChildInfoIterator()

void Settings::ChildInfoIterator::Advance(void)

settings.cpp:293

ot::Settings::ChildInfoIterator::Advance()

Error Settings::ChildInfoIterator::Delete(void)

settings.cpp:302

ot::Settings::ChildInfoIterator::Delete()

void Settings::ChildInfoIterator::Read(void)

settings.cpp:314

ot::Settings::ChildInfoIterator::Read()

bool operator==(const ChildInfoIterator &aOther) const

settings.hpp:1028

ot::Settings::ChildInfoIterator::operator() const

ot::Settings::ChildInfoIterator::operator() const::aOther

ChildInfoIterator begin(void) { return ChildInfoIterator(GetInstance()); }

settings.hpp:1111

ot::Settings::ChildInfoIteratorBuilder

ot::Settings::ChildInfoIteratorBuilder::begin()

ChildInfoIterator end(void) { return ChildInfoIterator(GetInstance(), ChildInfoIterator::kEndIterator); }

settings.hpp:1112

ot::Settings::ChildInfoIteratorBuilder

ot::Settings::ChildInfoIteratorBuilder::end()

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::Settings::ChildInfoIterator is inherited by 1 classes:

ot::Settings::ChildInfoIterator

ot::SettingsBase

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

ot::Settings::ChildInfoIterator::operator() const::aOther

ot::Settings::ChildInfoIterator::operator() const

settings.hpp:1028

return

ot::Settings::ChildInfoIteratorBuilder::begin()

settings.hpp:1111

return

ot::Settings::ChildInfoIteratorBuilder::end()

settings.hpp:1112

Lifecycle

All items filtered out

All items filtered out