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, int evFlags=0) 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::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 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::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) }

Constructor & Destructor Documentation

ApskEncoder()

inet::physicallayer::ApskEncoder::ApskEncoder

(

)

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

~ApskEncoder()

inet::physicallayer::ApskEncoder::~ApskEncoder ( )

virtual

{
    delete code;
}

Member Function Documentation

encode()

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

overridevirtual

Implements inet::physicallayer::IEncoder.

{
    auto packet = packetModel->getPacket();
    const auto& apskPhyHeader = packet->peekAtFront<ApskPhyHeader>();
    auto length = packet->getTotalLength();
    BitVector *encodedBits;
    if (b(length).get() % 8 == 0)
        encodedBits = new BitVector(packet->peekAllAsBytes()->getBytes());
    else {
        encodedBits = new BitVector();
        const auto& bitsChunk = packet->peekAllAsBits();
        for (int i = 0; i < b(length).get(); i++)
            encodedBits->appendBit(bitsChunk->getBit(i));
    }
    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;
    }
    b netHeaderLength = apskPhyHeader->getChunkLength();
    if (forwardErrorCorrection == nullptr)
        return new TransmissionBitModel(netHeaderLength, packetModel->getBitrate(), length - netHeaderLength, packetModel->getBitrate(), encodedBits, forwardErrorCorrection, scrambling, interleaving);
    else {
        b grossHeaderLength = b(forwardErrorCorrection->getEncodedLength(b(netHeaderLength).get()));
        bps grossBitrate = packetModel->getBitrate() / forwardErrorCorrection->getCodeRate();
        return new TransmissionBitModel(grossHeaderLength, grossBitrate, length - grossHeaderLength, grossBitrate, encodedBits, forwardErrorCorrection, scrambling, interleaving);
    }
}

getCode()

virtual const ApskCode* inet::physicallayer::ApskEncoder::getCode ( ) const

inlineoverridevirtual

Implements inet::physicallayer::IEncoder.

{ return code; }

Referenced by inet::physicallayer::ApskLayeredTransmitter::createBitModel().

initialize()

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

numInitStages()

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

printToStream()

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

overridevirtual

Prints this object to the provided output stream.

Reimplemented from inet::IPrintableObject.

{
    stream << "ApskEncoder";
    if (level <= PRINT_LEVEL_DETAIL)
        stream << EV_FIELD(code, printFieldToString(code, level + 1, evFlags));
    if (level <= PRINT_LEVEL_TRACE)
        stream << EV_FIELD(scrambler, printFieldToString(scrambler, level + 1, evFlags))
               << EV_FIELD(fecEncoder, printFieldToString(fecEncoder, level + 1, evFlags))
               << EV_FIELD(interleaver, printFieldToString(interleaver, level + 1, evFlags));
    return stream;
}

Member Data Documentation

code

const ApskCode* inet::physicallayer::ApskEncoder::code

protected

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

fecEncoder

const IFecCoder* inet::physicallayer::ApskEncoder::fecEncoder

protected

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

interleaver

const IInterleaver* inet::physicallayer::ApskEncoder::interleaver

protected

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

scrambler

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