inet::physicallayer::ReceiverBase Class Reference

#include <ReceiverBase.h>

Inheritance diagram for inet::physicallayer::ReceiverBase:

Public Member Functions
	ReceiverBase ()
virtual W	getMinInterferencePower () const override
	Returns the minimum interference power below which receptions are to be ignored while computing the interference. More...
virtual W	getMinReceptionPower () const override
	Returns the minimum reception power below which successful reception is definitely not possible. 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 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	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 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 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...
virtual const ReceptionIndication *	computeReceptionIndication (const ISNIR *snir) const override
	Returns the reception indication (control info) that is sent up to the MAC. More...
Public Member Functions inherited from inet::physicallayer::IReceiver
virtual const IListening *	createListening (const IRadio *radio, const simtime_t startTime, const simtime_t endTime, const Coord startPosition, const Coord endPosition) const =0
	Returns a description of how the receiver is listening on the medium. More...
virtual const IListeningDecision *	computeListeningDecision (const IListening *listening, const IInterference *interference) const =0
	Returns the result of the listening process specifying the reception state of the receiver. More...
virtual bool	computeIsReceptionSuccessful (const IListening *listening, const IReception *reception, IRadioSignal::SignalPart part, const IInterference *interference, const ISNIR *snir) const =0
	Returns whether the reception of the provided part is actually successful or failed by the receiver. More...
Public Member Functions inherited from inet::physicallayer::IPrintableObject
virtual	~IPrintableObject ()
virtual std::ostream &	printToStream (std::ostream &stream, int level) const
	Prints this object to the provided output stream. More...
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 int	numInitStages () const override

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::ReceiverBase::ReceiverBase ( )

inline

{ }

Member Function Documentation

bool inet::physicallayer::ReceiverBase::computeIsReceptionAttempted ( const IListening *  listening, const IReception *  reception, IRadioSignal::SignalPart  part, const IInterference *  interference  ) const

overridevirtual

Returns whether the reception of the provided part is actually attempted or ignored by the receiver.

For example, it might check that the radio is not already receiving another signal.

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

Implements inet::physicallayer::IReceiver.

Reimplemented in inet::physicallayer::Ieee802154UWBIRReceiver.

Referenced by computeReceptionDecision().

{
    if (!computeIsReceptionPossible(listening, reception, part))
        return false;
    else if (simTime() == reception->getStartTime(part)) {
        // TODO: isn't there a better way for this optimization? see also in RadioMedium::isReceptionAttempted
        auto transmission = reception->getReceiver()->getReceptionInProgress();
        return transmission == nullptr || transmission == reception->getTransmission();
    }
    else {
        // determining whether the reception is attempted or not for the future
        auto radio = reception->getReceiver();
        auto radioMedium = radio->getMedium();
        auto interferingReceptions = interference->getInterferingReceptions();
        for (auto interferingReception : *interferingReceptions) {
            auto isPrecedingReception = interferingReception->getStartTime() < reception->getStartTime() ||
                (interferingReception->getStartTime() == reception->getStartTime() &&
                 interferingReception->getTransmission()->getId() < reception->getTransmission()->getId());
            if (isPrecedingReception) {
                auto interferingTransmission = interferingReception->getTransmission();
                if (interferingReception->getStartTime() <= simTime()) {
                    if (radio->getReceptionInProgress() == interferingTransmission)
                        return false;
                }
                else if (radioMedium->isReceptionAttempted(radio, interferingTransmission, part))
                    return false;
            }
        }
        return true;
    }
}

bool inet::physicallayer::ReceiverBase::computeIsReceptionPossible ( const IListening *  listening, const ITransmission *  transmission  ) const

overridevirtual

Returns whether the reception of the provided transmission is possible or not independently of the reception conditions.

For example, it might check if the carrier frequency and the modulation of the transmission matches how the receiver is listening on the medium.

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

Implements inet::physicallayer::IReceiver.

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

Referenced by computeIsReceptionAttempted(), and computeReceptionDecision().

{
    return true;
}

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

overridevirtual

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.

Implements inet::physicallayer::IReceiver.

Reimplemented in inet::physicallayer::Ieee80211LayeredOFDMReceiver, inet::physicallayer::APSKLayeredReceiver, inet::physicallayer::NarrowbandReceiverBase, inet::physicallayer::IdealReceiver, and inet::physicallayer::FlatReceiverBase.

{
    return true;
}

const IReceptionDecision * inet::physicallayer::ReceiverBase::computeReceptionDecision ( const IListening *  listening, const IReception *  reception, IRadioSignal::SignalPart  part, const IInterference *  interference, const ISNIR *  snir  ) const

overridevirtual

Returns the reception decision for the transmission part that specifies whether the reception is possible, attempted, and successful.

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

Implements inet::physicallayer::IReceiver.

Reimplemented in inet::physicallayer::Ieee802154UWBIRReceiver, and inet::physicallayer::NarrowbandReceiverBase.

Referenced by inet::physicallayer::NarrowbandReceiverBase::computeReceptionDecision().

{
    auto isReceptionPossible = computeIsReceptionPossible(listening, reception, part);
    auto isReceptionAttempted = isReceptionPossible && computeIsReceptionAttempted(listening, reception, part, interference);
    auto isReceptionSuccessful = isReceptionAttempted && computeIsReceptionSuccessful(listening, reception, part, interference, snir);
    return new ReceptionDecision(reception, part, isReceptionPossible, isReceptionAttempted, isReceptionSuccessful);
}

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

overridevirtual

Returns the reception indication (control info) that is sent up to the MAC.

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

Implements inet::physicallayer::IReceiver.

Reimplemented in inet::physicallayer::Ieee802154UWBIRReceiver, inet::physicallayer::SNIRReceiverBase, inet::physicallayer::FlatReceiverBase, inet::physicallayer::Ieee80211ReceiverBase, inet::physicallayer::IdealReceiver, and inet::physicallayer::Ieee80211IdealReceiver.

Referenced by inet::physicallayer::SNIRReceiverBase::computeReceptionIndication(), and computeReceptionResult().

{
    return createReceptionIndication();
}

const IReceptionResult * inet::physicallayer::ReceiverBase::computeReceptionResult ( const IListening *  listening, const IReception *  reception, const IInterference *  interference, const ISNIR *  snir  ) 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.

Implements inet::physicallayer::IReceiver.

Reimplemented in inet::physicallayer::Ieee80211LayeredOFDMReceiver, and inet::physicallayer::APSKLayeredReceiver.

{
    auto radio = reception->getReceiver();
    auto radioMedium = radio->getMedium();
    auto transmission = reception->getTransmission();
    auto indication = computeReceptionIndication(snir);
    // TODO: add all cached decisions?
    auto decisions = new std::vector<const IReceptionDecision *>();
    decisions->push_back(radioMedium->getReceptionDecision(radio, listening, transmission, IRadioSignal::SIGNAL_PART_WHOLE));
    return new ReceptionResult(reception, decisions, indication);
}

ReceptionIndication * inet::physicallayer::ReceiverBase::createReceptionIndication ( ) const

virtual

Returns an empty reception indication (control info).

This function called from computeReceptionIndication().

Reimplemented in inet::physicallayer::Ieee80211ReceiverBase.

Referenced by computeReceptionIndication().

{
    return new ReceptionIndication();
}

virtual W inet::physicallayer::ReceiverBase::getMinInterferencePower ( ) const

inlineoverridevirtual

Returns the minimum interference power below which receptions are to be ignored while computing the interference.

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

Implements inet::physicallayer::IReceiver.

Reimplemented in inet::physicallayer::Ieee802154NarrowbandScalarReceiver.

{ return W(NaN); }

virtual W inet::physicallayer::ReceiverBase::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.

Implements inet::physicallayer::IReceiver.

Reimplemented in inet::physicallayer::FlatReceiverBase.

{ return W(NaN); }

virtual int inet::physicallayer::ReceiverBase::numInitStages ( ) const

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

---

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

• ReceiverBase.h
• ReceiverBase.cc