User Manual, Developers Guide and API Documentation

PhyModeInterface.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 WNS_SERVICE_PHY_PHYMODE_PHYMODEINTERFACE_HPP
#define WNS_SERVICE_PHY_PHYMODE_PHYMODEINTERFACE_HPP

#include <WNS/pyconfig/View.hpp>
#include <WNS/StaticFactory.hpp>
#include <WNS/IOutputStreamable.hpp>
#include <WNS/PyConfigViewCreator.hpp>
#include <WNS/RefCountable.hpp>
#include <WNS/Cloneable.hpp>
#include <WNS/SmartPtr.hpp>
#include <WNS/PowerRatio.hpp>
#include <WNS/simulator/Time.hpp>

#include <string>

namespace wns { namespace service { namespace phy { namespace phymode {

        typedef unsigned int Modulation;
        typedef unsigned int Coding;

        class PhyModeInterface :
            public virtual wns::IOutputStreamable,
            public virtual wns::RefCountable,
            public virtual wns::CloneableInterface
        {
        public:
            virtual ~PhyModeInterface() {}

            virtual bool isValid() const = 0;

            virtual bool dataRateIsValid() const = 0;

            friend bool operator== ( const PhyModeInterface& p1, const PhyModeInterface& p2 )
            { return (p1.toInt() == p2.toInt()); }
            friend bool operator!= ( const PhyModeInterface& p1, const PhyModeInterface& p2 )
            { return !(p1==p2); }

            friend bool operator< ( const PhyModeInterface& p1, const PhyModeInterface& p2 )
            { return (p1.toInt() < p2.toInt()); }
            //{ return (this->getBitsPerSymbol() < right.getBitsPerSymbol()); } // other semantic
            friend bool operator> ( const PhyModeInterface& p1, const PhyModeInterface& p2 )
            { return !(p1<p2); }

            friend bool PhyModeIsBetter( const PhyModeInterface& p1, const PhyModeInterface& p2 )
            { return (p1.getBitsPerSymbol()>p2.getBitsPerSymbol()); }

            virtual unsigned int
            getBitCapacityFractional(wns::simulator::Time duration) const = 0;

            virtual double getDataRate() const = 0;

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

            virtual std::string getString() const = 0;

            virtual bool nameMatches(const std::string& name) const = 0;

            virtual Modulation getModulation() const = 0;

            virtual Coding getCoding() const = 0;

            virtual double getBitsPerSymbol() const = 0;

        private:
            virtual unsigned int toInt() const = 0;
        };

        typedef wns::SmartPtr<const wns::service::phy::phymode::PhyModeInterface> PhyModeInterfacePtr;
        typedef const wns::service::phy::phymode::PhyModeInterface& PhyModeInterfaceConstRef;

        typedef wns::PyConfigViewCreator<PhyModeInterface, PhyModeInterface> PhyModeCreator;
        typedef wns::StaticFactory<PhyModeCreator> PhyModeFactory;

        inline PhyModeInterface*
        createPhyModeNonConst(const wns::pyconfig::View& config)
        {
            std::string nameInPhyModeFactory = config.get<std::string>("nameInPhyModeFactory");
            return PhyModeFactory::creator(nameInPhyModeFactory)->create(config);
        }

        inline PhyModeInterfacePtr
        createPhyMode(const wns::pyconfig::View& config)
        {
            std::string nameInPhyModeFactory = config.get<std::string>("nameInPhyModeFactory");
            return PhyModeInterfacePtr(PhyModeFactory::creator(nameInPhyModeFactory)->create(config));
        }

        inline const PhyModeInterface&
        emptyPhyMode()
        {
            typedef wns::Creator<PhyModeInterface> DefaultPhyModeCreator;
            typedef wns::StaticFactory<DefaultPhyModeCreator> DefaultPhyModeFactory;
            // done only once for the whole simulation:
            static const PhyModeInterface* empty = DefaultPhyModeFactory::creator("rise.PhyMode.Empty")->create();
            return *empty;
        }

        inline PhyModeInterfacePtr
        emptyPhyModePtr()
        {
            typedef wns::Creator<PhyModeInterface> DefaultPhyModeCreator;
            typedef wns::StaticFactory<DefaultPhyModeCreator> DefaultPhyModeFactory;
            // done only once for the whole simulation:
            static PhyModeInterface* empty = DefaultPhyModeFactory::creator("rise.PhyMode.Empty")->create();
            static PhyModeInterfacePtr emptyPtr = PhyModeInterfacePtr(empty);
            return emptyPtr;
        }

} // phymode
} // phy
} // service
} // wns

namespace wns {
  // for convenience: wns::PhyModePtr
  typedef wns::service::phy::phymode::PhyModeInterfacePtr PhyModePtr;
}

#endif // WNS_SERVICE_PHY_PHYMODE_PHYMODEINTERFACE_HPP

---