inet::physicallayer::APSKEncoder Class Reference

#include <APSKEncoder.h>

Inheritance diagram for inet::physicallayer::APSKEncoder:

Public Member Functions
	APSKEncoder ()
virtual	~APSKEncoder ()
virtual std::ostream &	printToStream (std::ostream &stream, int level) const override
	Prints this object to the provided output stream. More...
virtual const APSKCode *	getCode () const override
virtual const ITransmissionBitModel *	encode (const ITransmissionPacketModel *packetModel) const override
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 int	numInitStages () const override
virtual void	initialize (int stage) override

Protected Attributes
const APSKCode *	code
const IScrambler *	scrambler
const IFECCoder *	fecEncoder
const IInterleaver *	interleaver

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

(

)

                         :
    code(nullptr),
    scrambler(nullptr),
    fecEncoder(nullptr),
    interleaver(nullptr)
{
}

inet::physicallayer::APSKEncoder::~APSKEncoder ( )

virtual

{
    delete code;
}

Member Function Documentation

const ITransmissionBitModel * inet::physicallayer::APSKEncoder::encode ( const ITransmissionPacketModel *  packetModel ) const

overridevirtual

Implements inet::physicallayer::IEncoder.

{
    const BitVector *serializedBits = packetModel->getSerializedPacket();
    BitVector *encodedBits = new BitVector(*serializedBits);
    const IScrambling *scrambling = nullptr;
    if (scrambler) {
        *encodedBits = scrambler->scramble(*encodedBits);
        scrambling = scrambler->getScrambling();
        EV_DEBUG << "Scrambled bits are: " << *encodedBits << endl;
    }
    const IForwardErrorCorrection *forwardErrorCorrection = nullptr;
    if (fecEncoder) {
        *encodedBits = fecEncoder->encode(*encodedBits);
        forwardErrorCorrection = fecEncoder->getForwardErrorCorrection();
        EV_DEBUG << "FEC encoded bits are: " << *encodedBits << endl;
    }
    const IInterleaving *interleaving = nullptr;
    if (interleaver) {
        *encodedBits = interleaver->interleave(*encodedBits);
        interleaving = interleaver->getInterleaving();
        EV_DEBUG << "Interleaved bits are: " << *encodedBits << endl;
    }
    int netHeaderBitLength = APSK_PHY_FRAME_HEADER_BYTE_LENGTH * 8;
    if (forwardErrorCorrection == nullptr)
        return new TransmissionBitModel(netHeaderBitLength, packetModel->getBitrate(), serializedBits->getSize() - netHeaderBitLength, packetModel->getBitrate(), encodedBits, forwardErrorCorrection, scrambling, interleaving);
    else {
        int grossHeaderBitLength = forwardErrorCorrection->getEncodedLength(netHeaderBitLength);
        bps grossBitrate = packetModel->getBitrate() / forwardErrorCorrection->getCodeRate();
        return new TransmissionBitModel(grossHeaderBitLength, grossBitrate, serializedBits->getSize() - grossHeaderBitLength, grossBitrate, encodedBits, forwardErrorCorrection, scrambling, interleaving);
    }
}

virtual const APSKCode* inet::physicallayer::APSKEncoder::getCode ( ) const

inlineoverridevirtual

Implements inet::physicallayer::IEncoder.

Referenced by inet::physicallayer::APSKLayeredTransmitter::computePaddingLength(), and inet::physicallayer::APSKLayeredTransmitter::createBitModel().

{ return code; }

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

overrideprotectedvirtual

{
    if (stage == INITSTAGE_LOCAL) {
        scrambler = dynamic_cast<IScrambler *>(getSubmodule("scrambler"));
        fecEncoder = dynamic_cast<IFECCoder *>(getSubmodule("fecEncoder"));
        interleaver = dynamic_cast<IInterleaver *>(getSubmodule("interleaver"));
    }
    else if (stage == INITSTAGE_PHYSICAL_LAYER) {
        const IScrambling *scrambling = scrambler != nullptr ? scrambler->getScrambling() : nullptr;
        const ConvolutionalCode *forwardErrorCorrection = fecEncoder != nullptr ? check_and_cast<const ConvolutionalCode *>(fecEncoder->getForwardErrorCorrection()) : nullptr;
        const IInterleaving *interleaving = interleaver != nullptr ? interleaver->getInterleaving() : nullptr;
        code = new APSKCode(forwardErrorCorrection, interleaving, scrambling);
    }
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

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

{
    stream << "APSKEncoder";
    if (level <= PRINT_LEVEL_DETAIL)
        stream << ", code = " << printObjectToString(code, level + 1);
    if (level <= PRINT_LEVEL_TRACE)
        stream << ", scrambler = " << printObjectToString(scrambler, level + 1)
               << ", fecEncoder = " << printObjectToString(fecEncoder, level + 1)
               << ", interleaver = " << printObjectToString(interleaver, level + 1);
    return stream;
}

Member Data Documentation

const APSKCode* inet::physicallayer::APSKEncoder::code

protected

Referenced by initialize(), printToStream(), and ~APSKEncoder().

const IFECCoder* inet::physicallayer::APSKEncoder::fecEncoder

protected

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

const IInterleaver* inet::physicallayer::APSKEncoder::interleaver

protected

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

const IScrambler* inet::physicallayer::APSKEncoder::scrambler

protected

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

---

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

• APSKEncoder.h
• APSKEncoder.cc