Implements the IdealReceiver model, see the NED file for details. More...

#include <IdealReceiver.h>

Inheritance diagram for inet::physicallayer::IdealReceiver:

Public Member Functions
	IdealReceiver ()

virtual std::ostream &	printToStream (std::ostream &stream, int level) const override
	Prints this object to the provided output stream. 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	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 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 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...

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

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 const ReceptionIndication *	computeReceptionIndication (const ISNIR *snir) const override
	Returns the reception indication (control info) that is sent up to the MAC. More...

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

Protected Attributes
bool	ignoreInterference

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 }

Detailed Description

Implements the IdealReceiver model, see the NED file for details.

Constructor & Destructor Documentation

inet::physicallayer::IdealReceiver::IdealReceiver ( )

                              :
     ReceiverBase(),
     ignoreInterference(false)
 {
 }

Member Function Documentation

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

 {
     auto power = check_and_cast<const IdealReception *>(reception)->getPower();
     return power == IdealReception::POWER_RECEIVABLE;
 }

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

overridevirtual

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.

Implements inet::physicallayer::IReceiver.

 {
     auto power = check_and_cast<const IdealReception *>(reception)->getPower();
     if (power == IdealReception::POWER_RECEIVABLE) {
         if (ignoreInterference)
             return true;
         else {
             auto startTime = reception->getStartTime(part);
             auto endTime = reception->getEndTime(part);
             auto interferingReceptions = interference->getInterferingReceptions();
             for (auto interferingReception : *interferingReceptions) {
                 auto interferingPower = check_and_cast<const IdealReception *>(interferingReception)->getPower();
                 if (interferingPower >= IdealReception::POWER_INTERFERING && startTime <= interferingReception->getEndTime() && endTime >= interferingReception->getStartTime())
                     return false;
             }
             return true;
         }
     }
     else
         return false;
 }

const IListeningDecision * inet::physicallayer::IdealReceiver::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.

 {
     auto interferingReceptions = interference->getInterferingReceptions();
     for (auto interferingReception : *interferingReceptions) {
         auto interferingPower = check_and_cast<const IdealReception *>(interferingReception)->getPower();
         if (interferingPower != IdealReception::POWER_UNDETECTABLE)
             return new ListeningDecision(listening, true);
     }
     return new ListeningDecision(listening, false);
 }

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

overrideprotectedvirtual

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.

Reimplemented from inet::physicallayer::ReceiverBase.

Reimplemented in inet::physicallayer::Ieee80211IdealReceiver.

 {
     auto indication = new ReceptionIndication();
     auto reception = check_and_cast<const IdealReception *>(snir->getReception());
     auto noise = check_and_cast_nullable<const IdealNoise *>(snir->getNoise());
     double errorRate = reception->getPower() == IdealReception::POWER_RECEIVABLE && (noise == nullptr || !noise->isInterfering()) ? 0 : 1;
     indication->setSymbolErrorRate(errorRate);
     indication->setBitErrorRate(errorRate);
     indication->setPacketErrorRate(errorRate);
     return indication;
 }

const IListening * inet::physicallayer::IdealReceiver::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 IdealListening(radio, startTime, endTime, startPosition, endPosition);
 }

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

overrideprotectedvirtual

Reimplemented in inet::physicallayer::Ieee80211IdealReceiver.

 {
     ReceiverBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL)
         ignoreInterference = par("ignoreInterference");
 }

std::ostream & inet::physicallayer::IdealReceiver::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::IPrintableObject.

Reimplemented in inet::physicallayer::Ieee80211IdealReceiver.

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

 {
     stream << "IdealReceiver";
     if (level <= PRINT_LEVEL_INFO)
         stream << (ignoreInterference ? ", ignoring interference" : ", considering interference");
     return stream;
 }

Member Data Documentation

bool inet::physicallayer::IdealReceiver::ignoreInterference

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation