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

#include <StochasticErrorModel.h>

Inheritance diagram for inet::physicallayer::StochasticErrorModel:

Public Member Functions
	StochasticErrorModel ()

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

virtual double	computePacketErrorRate (const ISnir *snir, IRadioSignal::SignalPart part) const override
	Returns the packet error rate based on SNIR, modulation, FEC encoding and any other physical layer characteristics. More...

virtual double	computeBitErrorRate (const ISnir *snir, IRadioSignal::SignalPart part) const override
	Returns the bit error rate based on SNIR, modulation, FEC encoding and any other physical layer characteristics. More...

virtual double	computeSymbolErrorRate (const ISnir *snir, IRadioSignal::SignalPart part) const override
	Returns the symbol error rate based on SNIR, modulation, and any other physical layer characteristics. 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::ErrorModelBase
virtual double	getScalarSnir (const ISnir *snir) const

virtual bool	hasProbabilisticError (b length, double ber) const

virtual Packet *	corruptBits (const Packet *packet, double ber, bool &isCorrupted) const

virtual Packet *	corruptBytes (const Packet *packet, double ber, bool &isCorrupted) const

virtual Packet *	corruptChunks (const Packet *packet, double ber, bool &isCorrupted) const

virtual Packet *	corruptPacket (const Packet *packet, bool &isCorrupted) const

virtual Packet *	computeCorruptedPacket (const Packet *packet, double ber) const

virtual Packet *	computeCorruptedPacket (const ISnir *snir) const override

Protected Attributes
double	packetErrorRate

double	bitErrorRate

double	symbolErrorRate

Protected Attributes inherited from inet::physicallayer::ErrorModelBase
CorruptionMode	corruptionMode = CorruptionMode::CM_UNDEFINED

SnirMode	snirMode = SnirMode::SM_UNDEFINED

double	snirOffset = NaN

Additional Inherited Members
Public Types inherited from inet::physicallayer::ErrorModelBase
enum	CorruptionMode { CorruptionMode::CM_UNDEFINED = -1, CorruptionMode::CM_PACKET, CorruptionMode::CM_CHUNK, CorruptionMode::CM_BYTE, CorruptionMode::CM_BIT }

enum	SnirMode { SnirMode::SM_UNDEFINED = -1, SnirMode::SM_MIN, SnirMode::SM_MEAN }

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

Detailed Description

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

Constructor & Destructor Documentation

◆ StochasticErrorModel()

inet::physicallayer::StochasticErrorModel::StochasticErrorModel ( )

                                            :
     packetErrorRate(NaN),
     bitErrorRate(NaN),
     symbolErrorRate(NaN)
 {
 }

Member Function Documentation

◆ computeBitErrorRate()

double inet::physicallayer::StochasticErrorModel::computeBitErrorRate	(	const ISnir *	snir,
		IRadioSignal::SignalPart	part
	)		const

overridevirtual

Returns the bit error rate based on SNIR, modulation, FEC encoding and any other physical layer characteristics.

Implements inet::physicallayer::IErrorModel.

 {
     Enter_Method("computeBitErrorRate");
     if (!std::isnan(bitErrorRate)) {
         return bitErrorRate;
     }
     else {
         // TODO compute bit error rate based on symbol error rate and modulation
 //        const IReception *reception = snir->getReception();
 //        const NarrowbandTransmissionBase *narrowbandTransmission = check_and_cast<const NarrowbandTransmissionBase *>(reception->getTransmission());
 //        const IModulation *modulation = narrowbandTransmission->getModulation();
 //        double symbolErrorRate = computeSymbolErrorRate(snir);
         throw cRuntimeError("Not yet implemented");
     }
 }

Referenced by computePacketErrorRate().

◆ computePacketErrorRate()

double inet::physicallayer::StochasticErrorModel::computePacketErrorRate	(	const ISnir *	snir,
		IRadioSignal::SignalPart	part
	)		const

overridevirtual

Returns the packet error rate based on SNIR, modulation, FEC encoding and any other physical layer characteristics.

Implements inet::physicallayer::IErrorModel.

 {
     Enter_Method("computePacketErrorRate");
     const IReception *reception = snir->getReception();
     if (!std::isnan(packetErrorRate)) {
         double factor = reception->getDuration(part) / reception->getDuration();
         return pow(packetErrorRate, factor);
     }
     else {
         const FlatTransmissionBase *flatTransmission = check_and_cast<const FlatTransmissionBase *>(reception->getTransmission());
         double bitErrorRate = computeBitErrorRate(snir, part);
         double headerSuccessRate = pow(1.0 - bitErrorRate, b(flatTransmission->getHeaderLength()).get());
         double dataSuccessRate = pow(1.0 - bitErrorRate, b(flatTransmission->getDataLength()).get());
         switch (part) {
             case IRadioSignal::SIGNAL_PART_WHOLE:
                 return 1.0 - headerSuccessRate * dataSuccessRate;
             case IRadioSignal::SIGNAL_PART_PREAMBLE:
                 return 0;
             case IRadioSignal::SIGNAL_PART_HEADER:
                 return 1.0 - headerSuccessRate;
             case IRadioSignal::SIGNAL_PART_DATA:
                 return 1.0 - dataSuccessRate;
             default:
                 throw cRuntimeError("Unknown signal part: '%s'", IRadioSignal::getSignalPartName(part));
         }
     }
 }

◆ computeSymbolErrorRate()

double inet::physicallayer::StochasticErrorModel::computeSymbolErrorRate	(	const ISnir *	snir,
		IRadioSignal::SignalPart	part
	)		const

overridevirtual

Returns the symbol error rate based on SNIR, modulation, and any other physical layer characteristics.

Implements inet::physicallayer::IErrorModel.

 {
     Enter_Method("computeSymbolErrorRate");
     return symbolErrorRate;
 }

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::physicallayer::ErrorModelBase.

 {
     if (stage == INITSTAGE_LOCAL) {
         packetErrorRate = par("packetErrorRate");
         bitErrorRate = par("bitErrorRate");
         symbolErrorRate = par("symbolErrorRate");
     }
 }

◆ printToStream()

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

overridevirtual

Prints this object to the provided output stream.

Reimplemented from inet::IPrintableObject.

 {
     if (level <= PRINT_LEVEL_TRACE)
         stream << "StochasticErrorModel"
                << "packetErrorRate = " << packetErrorRate
                << "bitErrorRate = " << bitErrorRate
                << "symbolErrorRate = " << symbolErrorRate;
     return stream;
 }

Member Data Documentation

◆ bitErrorRate

double inet::physicallayer::StochasticErrorModel::bitErrorRate

protected

Referenced by computeBitErrorRate(), computePacketErrorRate(), initialize(), and printToStream().

◆ packetErrorRate

double inet::physicallayer::StochasticErrorModel::packetErrorRate

protected

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

◆ symbolErrorRate

double inet::physicallayer::StochasticErrorModel::symbolErrorRate

protected

Referenced by computeSymbolErrorRate(), 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

◆ StochasticErrorModel()

Member Function Documentation

◆ computeBitErrorRate()

◆ computePacketErrorRate()

◆ computeSymbolErrorRate()

◆ initialize()

◆ printToStream()

Member Data Documentation

◆ bitErrorRate

◆ packetErrorRate

◆ symbolErrorRate