R2RI neighbor metrics are used in conjunction with the R2RINeighborMetricControlMessage to inform an NEM's transport layer of MAC neighbor state. More...

#include <r2rineighbormetric.h>

Public Member Functions
	R2RINeighborMetric (NEMId id, std::uint64_t u64NumRxFrames, std::uint64_t u64NumTxFrames, std::uint64_t u64NumMissedFrames, const Microseconds &bandwidthConsumption, float fSINRAvgdBm, float fSINRStddev, float fNoiseFloorAvgdBm, float fNoiseFloorStddev, std::uint64_t u64RxAvgDataRatebps, std::uint64_t u64TxAvgDataRatebps)

	~R2RINeighborMetric ()

NEMId	getId () const

std::uint64_t	getNumRxFrames () const

std::uint64_t	getNumTxFrames () const

std::uint64_t	getNumMissedFrames () const

const Microseconds &	getBandwidthConsumption () const

float	getSINRAvgdBm () const

float	getSINRStddev () const

float	getNoiseFloorAvgdBm () const

float	getNoiseFloorStddev () const

std::uint64_t	getRxAvgDataRatebps () const

std::uint64_t	getTxAvgDataRatebps () const

Detailed Description

R2RI neighbor metrics are used in conjunction with the R2RINeighborMetricControlMessage to inform an NEM's transport layer of MAC neighbor state.

Note: Instances are immutable

Definition at line 53 of file r2rineighbormetric.h.

Constructor & Destructor Documentation

◆ R2RINeighborMetric()

EMANE::Controls::R2RINeighborMetric::R2RINeighborMetric	(	NEMId	id,
		std::uint64_t	u64NumRxFrames,
		std::uint64_t	u64NumTxFrames,
		std::uint64_t	u64NumMissedFrames,
		const Microseconds &	bandwidthConsumption,
		float	fSINRAvgdBm,
		float	fSINRStddev,
		float	fNoiseFloorAvgdBm,
		float	fNoiseFloorStddev,
		std::uint64_t	u64RxAvgDataRatebps,
		std::uint64_t	u64TxAvgDataRatebps
	)

inline

Creates an R2RINeighborMetric

Parameters

id	Neighbor NEM id
u64NumRxFrames	Number of frames received from the neighbor
u64NumTxFrames	Number of frames sent to the neighbor
u64NumMissedFrames	Number of frames missed from the neighbor
bandwidthConsumption	Bandwidth consumption in microseconds
fSINRAvgdBm	Average SINR from neighbor in dBm
fSINRStddev	Standard deviation SINR from neighbor
fNoiseFloorAvgdBm	Average noise floor from neighbor in dBm
fNoiseFloorStddev	Standard deviation noise floor from neighbor
u64RxAvgDataRatebps	Average Rx datarate from neighbor bps
u64TxAvgDataRatebps	Average Tx datarate to neighbor bps

Note: All data is over the report interval

See also: R2RISelfMetricControlMessage for report interval

Definition at line 34 of file r2rineighbormetric.inl.

◆ ~R2RINeighborMetric()

EMANE::Controls::R2RINeighborMetric::~R2RINeighborMetric ( )

inline

Destroys an instance

Definition at line 59 of file r2rineighbormetric.inl.

Member Function Documentation

◆ getBandwidthConsumption()

const EMANE::Microseconds & EMANE::Controls::R2RINeighborMetric::getBandwidthConsumption ( ) const

inline

Gets the bandwidth consumption over the report interval

Returns: bandwidth consumption

Definition at line 86 of file r2rineighbormetric.inl.

◆ getId()

EMANE::NEMId EMANE::Controls::R2RINeighborMetric::getId ( ) const

inline

Get neighbor NEM Id

Returns: NEM Id

Definition at line 62 of file r2rineighbormetric.inl.

◆ getNoiseFloorAvgdBm()

float EMANE::Controls::R2RINeighborMetric::getNoiseFloorAvgdBm ( ) const

inline

Gets the average noise floor over the report interval

Returns: average noise floor

Definition at line 104 of file r2rineighbormetric.inl.

◆ getNoiseFloorStddev()

float EMANE::Controls::R2RINeighborMetric::getNoiseFloorStddev ( ) const

inline

Gets the noise floor standard deviation over the report interval

Returns: noise floor standard deviation

Definition at line 110 of file r2rineighbormetric.inl.

◆ getNumMissedFrames()

std::uint64_t EMANE::Controls::R2RINeighborMetric::getNumMissedFrames ( ) const

inline

Gets the number of frames missed during the report interval

Returns: number of frames

Definition at line 80 of file r2rineighbormetric.inl.

◆ getNumRxFrames()

std::uint64_t EMANE::Controls::R2RINeighborMetric::getNumRxFrames ( ) const

inline

Gets the number of frames received during the report interval

Returns: number of frames

Definition at line 68 of file r2rineighbormetric.inl.

◆ getNumTxFrames()

std::uint64_t EMANE::Controls::R2RINeighborMetric::getNumTxFrames ( ) const

inline

Gets the number of frames transmitted during the report interval

Returns: number of frames

Definition at line 74 of file r2rineighbormetric.inl.

◆ getRxAvgDataRatebps()

std::uint64_t EMANE::Controls::R2RINeighborMetric::getRxAvgDataRatebps ( ) const

inline

Gets the average receive datarate in bps over the report interval

Returns: average data rate

Definition at line 116 of file r2rineighbormetric.inl.

◆ getSINRAvgdBm()

float EMANE::Controls::R2RINeighborMetric::getSINRAvgdBm ( ) const

inline

Gets the average SINR over the report interval

Returns: average SINR

Definition at line 92 of file r2rineighbormetric.inl.

◆ getSINRStddev()

float EMANE::Controls::R2RINeighborMetric::getSINRStddev ( ) const

inline

Gets the SINR standard deviation over the report interval

Returns: SINR standard deviation

Definition at line 98 of file r2rineighbormetric.inl.

◆ getTxAvgDataRatebps()

std::uint64_t EMANE::Controls::R2RINeighborMetric::getTxAvgDataRatebps ( ) const

inline

Gets the average transmit datarate in bps over the report interval

Returns: average data rate

Definition at line 122 of file r2rineighbormetric.inl.

The documentation for this class was generated from the following files:

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ R2RINeighborMetric()

◆ ~R2RINeighborMetric()

Member Function Documentation

◆ getBandwidthConsumption()

◆ getId()

◆ getNoiseFloorAvgdBm()

◆ getNoiseFloorStddev()

◆ getNumMissedFrames()

◆ getNumRxFrames()

◆ getNumTxFrames()

◆ getRxAvgDataRatebps()

◆ getSINRAvgdBm()

◆ getSINRStddev()

◆ getTxAvgDataRatebps()