#include <Ieee80211ReceiverBase.h>

Inheritance diagram for inet::physicallayer::Ieee80211ReceiverBase:

Public Member Functions
	Ieee80211ReceiverBase ()

virtual	~Ieee80211ReceiverBase ()

virtual const IReceptionResult *	computeReceptionResult (const IListening listening, const IReception reception, const IInterference interference, const ISnir snir, const std::vector< const IReceptionDecision * > *decisions) const override
	Returns the complete result of the reception process for the provided reception. More...

virtual std::ostream &	printToStream (std::ostream &stream, int level, int evFlags=0) const override
	Prints this object to the provided output stream. More...

virtual void	setModeSet (const Ieee80211ModeSet *modeSet)

virtual void	setBand (const IIeee80211Band *band)

virtual void	setChannel (const Ieee80211Channel *channel)

virtual void	setChannelNumber (int channelNumber)

Public Member Functions inherited from inet::physicallayer::FlatReceiverBase
	FlatReceiverBase ()

virtual W	getMinReceptionPower () const override
	Returns the minimum reception power below which successful reception is definitely not possible. More...

virtual const IListeningDecision *	computeListeningDecision (const IListening listening, const IInterference interference) const override
	Returns the result of the listening process specifying the reception state of the receiver. More...

virtual const IErrorModel *	getErrorModel () const

virtual W	getEnergyDetection () const

virtual void	setEnergyDetection (W energyDetection)

virtual W	getSensitivity () const

virtual void	setSensitivity (W sensitivity)

Public Member Functions inherited from inet::physicallayer::NarrowbandReceiverBase
	NarrowbandReceiverBase ()

virtual const IListening *	createListening (const IRadio *radio, const simtime_t startTime, const simtime_t endTime, const Coord &startPosition, const Coord &endPosition) const override
	Returns a description of how the receiver is listening on the medium. More...

virtual bool	computeIsReceptionPossible (const IListening listening, const ITransmission transmission) const override
	Returns whether the reception of the provided transmission is possible or not independently of the reception conditions. More...

virtual const IReceptionDecision *	computeReceptionDecision (const IListening listening, const IReception reception, IRadioSignal::SignalPart part, const IInterference interference, const ISnir snir) const override
	Returns the reception decision for the transmission part that specifies whether the reception is possible, attempted, and successful. More...

virtual const IModulation *	getModulation () const

virtual void	setModulation (const IModulation *modulation)

virtual Hz	getCenterFrequency () const

virtual void	setCenterFrequency (Hz centerFrequency)

virtual Hz	getBandwidth () const

virtual void	setBandwidth (Hz bandwidth)

Public Member Functions inherited from inet::physicallayer::SnirReceiverBase
virtual double	getSNIRThreshold () const

Public Member Functions inherited from inet::physicallayer::ReceiverBase
	ReceiverBase ()

virtual W	getMinInterferencePower () const override
	Returns the minimum interference power below which receptions are to be ignored while computing the interference. More...

virtual bool	computeIsReceptionAttempted (const IListening listening, const IReception reception, IRadioSignal::SignalPart part, const IInterference *interference) const override
	Returns whether the reception of the provided part is actually attempted or ignored by the receiver. More...

Public Member Functions inherited from inet::IPrintableObject
virtual	~IPrintableObject ()

virtual std::string	printToString () const

virtual std::string	printToString (int level, int evFlags=0) const

virtual std::string	getInfoStringRepresentation (int evFlags=0) const

virtual std::string	getDetailStringRepresentation (int evFlags=0) const

virtual std::string	getDebugStringRepresentation (int evFlags=0) const

virtual std::string	getTraceStringRepresentation (int evFlags=0) const

virtual std::string	getCompleteStringRepresentation (int evFlags=0) const

Protected Member Functions
virtual void	initialize (int stage) override

Protected Member Functions inherited from inet::physicallayer::FlatReceiverBase
virtual bool	computeIsReceptionPossible (const IListening listening, const IReception reception, IRadioSignal::SignalPart part) const override
	Returns whether the reception of the provided part is possible or not. More...

virtual bool	computeIsReceptionSuccessful (const IListening listening, const IReception reception, IRadioSignal::SignalPart part, const IInterference interference, const ISnir snir) const override
	Returns whether the reception of the provided part is actually successful or failed by the receiver. More...

virtual Packet *	computeReceivedPacket (const ISnir *snir, bool isReceptionSuccessful) const override

virtual bool	computeIsReceptionPossible (const IListening listening, const ITransmission transmission) const override

virtual bool	computeIsReceptionPossible (const IListening listening, const IReception reception, IRadioSignal::SignalPart part) const override

Protected Member Functions inherited from inet::physicallayer::ReceiverBase
virtual int	numInitStages () const override

virtual W	computeSignalPower (const IListening listening, const ISnir snir, const IInterference *interference) const

Protected Attributes
const Ieee80211ModeSet *	modeSet

const IIeee80211Band *	band

const Ieee80211Channel *	channel

Protected Attributes inherited from inet::physicallayer::FlatReceiverBase
const IErrorModel *	errorModel

W	energyDetection

W	sensitivity

Protected Attributes inherited from inet::physicallayer::NarrowbandReceiverBase
const IModulation *	modulation

Hz	centerFrequency

Hz	bandwidth

Protected Attributes inherited from inet::physicallayer::SnirReceiverBase
double	snirThreshold = NaN

SnirThresholdMode	snirThresholdMode = SnirThresholdMode::STM_UNDEFINED

Additional Inherited Members
Public Types inherited from inet::IPrintableObject
enum	PrintLevel { PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO, PRINT_LEVEL_COMPLETE = INT_MIN }

enum	PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }

Protected Types inherited from inet::physicallayer::SnirReceiverBase
enum	SnirThresholdMode { SnirThresholdMode::STM_UNDEFINED = -1, SnirThresholdMode::STM_MIN, SnirThresholdMode::STM_MEAN }

Constructor & Destructor Documentation

◆ Ieee80211ReceiverBase()

inet::physicallayer::Ieee80211ReceiverBase::Ieee80211ReceiverBase ( )

                                              :
     modeSet(nullptr),
     band(nullptr),
     channel(nullptr)
 {
 }

◆ ~Ieee80211ReceiverBase()

inet::physicallayer::Ieee80211ReceiverBase::~Ieee80211ReceiverBase ( )

virtual

 {
     delete channel;
 }

Member Function Documentation

◆ computeReceptionResult()

const IReceptionResult * inet::physicallayer::Ieee80211ReceiverBase::computeReceptionResult	(	const IListening *	listening,
		const IReception *	reception,
		const IInterference *	interference,
		const ISnir *	snir,
		const std::vector< const IReceptionDecision * > *	decisions
	)		const

overridevirtual

Returns the complete result of the reception process for the provided reception.

This function may be called before the reception actually starts at the receiver, thus it must be purely functional and support optimistic parallel computation.

Reimplemented from inet::physicallayer::FlatReceiverBase.

 {
     auto transmission = check_and_cast<const Ieee80211TransmissionBase *>(reception->getTransmission());
     auto receptionResult = FlatReceiverBase::computeReceptionResult(listening, reception, interference, snir, decisions);
     auto packet = const_cast<Packet *>(receptionResult->getPacket());
     packet->addTagIfAbsent<Ieee80211ModeInd>()->setMode(transmission->getMode());
     packet->addTagIfAbsent<Ieee80211ChannelInd>()->setChannel(transmission->getChannel());
     return receptionResult;
 }

◆ initialize()

void inet::physicallayer::Ieee80211ReceiverBase::initialize ( int stage )

overrideprotectedvirtual

Reimplemented from inet::physicallayer::FlatReceiverBase.

 {
     FlatReceiverBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         const char *opMode = par("opMode");
         setModeSet(*opMode ? Ieee80211ModeSet::getModeSet(opMode) : nullptr);
         const char *bandName = par("bandName");
         setBand(*bandName != '\0' ? Ieee80211CompliantBands::getBand(bandName) : nullptr);
         int channelNumber = par("channelNumber");
         if (channelNumber != -1)
             setChannelNumber(channelNumber);
     }
 }

◆ printToStream()

std::ostream & inet::physicallayer::Ieee80211ReceiverBase::printToStream	(	std::ostream &	stream,
		int	level,
		int	evFlags = `0`
	)		const

overridevirtual

Prints this object to the provided output stream.

Reimplemented from inet::physicallayer::FlatReceiverBase.

Reimplemented in inet::physicallayer::Ieee80211DimensionalReceiver, and inet::physicallayer::Ieee80211ScalarReceiver.

 {
     if (level <= PRINT_LEVEL_TRACE)
         stream << EV_FIELD(modeSet, printFieldToString(modeSet, level + 1, evFlags))
                << EV_FIELD(band, printFieldToString(band, level + 1, evFlags));
     if (level <= PRINT_LEVEL_INFO)
         stream << EV_FIELD(channel, printFieldToString(channel, level + 1, evFlags));
     return FlatReceiverBase::printToStream(stream, level);
 }

Referenced by inet::physicallayer::Ieee80211DimensionalReceiver::printToStream(), and inet::physicallayer::Ieee80211ScalarReceiver::printToStream().

◆ setBand()

void inet::physicallayer::Ieee80211ReceiverBase::setBand ( const IIeee80211Band * band )

virtual

 {
     if (this->band != band) {
         this->band = band;
         if (channel != nullptr)
             setChannel(new Ieee80211Channel(band, channel->getChannelNumber()));
     }
 }

Referenced by initialize(), and inet::physicallayer::Ieee80211Radio::setBand().

◆ setChannel()

void inet::physicallayer::Ieee80211ReceiverBase::setChannel ( const Ieee80211Channel * channel )

virtual

 {
     if (this->channel != channel) {
         delete this->channel;
         this->channel = channel;
         setCenterFrequency(channel->getCenterFrequency());
     }
 }

Referenced by computeReceptionResult(), setBand(), inet::physicallayer::Ieee80211Radio::setChannel(), and setChannelNumber().

◆ setChannelNumber()

void inet::physicallayer::Ieee80211ReceiverBase::setChannelNumber ( int channelNumber )

virtual

 {
     if (channel == nullptr || channelNumber != channel->getChannelNumber())
         setChannel(new Ieee80211Channel(band, channelNumber));
 }

Referenced by initialize(), and inet::physicallayer::Ieee80211Radio::setChannelNumber().

◆ setModeSet()

void inet::physicallayer::Ieee80211ReceiverBase::setModeSet ( const Ieee80211ModeSet * modeSet )

virtual

 {
     this->modeSet = modeSet;
 }

Referenced by initialize(), and inet::physicallayer::Ieee80211Radio::setModeSet().

Member Data Documentation

◆ band

const IIeee80211Band* inet::physicallayer::Ieee80211ReceiverBase::band

protected

Referenced by printToStream(), setBand(), and setChannelNumber().

◆ channel

const Ieee80211Channel* inet::physicallayer::Ieee80211ReceiverBase::channel

protected

Referenced by printToStream(), setBand(), setChannel(), setChannelNumber(), and ~Ieee80211ReceiverBase().

◆ modeSet

const Ieee80211ModeSet* inet::physicallayer::Ieee80211ReceiverBase::modeSet

protected

Referenced by inet::physicallayer::Ieee80211DimensionalReceiver::computeIsReceptionPossible(), inet::physicallayer::Ieee80211ScalarReceiver::computeIsReceptionPossible(), printToStream(), and setModeSet().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Ieee80211ReceiverBase()

◆ ~Ieee80211ReceiverBase()

Member Function Documentation

◆ computeReceptionResult()

◆ initialize()

◆ printToStream()

◆ setBand()

◆ setChannel()

◆ setChannelNumber()

◆ setModeSet()

Member Data Documentation

◆ band

◆ channel

◆ modeSet