#include <NarrowbandReceiverBase.h>

Inheritance diagram for inet::physicallayer::NarrowbandReceiverBase:

Public Member Functions
	NarrowbandReceiverBase ()

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

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 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 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

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

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 W	getMinReceptionPower () const override
	Returns the minimum reception power below which successful reception is definitely not possible. 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::IReceiver
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...

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

Protected Member Functions inherited from inet::physicallayer::SNIRReceiverBase
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 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::NarrowbandReceiverBase::NarrowbandReceiverBase ( )

                                                :
     SNIRReceiverBase(),
     modulation(nullptr),
     carrierFrequency(Hz(NaN)),
     bandwidth(Hz(NaN))
 {
 }

Member Function Documentation

bool inet::physicallayer::NarrowbandReceiverBase::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.

Reimplemented from inet::physicallayer::ReceiverBase.

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

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

 {
     // TODO: check if modulation matches?
     const NarrowbandTransmissionBase *narrowbandTransmission = check_and_cast<const NarrowbandTransmissionBase *>(transmission);
     return carrierFrequency == narrowbandTransmission->getCarrierFrequency() && bandwidth == narrowbandTransmission->getBandwidth();
 }

bool inet::physicallayer::NarrowbandReceiverBase::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.

Reimplemented from inet::physicallayer::ReceiverBase.

Reimplemented in inet::physicallayer::FlatReceiverBase.

 {
     const BandListening *bandListening = check_and_cast<const BandListening *>(listening);
     const NarrowbandReceptionBase *narrowbandReception = check_and_cast<const NarrowbandReceptionBase *>(reception);
     if (bandListening->getCarrierFrequency() != narrowbandReception->getCarrierFrequency() || bandListening->getBandwidth() != narrowbandReception->getBandwidth()) {
         EV_DEBUG << "Computing whether reception is possible: listening and reception bands are different -> reception is impossible" << endl;
         return false;
     }
     else
         return true;
 }

const IReceptionDecision * inet::physicallayer::NarrowbandReceiverBase::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.

Reimplemented from inet::physicallayer::ReceiverBase.

 {
     const BandListening *bandListening = check_and_cast<const BandListening *>(listening);
     const NarrowbandReceptionBase *narrowbandReception = check_and_cast<const NarrowbandReceptionBase *>(reception);
     if (bandListening->getCarrierFrequency() == narrowbandReception->getCarrierFrequency() && bandListening->getBandwidth() == narrowbandReception->getBandwidth())
         return SNIRReceiverBase::computeReceptionDecision(listening, reception, part, interference, snir);
     else
         return new ReceptionDecision(reception, part, false, false, false);
 }

const IListening * inet::physicallayer::NarrowbandReceiverBase::createListening	(	const IRadio *	radio,
		const simtime_t	startTime,
		const simtime_t	endTime,
		const Coord	startPosition,
		const Coord	endPosition
	)		const

overridevirtual

Returns a description of how the receiver is listening on the medium.

Implements inet::physicallayer::IReceiver.

 {
     return new BandListening(radio, startTime, endTime, startPosition, endPosition, carrierFrequency, bandwidth);
 }

virtual Hz inet::physicallayer::NarrowbandReceiverBase::getBandwidth ( ) const

inlinevirtual

57 { return bandwidth; }

inet::physicallayer::NarrowbandReceiverBase::bandwidth

Hz bandwidth

Definition: NarrowbandReceiverBase.h:34

virtual Hz inet::physicallayer::NarrowbandReceiverBase::getCarrierFrequency ( ) const

inlinevirtual

54 { return carrierFrequency; }

inet::physicallayer::NarrowbandReceiverBase::carrierFrequency

Hz carrierFrequency

Definition: NarrowbandReceiverBase.h:33

virtual const IModulation* inet::physicallayer::NarrowbandReceiverBase::getModulation ( ) const

inlinevirtual

51 { return modulation; }

inet::physicallayer::NarrowbandReceiverBase::modulation

const IModulation * modulation

Definition: NarrowbandReceiverBase.h:32

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

overrideprotectedvirtual

Reimplemented from inet::physicallayer::SNIRReceiverBase.

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

Referenced by inet::physicallayer::FlatReceiverBase::initialize().

 {
     SNIRReceiverBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         modulation = APSKModulationBase::findModulation(par("modulation"));
         carrierFrequency = Hz(par("carrierFrequency"));
         bandwidth = Hz(par("bandwidth"));
     }
 }

std::ostream & inet::physicallayer::NarrowbandReceiverBase::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::SNIRReceiverBase.

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

Referenced by inet::physicallayer::FlatReceiverBase::printToStream().

 {
     if (level <= PRINT_LEVEL_TRACE)
         stream << ", modulation = " << printObjectToString(modulation, level + 1)
                << ", carrierFrequency = " << carrierFrequency
                << ", bandwidth = " << bandwidth;
     return SNIRReceiverBase::printToStream(stream, level);
 }