User Manual, Developers Guide and API Documentation

PhyMode.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 5, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#ifndef RISE_PLMAPPING_PHYMODE_HPP
#define RISE_PLMAPPING_PHYMODE_HPP

#include <string>
#include <WNS/Enum.hpp>
#include <WNS/pyconfig/View.hpp>
#include <WNS/service/phy/phymode/PhyModeInterface.hpp>
#include <WNS/service/phy/phymode/SNR2MIInterface.hpp>
#include <WNS/service/phy/phymode/MI2PERInterface.hpp>
#include <RISE/plmapping/CodeRates.hpp>

namespace rise { namespace plmapping {
namespace tests {
    class PhyModeTest;
    class PhyModeMapperTest;
}

        const unsigned int UNDEFINED_PHYMODE    = 0;
        const unsigned int UNDEFINED_MODULATION = 0;
        const unsigned int MAX_MODULATIONS      = 8;
        const unsigned int MOD_BITS             = 6;
        const unsigned int MOD_MASK             = 63;

        ENUM_BEGIN(Modulations);
        //ENUM(UNDEFINED_MODULATION,  0); // see above
        ENUM(BPSK,  1);
        ENUM(QPSK,  2);
        ENUM(QAM8,  3);
        ENUM(QAM16, 4);
        ENUM(QAM32, 5);
        ENUM(QAM64, 6);
        ENUM(QAM128,7);
        ENUM(QAM256,8);
        ENUM_END();

        typedef wns::service::phy::phymode::Modulation Modulation;

        class PhyMode :
            public wns::service::phy::phymode::PhyModeInterface,
            // ^ this is necessary so that libwns does not depend on rise.
            public wns::Cloneable<PhyMode> // allow SmartPtr
        {
            friend class rise::plmapping::tests::PhyModeTest;
            friend class rise::plmapping::tests::PhyModeMapperTest;
        private:
            wns::service::phy::phymode::SNR2MIInterface* snr2miMapper;
            //wns::service::phy::phymode::CoderMappingInterface* coderMapper;
            wns::service::phy::phymode::CoderFullMappingInterface* coderMapper; // mi2perMapper;
            rise::plmapping::Modulation modulation; // int
            rise::plmapping::Coding coding; // int
            bool subCarriersPerSubChannelKnown;
            unsigned int subCarriersPerSubChannel;
            bool symbolDurationKnown;
            simTimeType symbolDuration; // (symbolLength+cpLength) = 1/symbolRate
            bool dataRateKnown;
            double dataRate;
        public:
            class UndefinedException :
                    public wns::Exception
            {
            public:
                UndefinedException() :
                    wns::Exception("Undefined PhyMode") {};
                    
                ~UndefinedException() throw() {};
            };

            PhyMode();

            explicit
            PhyMode(const wns::pyconfig::View& config);

            PhyMode(Modulation _modulation, rise::plmapping::Coding _coding, wns::service::phy::phymode::SNR2MIInterface* _snr2miMapper, wns::service::phy::phymode::CoderFullMappingInterface* _coderMapper);

            virtual ~PhyMode();

            virtual void setSubCarriersPerSubChannel(unsigned int _subCarriersPerSubChannel);
            virtual void setSymbolDuration(simTimeType _symbolDuration);
            virtual bool isValid() const;
            virtual bool dataRateIsValid() const;

            virtual rise::plmapping::Modulation getModulation() const;

            virtual rise::plmapping::Coding getCoding() const;

            virtual double getCodeRate() const;

            virtual double getBitsPerSymbol() const;

            //virtual unsigned int getBitCapacity(double numberOfOFDMSymbols) const;

            virtual double getDataRate(double _symbolRate, unsigned int _subCarriersPerSubChannel=1) const;
            virtual double getDataRate() const;

            virtual double getSINR2MI(const wns::Ratio& sinr) const;
            virtual double getSINR2MIB(const wns::Ratio& sinr) const;
            virtual double getMI2PER(const double mib, unsigned int bits) const;
            virtual double getSINR2PER(const wns::Ratio& sinr, unsigned int bits) const;
            virtual wns::Ratio getMIB2SINR(const double& mib) const;
            virtual unsigned int
            getBitCapacityFractional(simTimeType duration) const;

            virtual unsigned int
            getBitCapacity(simTimeType duration) const;

            virtual std::string getModulationString() const;
            virtual std::string getCodingString() const;
            virtual std::string getString() const;
            virtual std::string doToString() const { return this->getString(); }
            virtual bool nameMatches(const std::string& name) const;

            static inline const PhyMode& emptyPhyMode() {
                static PhyMode emptyPhyMode = PhyMode();
                return emptyPhyMode;
            }

        private:
            virtual unsigned int toInt() const;

            virtual void calculateDataRate();

            virtual void cloneParameters(const PhyMode& other);

        }; // class definition ends

        inline std::ostream&
        operator<< (std::ostream& s, const PhyMode& p) {
            return s << p.getString();
        }

        typedef wns::SmartPtr<rise::plmapping::PhyMode> PhyModePtr;

}} //namespace rise::plmapping
#endif // RISE_PLMAPPING_PHYMODE_HPP

---