User Manual, Developers Guide and API Documentation

CandI.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 _CANDI_HPP
#define _CANDI_HPP

#include <WNS/PowerRatio.hpp>
#include <WNS/IOutputStreamable.hpp>
#include <cmath>

namespace wns
{
    class CandI
      : public wns::IOutputStreamable
    {
    public:
        // Default constructor
        CandI() :
            C(wns::Power::from_mW(0.0)),
            I(wns::Power::from_mW(0.0)),
            PL(wns::Ratio::from_dB(0.0)),
            IPL(wns::Ratio::from_dB(0.0))
            {
                sdma.iIntra = wns::Power::from_mW(0.0);
            }

        CandI(wns::Power carrier, wns::Power interference) :
            C(carrier),
            I(interference),
            PL(wns::Ratio::from_dB(0.0)),
            IPL(wns::Ratio::from_dB(0.0))
            {
                sdma.iIntra = wns::Power::from_mW(0.0);
            }

        CandI(wns::Power carrier, wns::Power interference, wns::Ratio pathloss) :
            C(carrier),
            I(interference),
            PL(pathloss),
            IPL(wns::Ratio::from_dB(0.0))
            {
                sdma.iIntra = wns::Power::from_mW(0.0);
            }

        CandI(wns::Power carrier, wns::Power interference, wns::Ratio pathloss, wns::Ratio iPathloss) :
            C(carrier),
            I(interference),
            PL(pathloss),
            IPL(iPathloss)
            {
                sdma.iIntra = wns::Power::from_mW(0.0);
            }

        wns::Ratio toSINR() const
        {
            return wns::Ratio(C/I);
        }

        bool isValid() const
        {
            return (C.get_mW()!=0.0 && I.get_mW()!=0.0);
        }

        bool operator <(const CandI& candi) const {
            return ( (C/I) < (candi.C / candi.I) );
        }

        virtual std::string doToString() const
        {
            std::stringstream s;
            if (isValid()) {
              s << toSINR().get_dB() << " dB";
            } else {
              s << "invalid_CandI";
            }
            return s.str();
        }

        friend std::ostream& operator <<(std::ostream &str, const CandI& candi)
        {
            if (candi.isValid()) {
              str << candi.toSINR().get_dB() << " dB";
            } else {
              str << "invalid_CandI";
            }
            return str;
        }

        // Default destructor
        ~CandI(){}

        wns::Power C;
        wns::Power I;
        wns::Ratio PL;
        wns::Ratio IPL;

        struct {
            // estimated intra-cell interference
            wns::Power iIntra;
        } sdma;
    };
}
#endif // _CANDI_HPP

---