INET Framework for OMNeT++/OMNEST
inet::physicallayer::MpskModulation Class Reference

This modulation implements parameterized phase-shift keying that arranges symbols evenly on a circle. More...

#include <MpskModulation.h>

Inheritance diagram for inet::physicallayer::MpskModulation:
inet::physicallayer::ApskModulationBase inet::physicallayer::IApskModulation inet::physicallayer::IModulation inet::IPrintableObject

Public Member Functions

 MpskModulation (unsigned int codeWordSize)
 
virtual ~MpskModulation ()
 
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 calculateBER (double snir, Hz bandwidth, bps bitrate) const override
 Returns the bit error rate as a function of the signal to noise and interference ratio, the bandwidth, and the gross (physical) bitrate. More...
 
virtual double calculateSER (double snir, Hz bandwidth, bps bitrate) const override
 Returns the symbol error rate as a function of the signal to noise and interference ratio, the bandwidth, and the gross (physical) bitrate. More...
 
- Public Member Functions inherited from inet::physicallayer::ApskModulationBase
 ApskModulationBase (const std::vector< ApskSymbol > *constellation)
 
virtual const std::vector< ApskSymbol > * getConstellation () const
 
virtual unsigned int getConstellationSize () const override
 
virtual unsigned int getCodeWordSize () const override
 
virtual const ApskSymbolmapToConstellationDiagram (const ShortBitVector &symbol) const
 
virtual ShortBitVector demapToBitRepresentation (const ApskSymbol *symbol) const
 
- 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
 

Additional Inherited Members

- 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) }
 
- Static Public Member Functions inherited from inet::physicallayer::ApskModulationBase
const static ApskModulationBasefindModulation (const char *name)
 
- Protected Attributes inherited from inet::physicallayer::ApskModulationBase
const std::vector< ApskSymbol > * constellation
 
const unsigned int codeWordSize
 
const unsigned int constellationSize
 

Detailed Description

This modulation implements parameterized phase-shift keying that arranges symbols evenly on a circle.

http://en.wikipedia.org/wiki/Phase-shift_keying#Higher-order_PSK

Constructor & Destructor Documentation

◆ MpskModulation()

inet::physicallayer::MpskModulation::MpskModulation ( unsigned int  codeWordSize)
26  : ApskModulationBase(createConstellation(codeWordSize))
27 {
28 }

◆ ~MpskModulation()

inet::physicallayer::MpskModulation::~MpskModulation ( )
virtual
31 {
32  delete constellation;
33 }

Member Function Documentation

◆ calculateBER()

double inet::physicallayer::MpskModulation::calculateBER ( double  snir,
Hz  bandwidth,
bps  bitrate 
) const
overridevirtual

Returns the bit error rate as a function of the signal to noise and interference ratio, the bandwidth, and the gross (physical) bitrate.

Implements inet::physicallayer::IModulation.

42 {
43  // http://www.dsplog.com/2008/05/18/bit-error-rate-for-16psk-modulation-using-gray-mapping/
44  double ber = erfc(sqrt(snir) * sin(M_PI / constellationSize)) / codeWordSize;
45  ASSERT(0.0 <= ber && ber <= 1.0);
46  return ber;
47 }

◆ calculateSER()

double inet::physicallayer::MpskModulation::calculateSER ( double  snir,
Hz  bandwidth,
bps  bitrate 
) const
overridevirtual

Returns the symbol error rate as a function of the signal to noise and interference ratio, the bandwidth, and the gross (physical) bitrate.

Implements inet::physicallayer::IModulation.

50 {
51  // http://www.dsplog.com/2008/03/18/symbol-error-rate-for-16psk/
52  double ser = erfc(sqrt(snir) * sin(M_PI / constellationSize));
53  ASSERT(0.0 <= ser && ser <= 1.0);
54  return ser;
55 }

◆ printToStream()

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

Prints this object to the provided output stream.

Reimplemented from inet::physicallayer::ApskModulationBase.

36 {
37  stream << "MPSKModulaiton";
38  return ApskModulationBase::printToStream(stream, level);
39 }

The documentation for this class was generated from the following files:
inet::physicallayer::ApskModulationBase::ApskModulationBase
ApskModulationBase(const std::vector< ApskSymbol > *constellation)
Definition: ApskModulationBase.cc:23
inet::units::sqrt
value< Value, pow< Unit, 1, 2 > > sqrt(const value< Value, Unit > &a)
Definition: Units.h:272
inet::physicallayer::ApskModulationBase::constellationSize
const unsigned int constellationSize
Definition: ApskModulationBase.h:27
inet::physicallayer::ApskModulationBase::printToStream
virtual std::ostream & printToStream(std::ostream &stream, int level, int evFlags=0) const override
Prints this object to the provided output stream.
Definition: ApskModulationBase.cc:30
inet::physicallayer::ApskModulationBase::codeWordSize
const unsigned int codeWordSize
Definition: ApskModulationBase.h:26
inet::physicallayer::ApskModulationBase::constellation
const std::vector< ApskSymbol > * constellation
Definition: ApskModulationBase.h:25
M_PI
#define M_PI
Definition: INETMath.h:52
inet::units::sin
Value sin(const value< Value, Unit > &angle)
Definition: Units.h:1518