ESP-IDF
ot::LinkQuality
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading...
Files
loading...
Summary
Syntax
Values
Examples
References
Call Tree
Data Use
Class Tree
Override Tree
Implementations
Instances
Lifecycle
SourceVu
ESP-IDF Framework and Examples
ESP-IDF
ot::LinkQuality
ot::LinkQuality enum
Represents the link quality constants. Link Quality is an integer in [0, 3]. A higher link quality indicates a more usable link, with 0 indicating that the link is non-existent or unusable.
Syntax
Show:
Summary
Declaration
from
link_quality.hpp:220
enum
LinkQuality
:
uint8_t
{
kLinkQuality0
=
0
,
kLinkQuality1
=
1
,
kLinkQuality2
=
2
,
kLinkQuality3
=
3
,
}
;
Values
Value
Declared as
ot::LinkQuality::kLinkQuality0
=
0
ot::LinkQuality::kLinkQuality1
=
1
ot::LinkQuality::kLinkQuality2
=
2
ot::LinkQuality::kLinkQuality3
=
3
Examples
References
from
examples
Code
Location
Scope
Referrer
enum
LinkQuality
:
uint8_t
link_quality.hpp:220
static_cast
<
LinkQuality
>
(
aLinkQuality
)
)
;
link_api.cpp:301
otLinkConvertLinkQualityToRss()
LinkQuality
LinkQualityForLinkMargin
(
uint8_t
aLinkMargin
)
link_quality.cpp:188
ot::LinkQualityForLinkMargin()
int8_t
GetTypicalRssForLinkQuality
(
int8_t
aNoiseFloor
,
LinkQuality
aLinkQuality
)
link_quality.cpp:193
ot::GetTypicalRssForLinkQuality()
ot::GetTypicalRssForLinkQuality()::aLinkQuality
uint8_t
CostForLinkQuality
(
LinkQuality
aLinkQuality
)
link_quality.cpp:219
ot::CostForLinkQuality()
ot::CostForLinkQuality()::aLinkQuality
LinkQuality
LinkQualityInfo
::
CalculateLinkQuality
(
uint8_t
aLinkMargin
,
uint8_t
aLastLinkQuality
)
link_quality.cpp:246
ot::LinkQualityInfo
ot::LinkQualityInfo::CalculateLinkQuality()
LinkQuality
linkQuality
=
kLinkQuality0
;
link_quality.cpp:255
ot::LinkQualityInfo::CalculateLinkQuality()
uint8_t
CostForLinkQuality
(
LinkQuality
aLinkQuality
)
;
link_quality.hpp:240
ot::CostForLinkQuality()
ot::CostForLinkQuality()::aLinkQuality
LinkQuality
LinkQualityForLinkMargin
(
uint8_t
aLinkMargin
)
;
link_quality.hpp:259
ot::LinkQualityForLinkMargin()
int8_t
GetTypicalRssForLinkQuality
(
int8_t
aNoiseFloor
,
LinkQuality
aLinkQuality
)
;
link_quality.hpp:269
ot::GetTypicalRssForLinkQuality()
ot::GetTypicalRssForLinkQuality()::aLinkQuality
friend
LinkQuality
LinkQualityForLinkMargin
(
uint8_t
aLinkMargin
)
;
link_quality.hpp:277
ot::LinkQualityForLinkMargin()
friend
int8_t
GetTypicalRssForLinkQuality
(
int8_t
aNoiseFloor
,
LinkQuality
aLinkQuality
)
;
link_quality.hpp:278
ot::GetTypicalRssForLinkQuality()
ot::GetTypicalRssForLinkQuality()::aLinkQuality
LinkQuality
GetLinkQuality
(
void
)
const
{
return
mLinkQuality
;
}
link_quality.hpp:355
ot::LinkQualityInfo
ot::LinkQualityInfo::GetLinkQuality() const
void
SetLinkQuality
(
LinkQuality
aLinkQuality
)
{
mLinkQuality
=
aLinkQuality
;
}
link_quality.hpp:425
ot::LinkQualityInfo::SetLinkQuality()
ot::LinkQualityInfo::SetLinkQuality()::aLinkQuality
static
LinkQuality
CalculateLinkQuality
(
uint8_t
aLinkMargin
,
uint8_t
aLastLinkQuality
)
;
link_quality.hpp:427
ot::LinkQualityInfo
ot::LinkQualityInfo::CalculateLinkQuality()
LinkQuality
mLinkQuality
;
link_quality.hpp:430
ot::LinkQualityInfo
ot::LinkQualityInfo::mLinkQuality
LinkQuality
oldLinkQuality
=
aNeighbor
.
GetLinkInfo
(
)
.
GetLinkQuality
(
)
;
mac.cpp:2068
ot::Mac::Mac::UpdateNeighborLinkInfo()
LinkQuality
localLinkQuality
;
mle_router.cpp:3677
ot::Mle::MleRouter::NeighborHasComparableConnectivity() const
LinkQuality
peerLinkQuality
;
mle_router.cpp:3678
ot::Mle::MleRouter::NeighborHasComparableConnectivity() const
void
ConnectivityTlv
::
IncrementLinkQuality
(
LinkQuality
aLinkQuality
)
mle_tlvs.cpp:72
ot::Mle::ConnectivityTlv::IncrementLinkQuality()
ot::Mle::ConnectivityTlv::IncrementLinkQuality()::aLinkQuality
LinkQuality
GetLinkQualityIn
(
uint8_t
aRouterIndex
)
const
mle_tlvs.hpp:323
ot::Mle::RouteTlv
ot::Mle::RouteTlv::GetLinkQualityIn() const
return
static_cast
<
LinkQuality
>
(
(
mRouteData
[
aRouterIndex
]
&
kLinkQualityInMask
)
>
>
kLinkQualityInOffset
)
;
mle_tlvs.hpp:325
ot::Mle::RouteTlv::GetLinkQualityIn() const
LinkQuality
GetLinkQualityOut
(
uint8_t
aRouterIndex
)
const
mle_tlvs.hpp:335
ot::Mle::RouteTlv
ot::Mle::RouteTlv::GetLinkQualityOut() const
return
static_cast
<
LinkQuality
>
(
(
mRouteData
[
aRouterIndex
]
&
kLinkQualityOutMask
)
>
>
kLinkQualityOutOffset
)
;
mle_tlvs.hpp:337
ot::Mle::RouteTlv::GetLinkQualityOut() const
void
SetRouteData
(
uint8_t
aRouterIndex
,
LinkQuality
aLinkQualityIn
,
LinkQuality
aLinkQualityOut
,
uint8_t
aRouteCost
)
mle_tlvs.hpp:348
ot::Mle::RouteTlv::SetRouteData()
ot::Mle::RouteTlv::SetRouteData()::aLinkQualityOut
void
IncrementLinkQuality
(
LinkQuality
aLinkQuality
)
;
mle_tlvs.hpp:771
ot::Mle::ConnectivityTlv::IncrementLinkQuality()
ot::Mle::ConnectivityTlv::IncrementLinkQuality()::aLinkQuality
LinkQuality
GetLinkQualityIn
(
void
)
const
{
return
GetLinkInfo
(
)
.
GetLinkQuality
(
)
;
}
neighbor.hpp:586
ot::Neighbor
ot::Neighbor::GetLinkQualityIn() const
LinkQuality
GetLinkQuality
(
void
)
const
network_diagnostic_tlvs.hpp:513
ot::NetworkDiagnostic::ChildTableEntry
ot::NetworkDiagnostic::ChildTableEntry::GetLinkQuality() const
return
static_cast
<
LinkQuality
>
(
(
GetTimeoutChildId
(
)
&
kLqiMask
)
>
>
kLqiOffset
)
;
network_diagnostic_tlvs.hpp:515
ot::NetworkDiagnostic::ChildTableEntry::GetLinkQuality() const
void
SetLinkQuality
(
LinkQuality
aLinkQuality
)
network_diagnostic_tlvs.hpp:523
ot::NetworkDiagnostic::ChildTableEntry::SetLinkQuality()
ot::NetworkDiagnostic::ChildTableEntry::SetLinkQuality()::aLinkQuality
LinkQuality
Router
::
GetTwoWayLinkQuality
(
void
)
const
{
return
Min
(
GetLinkQualityIn
(
)
,
GetLinkQualityOut
(
)
)
;
}
router.cpp:73
ot::Router
ot::Router::GetTwoWayLinkQuality() const
LinkQuality
GetLinkQualityOut
(
void
)
const
{
return
static_cast
<
LinkQuality
>
(
mLinkQualityOut
)
;
}
router.hpp:101
ot::Router::GetLinkQualityOut() const
void
SetLinkQualityOut
(
LinkQuality
aLinkQuality
)
{
mLinkQualityOut
=
aLinkQuality
;
}
router.hpp:108
ot::Router::SetLinkQualityOut()
ot::Router::SetLinkQualityOut()::aLinkQuality
LinkQuality
GetTwoWayLinkQuality
(
void
)
const
;
router.hpp:115
ot::Router
ot::Router::GetTwoWayLinkQuality() const
uint8_t
RouterTable
::
GetNeighborCount
(
LinkQuality
aLinkQuality
)
const
router_table.cpp:338
ot::RouterTable::GetNeighborCount() const
ot::RouterTable::GetNeighborCount() const::aLinkQuality
LinkQuality
linkQuality
=
aRouteTlv
.
GetLinkQualityIn
(
index
)
;
router_table.cpp:592
ot::RouterTable::UpdateRoutes()
uint8_t
GetNeighborCount
(
LinkQuality
aLinkQuality
)
const
;
router_table.hpp:309
ot::RouterTable::GetNeighborCount() const
ot::RouterTable::GetNeighborCount() const::aLinkQuality
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
All items filtered out
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::CostForLinkQuality()::aLinkQuality
ot::CostForLinkQuality()
link_quality.hpp:240
return
ot::LinkQualityForLinkMargin()
link_quality.hpp:259
ot::GetTypicalRssForLinkQuality()::aLinkQuality
ot::GetTypicalRssForLinkQuality()
link_quality.hpp:269
return
ot::LinkQualityForLinkMargin()
link_quality.hpp:277
ot::GetTypicalRssForLinkQuality()::aLinkQuality
ot::GetTypicalRssForLinkQuality()
link_quality.hpp:278
return
ot::LinkQualityInfo::GetLinkQuality() const
link_quality.hpp:355
ot::LinkQualityInfo::SetLinkQuality()::aLinkQuality
ot::LinkQualityInfo::SetLinkQuality()
link_quality.hpp:425
return
ot::LinkQualityInfo::CalculateLinkQuality()
link_quality.hpp:427
ot::LinkQualityInfo::mLinkQuality
ot::LinkQualityInfo
link_quality.hpp:430
return
ot::Mle::RouteTlv::GetLinkQualityIn() const
mle_tlvs.hpp:323
return
ot::Mle::RouteTlv::GetLinkQualityOut() const
mle_tlvs.hpp:335
ot::Mle::RouteTlv::SetRouteData()::aLinkQualityIn
ot::Mle::RouteTlv::SetRouteData()
mle_tlvs.hpp:348
ot::Mle::RouteTlv::SetRouteData()::aLinkQualityOut
ot::Mle::RouteTlv::SetRouteData()
mle_tlvs.hpp:348
ot::Mle::ConnectivityTlv::IncrementLinkQuality()::aLinkQuality
ot::Mle::ConnectivityTlv::IncrementLinkQuality()
mle_tlvs.hpp:771
return
ot::Neighbor::GetLinkQualityIn() const
neighbor.hpp:586
return
ot::Router::GetLinkQualityOut() const
router.hpp:101
ot::Router::SetLinkQualityOut()::aLinkQuality
ot::Router::SetLinkQualityOut()
router.hpp:108
return
ot::Router::GetTwoWayLinkQuality() const
router.hpp:115
ot::RouterTable::GetNeighborCount() const::aLinkQuality
ot::RouterTable::GetNeighborCount() const
router_table.hpp:309
return
ot::NetworkDiagnostic::ChildTableEntry::GetLinkQuality() const
network_diagnostic_tlvs.hpp:513
ot::NetworkDiagnostic::ChildTableEntry::SetLinkQuality()::aLinkQuality
ot::NetworkDiagnostic::ChildTableEntry::SetLinkQuality()
network_diagnostic_tlvs.hpp:523
return
ot::LinkQualityForLinkMargin()
link_quality.cpp:188
ot::GetTypicalRssForLinkQuality()::aLinkQuality
ot::GetTypicalRssForLinkQuality()
link_quality.cpp:193
ot::CostForLinkQuality()::aLinkQuality
ot::CostForLinkQuality()
link_quality.cpp:219
return
ot::LinkQualityInfo::CalculateLinkQuality()
link_quality.cpp:246
ot::Mle::ConnectivityTlv::IncrementLinkQuality()::aLinkQuality
ot::Mle::ConnectivityTlv::IncrementLinkQuality()
mle_tlvs.cpp:72
return
ot::Router::GetTwoWayLinkQuality() const
router.cpp:73
ot::RouterTable::GetNeighborCount() const::aLinkQuality
ot::RouterTable::GetNeighborCount() const
router_table.cpp:338
Lifecycle
from
examples
All items filtered out
All items filtered out