User Manual, Developers Guide and API Documentation

ChannelState.hpp

Go to the documentation of this file.

/******************************************************************************
 * WiMeMac                                                                    *
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2011
 * 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 WIMEMAC_CONVERGENCE_CHANNELSTATE_HPP
#define WIMEMAC_CONVERGENCE_CHANNELSTATE_HPP

#include <WIMEMAC/convergence/IChannelState.hpp>
#include <WIMEMAC/convergence/INetworkAllocationVector.hpp>
#include <WIMEMAC/convergence/ITxStartEnd.hpp>
#include <WIMEMAC/convergence/IRxStartEnd.hpp>
#include <WIMEMAC/FrameType.hpp>
#include <WIMEMAC/lowerMAC/Manager.hpp>

#include <WNS/ldk/fu/Plain.hpp>
#include <WNS/ldk/Processor.hpp>
#include <WNS/ldk/Command.hpp>
#include <WNS/logger/Logger.hpp>
#include <WNS/events/CanTimeout.hpp>
#include <WNS/service/phy/ofdma/Notification.hpp>
#include <WNS/service/phy/ofdma/Handler.hpp>
#include <WNS/Observer.hpp>
#include <WNS/Functor.hpp>
#include <WNS/ldk/crc/CRC.hpp>

#include <WNS/events/PeriodicTimeout.hpp>
#include <WNS/ldk/probe/Probe.hpp>
#include <WNS/probe/bus/ContextCollector.hpp>
#include <WNS/SlidingWindow.hpp>

namespace wimemac { namespace lowerMAC {
    class Manager;
}}

namespace wimemac { namespace convergence {

    class ChannelStateCommand :
        public wns::ldk::EmptyCommand
    {
    };

    class ChannelState :
        public wns::ldk::fu::Plain<ChannelState, ChannelStateCommand>,
        public wns::ldk::Processor<ChannelState>,
        public ChannelStateNotification,
        public NAVNotification,
        public wns::service::phy::ofdma::RSSHandler,
        public wns::Observer<wimemac::convergence::ITxStartEnd>,
        public wns::Observer<wimemac::convergence::IRxStartEnd>,
        public wns::events::CanTimeout,
        public wns::ldk::probe::Probe,
        public wns::events::PeriodicTimeout,
        public RxStartEndNotification
    {

    public:
        ChannelState(wns::ldk::fun::FUN* fun, const wns::pyconfig::View& config);
        virtual ~ChannelState();

        void
        setCarrierSensingService(wns::service::Service* cs);

        void
        registerRSSObserver(wns::Observer<wns::service::phy::ofdma::CarrierSensing> *o) {rssObservers.push_back(o);}

    private:
        void
        processIncoming(const wns::ldk::CompoundPtr& compound);
        void
        processOutgoing(const wns::ldk::CompoundPtr& compound);

        virtual void
        onFUNCreated();

        virtual void
        onRSSChange(wns::Power newRSS);

        void onTxStart(const wns::ldk::CompoundPtr& compound);
        void onTxEnd(const wns::ldk::CompoundPtr& compound);

        void onRxStart(const wns::simulator::Time expRxDuration);
        void onRxEnd();
        void onRxError();


        virtual CS getCurrentChannelState() const;

        void onTimeout();

        virtual void checkNewCS();

        void periodically();

//         bool isRTS(const wns::ldk::CompoundPtr& compound) const;

        void probeChannelBusy();
        void probeChannelIdle();

        wns::pyconfig::View config;
        wns::logger::Logger logger;

        std::vector<wns::Observer<wns::service::phy::ofdma::CarrierSensing>*> rssObservers;

        struct ActiveIndicators {
            bool rawEnergyDetection;
            bool phyCarrierSense;
            bool nav;
            bool ownTx;
            bool ownRx;
        } activeIndicators;

        struct Indicators {
            wns::Power rawEnergy;
            wns::Power phyCarrierSense;
            bool ownTx;
            bool ownRx;
        } indicators;

        const wns::Power rawEnergyThreshold;

        const wns::Power phyCarrierSenseThreshold;

        struct Friends
        {
            wimemac::lowerMAC::IManagerServices* manager;
        } friends;

        CS lastCS;

        wns::simulator::Time latestNAV;

        bool waitForReply;

        //wimemac::CompoundType lastCommandOut;

        const std::string managerName;
        const std::string phyUserCommandName;
        const std::string crcCommandName;
        //const std::string rtsctsCommandName;
        const std::string txStartEndName;
        const std::string rxStartEndName;

        const wns::simulator::Time sifsDuration;

        wns::probe::bus::ContextCollectorPtr channelBusyFractionProbe;
        wns::simulator::Time channelBusyFractionMeasurementPeriod;
        wns::simulator::Time channelBusyTime;
        wns::simulator::Time channelBusySlotStart;
        wns::simulator::Time channelBusyLastChangeToBusy;

        wns::service::phy::ofdma::Notification* myCS;
    };


} // convergence
} // wimemac

#endif // WIMEMAC_CHANNELSTATE_HPP

---