LteFeedback Class Reference

Simu5G: LteFeedback Class Reference
Simu5G
Public Member Functions | Protected Types | Protected Attributes
LteFeedback Class Reference

#include <LteFeedback.h>

Public Member Functions

void reset ()
 Create an empty feedback message.
bool isEmptyFeedback () const
 Return true if feedback is empty.
bool isPeriodicFeedback () const
 Return true if it is periodic.
bool hasRankIndicator () const
 check existence of elements
Rank getRankIndicator () const
 Get the rank indication. Does not check if valid.
CqiVector getWbCqi () const
 Get the wide-band CQI. Does not check if valid.
Cqi getWbCqi (Codeword cw) const
 Get the wide-band CQI for one codeword. Does not check if valid.
std::vector< CqiVector > getBandCqi () const
 Get the per-band CQI. Does not check if valid.
CqiVector getBandCqi (Codeword cw) const
 Get the per-band CQI for one codeword. Does not check if valid.
CqiVector getPreferredCqi () const
 Get the per preferred band CQI. Does not check if valid.
Cqi getPreferredCqi (Codeword cw) const
 Get the per preferred band CQI for one codeword. Does not check if valid.
BandSet getPreferredBands () const
 Get the set of preferred bands. Does not check if valid.
TxMode getTxMode () const
 Get the transmission mode.
Remote getAntennaId () const
void setRankIndicator (const Rank rank)
 Set the rank indicator.
void setWideBandCqi (const CqiVector wbCqi)
 Set the wide-band CQI.
void setWideBandCqi (const Cqi cqi, const Codeword cw)
 Set the wide-band CQI for one codeword. Does not check if valid.
void setPerBandCqi (const std::vector< CqiVector > bandCqi)
 Set the per-band CQI.
void setPerBandCqi (const CqiVector bandCqi, const Codeword cw)
 Set the per-band CQI for one codeword. Does not check if valid.
void setPreferredCqi (const CqiVector preferredCqi)
 Set the per preferred band CQI.
void setPreferredCqi (const Cqi preferredCqi, const Codeword cw)
 Set the per preferred band CQI for one codeword. Does not check if valid.
void setPreferredBands (const BandSet preferredBands)
 Set the per preferred bands. Invoke this function every time you invoke setPreferredCqi().
void setTxMode (const TxMode txMode)
 Set the transmission mode.
void setAntenna (const Remote antenna)
void setPeriodicity (const bool type)
 Set the periodicity type.
void print (MacCellId cellId, MacNodeId nodeId, Direction dir, const char *s) const

Protected Types

enum  
 Feedback status type enumerator. More...

Protected Attributes

Rank rank_
 Rank indicator.
CqiVector wideBandCqi_
 Wide-band CQI, one per codeword.
std::vector< CqiVector > perBandCqi_
 Per-band CQI. (bandCqi_[cw][band])
CqiVector preferredCqi_
 Per subset of preferred bands CQI.
BandSet preferredBands_
 Set of preferred bands.
unsigned int status_ = EMPTY
 Current status.
TxMode txMode_ = UNKNOWN_TX_MODE
 Current transmission mode.
bool periodicFeedback_ = true
 Periodicity of the feedback message.
Remote remoteAntennaId_ = MACRO

Detailed Description

LTE feedback message exchanged between PHY and AMC.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Feedback status type enumerator.

Member Function Documentation

◆ reset()

void reset ( )

Create an empty feedback message.

Reset this feedback message as empty.

◆ isEmptyFeedback()

bool isEmptyFeedback ( ) const
inline

Return true if feedback is empty.

References status_, and txMode_.

◆ isPeriodicFeedback()

bool isPeriodicFeedback ( ) const
inline

Return true if it is periodic.

References periodicFeedback_.

◆ hasRankIndicator()

bool hasRankIndicator ( ) const
inline

check existence of elements

References status_.

◆ getRankIndicator()

Rank getRankIndicator ( ) const
inline

Get the rank indication. Does not check if valid.

References rank_.

◆ getWbCqi() [1/2]

CqiVector getWbCqi ( ) const
inline

Get the wide-band CQI. Does not check if valid.

References wideBandCqi_.

◆ getWbCqi() [2/2]

Cqi getWbCqi ( Codeword cw) const
inline

Get the wide-band CQI for one codeword. Does not check if valid.

References wideBandCqi_.

◆ getBandCqi() [1/2]

std::vector< CqiVector > getBandCqi ( ) const
inline

Get the per-band CQI. Does not check if valid.

References perBandCqi_.

◆ getBandCqi() [2/2]

CqiVector getBandCqi ( Codeword cw) const
inline

Get the per-band CQI for one codeword. Does not check if valid.

References perBandCqi_.

◆ getPreferredCqi() [1/2]

CqiVector getPreferredCqi ( ) const
inline

Get the per preferred band CQI. Does not check if valid.

References preferredCqi_.

◆ getPreferredCqi() [2/2]

Cqi getPreferredCqi ( Codeword cw) const
inline

Get the per preferred band CQI for one codeword. Does not check if valid.

References preferredCqi_.

◆ getPreferredBands()

BandSet getPreferredBands ( ) const
inline

Get the set of preferred bands. Does not check if valid.

References preferredBands_.

◆ getTxMode()

TxMode getTxMode ( ) const
inline

Get the transmission mode.

References txMode_.

◆ getAntennaId()

Remote getAntennaId ( ) const
inline
Test
DAS support - Get the remote Antenna identifier

References remoteAntennaId_.

◆ setRankIndicator()

void setRankIndicator ( const Rank rank)
inline

Set the rank indicator.

References rank_, and status_.

◆ setWideBandCqi() [1/2]

void setWideBandCqi ( const CqiVector wbCqi)
inline

Set the wide-band CQI.

References status_, and wideBandCqi_.

◆ setWideBandCqi() [2/2]

void setWideBandCqi ( const Cqi cqi,
const Codeword cw )
inline

Set the wide-band CQI for one codeword. Does not check if valid.

References status_, and wideBandCqi_.

◆ setPerBandCqi() [1/2]

void setPerBandCqi ( const std::vector< CqiVector > bandCqi)
inline

Set the per-band CQI.

References perBandCqi_, and status_.

◆ setPerBandCqi() [2/2]

void setPerBandCqi ( const CqiVector bandCqi,
const Codeword cw )
inline

Set the per-band CQI for one codeword. Does not check if valid.

References perBandCqi_, and status_.

◆ setPreferredCqi() [1/2]

void setPreferredCqi ( const CqiVector preferredCqi)
inline

Set the per preferred band CQI.

References preferredCqi_, and status_.

◆ setPreferredCqi() [2/2]

void setPreferredCqi ( const Cqi preferredCqi,
const Codeword cw )
inline

Set the per preferred band CQI for one codeword. Does not check if valid.

References preferredCqi_, and status_.

◆ setPreferredBands()

void setPreferredBands ( const BandSet preferredBands)
inline

Set the per preferred bands. Invoke this function every time you invoke setPreferredCqi().

References preferredBands_.

◆ setTxMode()

void setTxMode ( const TxMode txMode)
inline

Set the transmission mode.

References txMode_.

◆ setAntenna()

void setAntenna ( const Remote antenna)
inline
Test
DAS support - Set the remote Antenna identifier

References remoteAntennaId_.

◆ setPeriodicity()

void setPeriodicity ( const bool type)
inline

Set the periodicity type.

References periodicFeedback_.

◆ print()

void print ( MacCellId cellId,
MacNodeId nodeId,
Direction dir,
const char * s ) const

Print debug information about the LteFeedback instance.

Parameters
cellIdThe cell ID.
nodeIdThe node ID.
dirThe link direction.
sThe name of the function that requested the debug.

Member Data Documentation

◆ rank_

Rank rank_
protected

Rank indicator.

Referenced by getRankIndicator(), and setRankIndicator().

◆ wideBandCqi_

CqiVector wideBandCqi_
protected

Wide-band CQI, one per codeword.

Referenced by getWbCqi(), getWbCqi(), setWideBandCqi(), and setWideBandCqi().

◆ perBandCqi_

std::vector<CqiVector> perBandCqi_
protected

Per-band CQI. (bandCqi_[cw][band])

Referenced by getBandCqi(), getBandCqi(), setPerBandCqi(), and setPerBandCqi().

◆ preferredCqi_

CqiVector preferredCqi_
protected

Per subset of preferred bands CQI.

Referenced by getPreferredCqi(), getPreferredCqi(), setPreferredCqi(), and setPreferredCqi().

◆ preferredBands_

BandSet preferredBands_
protected

Set of preferred bands.

Referenced by getPreferredBands(), and setPreferredBands().

◆ status_

unsigned int status_ = EMPTY
protected

Current status.

Referenced by hasRankIndicator(), isEmptyFeedback(), setPerBandCqi(), setPerBandCqi(), setPreferredCqi(), setPreferredCqi(), setRankIndicator(), setWideBandCqi(), and setWideBandCqi().

◆ txMode_

TxMode txMode_ = UNKNOWN_TX_MODE
protected

Current transmission mode.

Referenced by getTxMode(), isEmptyFeedback(), and setTxMode().

◆ periodicFeedback_

bool periodicFeedback_ = true
protected

Periodicity of the feedback message.

Referenced by isPeriodicFeedback(), and setPeriodicity().

◆ remoteAntennaId_

Remote remoteAntennaId_ = MACRO
protected
Test
DAS SUPPORT - Antenna identifier

Referenced by getAntennaId(), and setAntenna().

Generated by doxygen 1.14.0