inet::physicallayer::FlatReceiverBase Class Reference

#include <FlatReceiverBase.h>

Inheritance diagram for inet::physicallayer::FlatReceiverBase:

Public Member Functions
	FlatReceiverBase ()
virtual std::ostream &	printToStream (std::ostream &stream, int level) const override
	Prints this object to the provided output stream. More...
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	getCarrierFrequency () const
virtual void	setCarrierFrequency (Hz carrierFrequency)
virtual Hz	getBandwidth () const
virtual void	setBandwidth (Hz bandwidth)
Public Member Functions inherited from inet::physicallayer::SNIRReceiverBase
	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...
virtual const IReceptionResult *	computeReceptionResult (const IListening *listening, const IReception *reception, const IInterference *interference, const ISNIR *snir) const override
	Returns the complete result of the reception process for the provided reception. More...
virtual ReceptionIndication *	createReceptionIndication () const
	Returns an empty reception indication (control info). More...
Public Member Functions inherited from inet::physicallayer::IPrintableObject
virtual	~IPrintableObject ()
virtual std::string	getInfoStringRepresentation () const
virtual std::string	getDetailStringRepresentation () const
virtual std::string	getDebugStringRepresentation () const
virtual std::string	getTraceStringRepresentation () const
virtual std::string	getCompleteStringRepresentation () const

Protected Member Functions
virtual void	initialize (int stage) override
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 const ReceptionIndication *	computeReceptionIndication (const ISNIR *snir) const override
	Returns the physical properties of the reception including noise and signal related measures, error probabilities, actual error counts, etc. More...
Protected Member Functions inherited from inet::physicallayer::ReceiverBase
virtual int	numInitStages () const override

Protected Attributes
const IErrorModel *	errorModel
W	energyDetection
W	sensitivity
Protected Attributes inherited from inet::physicallayer::NarrowbandReceiverBase
const IModulation *	modulation
Hz	carrierFrequency
Hz	bandwidth
Protected Attributes inherited from inet::physicallayer::SNIRReceiverBase
double	snirThreshold

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

Constructor & Destructor Documentation

inet::physicallayer::FlatReceiverBase::FlatReceiverBase

(

)

                                   :
    NarrowbandReceiverBase(),
    errorModel(nullptr),
    energyDetection(W(NaN)),
    sensitivity(W(NaN))
{
}

Member Function Documentation

bool inet::physicallayer::FlatReceiverBase::computeIsReceptionPossible ( const IListening *  listening, const IReception *  reception, IRadioSignal::SignalPart  part  ) const

overrideprotectedvirtual

Returns whether the reception of the provided part is possible or not.

For example, it might check if the reception power is above sensitivity.

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::NarrowbandReceiverBase.

{
    if (!NarrowbandReceiverBase::computeIsReceptionPossible(listening, reception, part))
        return false;
    else {
        const FlatReceptionBase *flatReception = check_and_cast<const FlatReceptionBase *>(reception);
        W minReceptionPower = flatReception->computeMinPower(reception->getStartTime(part), reception->getEndTime(part));
        bool isReceptionPossible = minReceptionPower >= sensitivity;
        EV_DEBUG << "Computing whether reception is possible: minimum reception power = " << minReceptionPower << ", sensitivity = " << sensitivity << " -> reception is " << (isReceptionPossible ? "possible" : "impossible") << endl;
        return isReceptionPossible;
    }
}

bool inet::physicallayer::FlatReceiverBase::computeIsReceptionSuccessful ( const IListening *  listening, const IReception *  reception, IRadioSignal::SignalPart  part, const IInterference *  interference, const ISNIR *  snir  ) const

overrideprotectedvirtual

Returns whether the reception of the provided part is actually successful or failed by the receiver.

For example, it might compute the error rate and draw a random number to make the decision.

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::SNIRReceiverBase.

{
    if (!SNIRReceiverBase::computeIsReceptionSuccessful(listening, reception, part, interference, snir))
        return false;
    else if (!errorModel)
        return true;
    else {
        double packetErrorRate = errorModel->computePacketErrorRate(snir, part);
        if (packetErrorRate == 0.0)
            return true;
        else if (packetErrorRate == 1.0)
            return false;
        else
            return dblrand() > packetErrorRate;
    }
}

const IListeningDecision * inet::physicallayer::FlatReceiverBase::computeListeningDecision ( const IListening *  listening, const IInterference *  interference  ) const

overridevirtual

Returns the result of the listening process specifying the reception state of the receiver.

This function must be purely functional and support optimistic parallel computation.

Implements inet::physicallayer::IReceiver.

{
    const IRadio *receiver = listening->getReceiver();
    const IRadioMedium *radioMedium = receiver->getMedium();
    const IAnalogModel *analogModel = radioMedium->getAnalogModel();
    const INoise *noise = analogModel->computeNoise(listening, interference);
    const NarrowbandNoiseBase *narrowbandNoise = check_and_cast<const NarrowbandNoiseBase *>(noise);
    W maxPower = narrowbandNoise->computeMaxPower(listening->getStartTime(), listening->getEndTime());
    bool isListeningPossible = maxPower >= energyDetection;
    delete noise;
    EV_DEBUG << "Computing whether listening is possible: maximum power = " << maxPower << ", energy detection = " << energyDetection << " -> listening is " << (isListeningPossible ? "possible" : "impossible") << endl;
    return new ListeningDecision(listening, isListeningPossible);
}

const ReceptionIndication * inet::physicallayer::FlatReceiverBase::computeReceptionIndication ( const ISNIR *  snir ) const

overrideprotectedvirtual

Returns the physical properties of the reception including noise and signal related measures, error probabilities, actual error counts, etc.

This function must be purely functional and support optimistic parallel computation.

Reimplemented from inet::physicallayer::SNIRReceiverBase.

Reimplemented in inet::physicallayer::Ieee80211ReceiverBase.

Referenced by inet::physicallayer::Ieee80211ReceiverBase::computeReceptionIndication().

{
    ReceptionIndication *indication = const_cast<ReceptionIndication *>(SNIRReceiverBase::computeReceptionIndication(snir));
    indication->setPacketErrorRate(errorModel ? errorModel->computePacketErrorRate(snir, IRadioSignal::SIGNAL_PART_WHOLE) : 0.0);
    indication->setBitErrorRate(errorModel ? errorModel->computeBitErrorRate(snir, IRadioSignal::SIGNAL_PART_WHOLE) : 0.0);
    indication->setSymbolErrorRate(errorModel ? errorModel->computeSymbolErrorRate(snir, IRadioSignal::SIGNAL_PART_WHOLE) : 0.0);
    return indication;
}

virtual W inet::physicallayer::FlatReceiverBase::getEnergyDetection ( ) const

inlinevirtual

{ return energyDetection; }

virtual const IErrorModel* inet::physicallayer::FlatReceiverBase::getErrorModel ( ) const

inlinevirtual

{ return errorModel; }

virtual W inet::physicallayer::FlatReceiverBase::getMinReceptionPower ( ) const

inlineoverridevirtual

Returns the minimum reception power below which successful reception is definitely not possible.

Returns a value in the range [0, +infinity) or NaN if unspecified.

Reimplemented from inet::physicallayer::ReceiverBase.

{ return sensitivity; }

virtual W inet::physicallayer::FlatReceiverBase::getSensitivity ( ) const

inlinevirtual

{ return sensitivity; }

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

overrideprotectedvirtual

Reimplemented from inet::physicallayer::NarrowbandReceiverBase.

Reimplemented in inet::physicallayer::Ieee80211ReceiverBase, and inet::physicallayer::Ieee802154NarrowbandScalarReceiver.

Referenced by inet::physicallayer::Ieee802154NarrowbandScalarReceiver::initialize(), and inet::physicallayer::Ieee80211ReceiverBase::initialize().

{
    NarrowbandReceiverBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        errorModel = dynamic_cast<IErrorModel *>(getSubmodule("errorModel"));
        energyDetection = mW(math::dBm2mW(par("energyDetection")));
        sensitivity = mW(math::dBm2mW(par("sensitivity")));
    }
}

std::ostream & inet::physicallayer::FlatReceiverBase::printToStream ( std::ostream &  stream, int  level  ) const

overridevirtual

Prints this object to the provided output stream.

Function calls to operator<< with pointers or references either const or not are all forwarded to this function.

Reimplemented from inet::physicallayer::NarrowbandReceiverBase.

Reimplemented in inet::physicallayer::Ieee80211ReceiverBase, inet::physicallayer::Ieee802154NarrowbandScalarReceiver, inet::physicallayer::Ieee80211DimensionalReceiver, inet::physicallayer::Ieee80211ScalarReceiver, inet::physicallayer::APSKDimensionalReceiver, and inet::physicallayer::APSKScalarReceiver.

Referenced by inet::physicallayer::APSKDimensionalReceiver::printToStream(), inet::physicallayer::APSKScalarReceiver::printToStream(), inet::physicallayer::Ieee802154NarrowbandScalarReceiver::printToStream(), and inet::physicallayer::Ieee80211ReceiverBase::printToStream().

{
    if (level <= PRINT_LEVEL_TRACE)
        stream << ", errorModel = " << printObjectToString(errorModel, level + 1);
    if (level <= PRINT_LEVEL_INFO)
        stream << ", energyDetection = " << energyDetection
               << ", sensitivity = " << sensitivity;
    return NarrowbandReceiverBase::printToStream(stream, level);
}

virtual void inet::physicallayer::FlatReceiverBase::setEnergyDetection ( W  energyDetection )

inlinevirtual

{ this->energyDetection = energyDetection; }

virtual void inet::physicallayer::FlatReceiverBase::setSensitivity ( W  sensitivity )

inlinevirtual

{ this->sensitivity = sensitivity; }

Member Data Documentation

W inet::physicallayer::FlatReceiverBase::energyDetection

protected

Referenced by computeListeningDecision(), initialize(), and printToStream().

const IErrorModel* inet::physicallayer::FlatReceiverBase::errorModel

protected

Referenced by computeIsReceptionSuccessful(), computeReceptionIndication(), initialize(), and printToStream().

W inet::physicallayer::FlatReceiverBase::sensitivity

protected

Referenced by computeIsReceptionPossible(), initialize(), and printToStream().

---

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

• FlatReceiverBase.h
• FlatReceiverBase.cc