ESP-IDF
ot::Parent
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading...
Files
loading (1/5)...
Summary
Syntax
Methods
Related
Examples
References
Call Tree
Data Use
Class Tree
Override Tree
Implementations
Instances
Lifecycle
SourceVu
ESP-IDF Framework and Examples
ESP-IDF
ot::Parent
ot::Parent class
Represent parent of a child node.
Syntax
Show:
Summary
Declaration
Definition
from
router.hpp:43
class
Parent
;
class
Router
:
public
Neighbor
{
public
:
class
Info
:
public
otRouterInfo
,
public
Clearable
<
Info
>
{
public
:
void
SetFrom
(
const
Router
&
aRouter
)
;
void
SetFrom
(
const
Parent
&
aParent
)
;
}
;
void
Init
(
Instance
&
aInstance
)
{
Neighbor
::
Init
(
aInstance
)
;
}
void
Clear
(
void
)
;
void
SetFrom
(
const
Parent
&
aParent
)
;
uint8_t
GetNextHop
(
void
)
const
{
return
mNextHop
;
}
LinkQuality
GetLinkQualityOut
(
void
)
const
{
return
static_cast
<
LinkQuality
>
(
mLinkQualityOut
)
;
}
void
SetLinkQualityOut
(
LinkQuality
aLinkQuality
)
{
mLinkQualityOut
=
aLinkQuality
;
}
LinkQuality
GetTwoWayLinkQuality
(
void
)
const
;
uint8_t
GetCost
(
void
)
const
{
return
mCost
;
}
bool
SetNextHopAndCost
(
uint8_t
aNextHop
,
uint8_t
aCost
)
;
bool
SetNextHopToInvalid
(
void
)
;
private
:
uint8_t
mNextHop
;
uint8_t
mLinkQualityOut
:
2
;
#if
OPENTHREAD_CONFIG_MLE_LONG_ROUTES_ENABLE
uint8_t
mCost
;
#else
uint8_t
mCost
:
4
;
#endif
}
;
class
Parent
:
public
Router
;
Implemented in
router.hpp:157
Fields
Field
Declared as
ot::Parent::mLeaderCost
uint8_t
Methods
Init()
Initializes the `Parent`.
Clear()
Clears the parent entry.
GetLeaderCost() const
Gets route cost from parent to leader.
SetLeaderCost()
Sets route cost from parent to leader.
Related Functions
Found 2 other functions taking a
Parent
argument:
Function
Description
ot::Router::SetFrom()
Sets the `Router` entry from a `Parent`
ot::Mle::Mle::ParentCandidate::CopyTo() const
Examples
References
from
examples
Code
Location
Scope
Referrer
class
Parent
:
public
Router
router.hpp:157
class
Parent
;
router.hpp:43
void
Mle
::
ParentCandidate
::
CopyTo
(
Parent
&
aParent
)
const
mle.cpp:5171
ot::Mle::Mle::ParentCandidate::CopyTo() const
ot::Mle::Mle::ParentCandidate::CopyTo() const::aParent
const
Parent
*
candidateAsParent
=
this
;
mle.cpp:5177
ot::Mle::Mle::ParentCandidate::CopyTo() const
Parent
&
GetParent
(
void
)
{
return
mParent
;
}
mle.hpp:401
ot::Mle::Mle
ot::Mle::Mle::GetParent()
const
Parent
&
GetParent
(
void
)
const
{
return
mParent
;
}
mle.hpp:408
ot::Mle::Mle
ot::Mle::Mle::GetParent() const
Parent
&
GetParentCandidate
(
void
)
{
return
mParentCandidate
;
}
mle.hpp:425
ot::Mle::Mle
ot::Mle::Mle::GetParentCandidate()
class
ParentCandidate
:
public
Parent
mle.hpp:1128
ot::Mle::Mle
ot::Mle::Mle::ParentCandidate
void
Init
(
Instance
&
aInstance
)
{
Parent
::
Init
(
aInstance
)
;
}
mle.hpp:1131
ot::Mle::Mle::ParentCandidate::Init()
void
CopyTo
(
Parent
&
aParent
)
const
;
mle.hpp:1133
ot::Mle::Mle::ParentCandidate::CopyTo() const
ot::Mle::Mle::ParentCandidate::CopyTo() const::aParent
Parent
mParent
;
mle.hpp:1382
ot::Mle::Mle
ot::Mle::Mle::mParent
void
Router
::
Info
::
SetFrom
(
const
Parent
&
aParent
)
router.cpp:56
ot::Router::Info::SetFrom()
void
Router
::
SetFrom
(
const
Parent
&
aParent
)
router.cpp:75
ot::Router::SetFrom()
ot::Router::SetFrom()::aParent
void
Parent
::
Clear
(
void
)
router.cpp:86
ot::Parent::Clear()
void
SetFrom
(
const
Parent
&
aParent
)
;
router.hpp:69
ot::Router::Info::SetFrom()
void
SetFrom
(
const
Parent
&
aParent
)
;
router.hpp:87
ot::Router::SetFrom()
ot::Router::SetFrom()::aParent
Call Tree
from
examples
All items filtered out
All items filtered out
Data Use
from
examples
All items filtered out
All items filtered out
Class Tree
from
examples
ot::Parent
inherits 1 classes and is inherited by 1 classes:
ot::Mle::Mle::ParentCandidate
All items filtered out
ot::Parent
ot::Router
All items filtered out
Override Tree
from
examples
All items filtered out
All items filtered out
Implementations
from
examples
All items filtered out
All items filtered out
Instances
from
examples
Instance
Scope
Location
Project
ot::Router::SetFrom()::aParent
ot::Router::SetFrom()
router.hpp:87
return
ot::Mle::Mle::GetParent()
mle.hpp:401
return
ot::Mle::Mle::GetParent() const
mle.hpp:408
return
ot::Mle::Mle::GetParentCandidate()
mle.hpp:425
ot::Mle::Mle::ParentCandidate::CopyTo() const::aParent
ot::Mle::Mle::ParentCandidate::CopyTo() const
mle.hpp:1133
ot::Mle::Mle::mParent
ot::Mle::Mle
mle.hpp:1382
ot::Mle::Mle::ParentCandidate::CopyTo() const::aParent
ot::Mle::Mle::ParentCandidate::CopyTo() const
mle.cpp:5171
ot::Router::SetFrom()::aParent
ot::Router::SetFrom()
router.cpp:75
Lifecycle
from
examples
All items filtered out
All items filtered out