User Manual, Developers Guide and API Documentation

receiver.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 __RECEIVER_HPP
#define __RECEIVER_HPP

#include <RISE/misc/pointer.hpp>
#include <RISE/misc/RISELogger.hpp>
#include <RISE/receiver/ReceiverInterface.hpp>

#include <WNS/PowerRatio.hpp>
#include <WNS/DoubleDispatcher.hpp>
#include <WNS/TypeInfo.hpp>
#include <WNS/TimeWeightedAverage.hpp>
#include <WNS/Cache.hpp>
#include <WNS/logger/Logger.hpp>
#include <WNS/pyconfig/View.hpp>

#include <sstream>
#include <list>

namespace rise { namespace antenna {
    class Antenna;
}}

namespace rise { namespace medium {
    class PhysicalResource;
}}

namespace rise
{
    class Transmitter;
    class Station;
    class Demodulator;
    class Decoder;
    class PropagationCache;
    class PropCacheEntry;

    class ReceiverBase :
        virtual public receiver::ReceiverInterface
    {
        friend class PropagationCache;
    public:
        ReceiverBase(Station* s,
                     Demodulator *demodulator,
                     Decoder *decoder,
                     wns::Ratio rnf);

        virtual ~ReceiverBase();


        virtual void startReceiving();


        virtual void stopReceiving();

        //  Receiver is listening to.
        virtual wns::Power getTotalRxPower();


        virtual wns::Power getInterference(const TransmissionObjectPtr& t);

        virtual wns::Power getRxPower(const TransmissionObjectPtr& t);

        wns::Power getNoise();

        virtual void tune(double f, double b, long int numberOfSubCarriers);


        virtual void mobilityUpdate(Transmitter* transmitter);


        virtual bool contains(TransmissionObjectPtr);

        bool isActive() const
        {
            return active;
        }


        virtual void positionChanged();

        virtual void positionWillChange();

        virtual antenna::Antenna* getAntenna() const = 0;
    protected:


        virtual void writeCacheEntry(PropCacheEntry& cacheEntry,
                                     Transmitter* t,
                                     double freq);

        wns::Ratio CIR;

        unsigned long int receiverId;

        static unsigned long int nextid;

        Demodulator *demodulator;

        Decoder *decoder;

        wns::Cache<wns::Power> totalRxPower;

        std::list<TransmissionObjectPtr> transmissionObjects;

        PropagationCache* propCache;

        wns::Ratio receiverNoiseFigure;
        bool pd_debugFlag;

        typedef std::vector<medium::PhysicalResource*> PhysicalResourceContainer;
        typedef PhysicalResourceContainer::iterator PhysicalResourceIterator;

        PhysicalResourceContainer prc;

        bool active;

        double midFrequency;
        RISELogger log;
        // TODO: ^ replace by this:
        //wns::logger::Logger logger;

    private:

        void configureLogger();
        void initiatePropCache();
    };

    class Receiver : public ReceiverBase
    {
    public:
        Receiver(Station* s,
                 antenna::Antenna* a,
                 Demodulator *demodulator,
                 Decoder *decoder,
                 wns::Ratio rnf);
        virtual ~Receiver();
        virtual antenna::Antenna* getAntenna() const
            {
                return antenna;
            }
        virtual wns::Ratio getLoss( Transmitter* t);

    protected:
        antenna::Antenna* antenna;
    private:
        Receiver(const Receiver&);
        ReceiverBase& operator=(const ReceiverBase&);

    };

}
#endif

---