User Manual, Developers Guide and API Documentation

transmissionobject.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 _TRANSMISSIONOBJECT_HPP
#define _TRANSMISSIONOBJECT_HPP

#include <WNS/service/phy/phymode/PhyModeInterface.hpp>

#include <WNS/PowerRatio.hpp>
#include <WNS/container/FastListEnabler.hpp>
#include <WNS/SmartPtr.hpp>
#include <WNS/Assure.hpp>
#include <WNS/Position.hpp>
#include <WNS/osi/PDU.hpp>
#include <WNS/Birthmark.hpp>


namespace rise
{
    namespace receiver {
        class ReceiverInterface;
    }

    class Transmitter;

    class TransmitterAspect
    {
    public:
        TransmitterAspect() :
            txPower(),
            numberOfSpatialStreams(1)
            {}

        virtual ~TransmitterAspect()
            {}


        virtual wns::Ratio
        getTransmittersAntennaGain(const wns::Position& receiverPosition) const = 0;

        virtual Transmitter*
        getTransmitter() const = 0;

        const wns::Power&
        getTxPower() const
            {
                return this->txPower;
            }

        void
        setTxPower(wns::Power power)
            {
                this->txPower=power;
            }

        const wns::service::phy::phymode::PhyModeInterface&
        getPhyMode() const
            {
                return *(this->phyModePtr); // returns reference only
            }

        const wns::service::phy::phymode::PhyModeInterfacePtr
        getPhyModePtr() const
            {
                return this->phyModePtr;
            }

        void
        setPhyModePtr(const wns::service::phy::phymode::PhyModeInterfacePtr _phyModePtr)
            {
                this->phyModePtr=_phyModePtr; // SmartPtr
            }

        const int
        getNumberOfSpatialStreams() const
            {
                return this->numberOfSpatialStreams;
            }

        void
        setNumberOfSpatialStreams(int _numSS)
            {
                assure(_numSS > 0,
                       "Cannot have negative number of spatial streams");
                this->numberOfSpatialStreams = _numSS;
            }

    private:
        wns::Power txPower;
        wns::service::phy::phymode::PhyModeInterfacePtr phyModePtr;

        int numberOfSpatialStreams;
    };

    class CastingAspect
    {
    public:
        virtual bool isForMe(const receiver::ReceiverInterface* aReceiver) const = 0;
        virtual ~CastingAspect() {}
    };


    namespace medium {
        class PhysicalResource;
    }

    class TransmissionInterface :
        virtual public wns::RefCountable,
        virtual public wns::HasBirthmark,
        virtual public TransmitterAspect,
        virtual public CastingAspect
    {
        friend class medium::PhysicalResource;
    public:
        TransmissionInterface();

        virtual ~TransmissionInterface();

        bool getIsStart() const
            {
                return this->onAir;
            }

        void setIsStart(bool iS)
            {
                this->onAir = iS;
            }

        medium::PhysicalResource* getPhysicalResource() const
            {
                assure(this->pr != NULL, "Hasn't been set (set by PhysicalResource::startTransmission())");
                return this->pr;
            }

    private:
        bool onAir;

        medium::PhysicalResource* pr;

        void setPhysicalResource(medium::PhysicalResource* _pr)
            {
                assure(pr == NULL, "The TransmissionObject may only be transmitted on ONE physical resource");
                this->pr = _pr;
            }
    };

    class TransmissionObject :
        virtual public TransmissionInterface,
        virtual public wns::container::SingleFastListEnabler<wns::SmartPtr<TransmissionObject> >

    {
    public:
        TransmissionObject(Transmitter* _transmitter,
                           const wns::Power& _txPower,
                           unsigned long int _linkMode = 0,
                           int numberOfSpatialStreams = 1);

        TransmissionObject(Transmitter* _transmitter,
                           wns::osi::PDUPtr _payload,
                           const wns::Power& _txPower,
                           unsigned long int _linkMode = 0,
                           int numberOfSpatialStreams = 1);

        TransmissionObject(Transmitter* _transmitter,
                           const wns::Power& _txPower,
                           const wns::service::phy::phymode::PhyModeInterfacePtr _phyModePtr,
                           unsigned long int _linkMode = 0);

        TransmissionObject(Transmitter* _transmitter,
                           wns::osi::PDUPtr _payload,
                           const wns::Power& _txPower,
                           const wns::service::phy::phymode::PhyModeInterfacePtr _phyModePtr,
                           unsigned long int _linkMode = 0);

        virtual ~TransmissionObject();

        unsigned long int getLinkMode() const
            {
                return this->linkMode;
            }

        wns::osi::PDUPtr getPayload() const
            {
                return this->payload;
            }

        virtual Transmitter* getTransmitter() const
            {
                return this->transmitter;
            }

        std::string toString() const;

        enum linkmode
        {
            downlink   = 0,
            uplink,
            directlink
        };
        virtual wns::Ratio getTransmittersAntennaGain(const wns::Position& receiverPosition) const;

    private:
        Transmitter* transmitter;

        wns::osi::PDUPtr payload;

        unsigned long int linkMode;
    };
}

#endif // _TRANSMISSIONOBJECT_HPP

---