User Manual, Developers Guide and API Documentation

FrameSynchronization.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_FRAMESYNCHRONIZATION_HPP
#define WIMEMAC_CONVERGENCE_FRAMESYNCHRONIZATION_HPP

#include <WIMEMAC/convergence/IRxStartEnd.hpp>
#include <WIMEMAC/lowerMAC/Manager.hpp>

#include <WNS/ldk/fu/Plain.hpp>
#include <WNS/ldk/Dropper.hpp>
#include <WNS/Birthmark.hpp>
#include <WNS/events/CanTimeout.hpp>
#include <WNS/PowerRatio.hpp>

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

namespace wimemac { namespace convergence {

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

    enum SyncStateType {
        Idle,
        Synchronized,
        Garbled,
        waitForFinalDelivery
    };

    class FrameSynchronization:
        public wns::ldk::fu::Plain<FrameSynchronization, FrameSynchronizationCommand>,
        public wns::events::CanTimeout,
        public RxStartEndNotification,
        public wns::ldk::probe::Probe
    {
    public:
        FrameSynchronization(wns::ldk::fun::FUN* fun, const wns::pyconfig::View& config);
        virtual ~FrameSynchronization();
    private:
        // CompoundHandlerInterface
        void doSendData(const wns::ldk::CompoundPtr& compound);
        void doOnData(const wns::ldk::CompoundPtr& compound);
        void onFUNCreated();
        bool doIsAccepting(const wns::ldk::CompoundPtr& compound) const;
        void doWakeup();

        // CanTimeout Interface
        void onTimeout();

        void processPreamble(const wns::ldk::CompoundPtr& compound);
        void processPSDU(const wns::ldk::CompoundPtr& compound);
        void failedSyncToNewPreamble(wns::simulator::Time fExDur);
        void syncToNewPreamble(const wns::simulator::Time fExDur, const wns::service::dll::UnicastAddress transmitter);


        wns::logger::Logger logger;
        SyncStateType curState;
        wns::service::dll::UnicastAddress synchronizedToAddress;
        const wns::Ratio slcCapture;
        const wns::Ratio slgCapture;
        const wns::Ratio idleCapture;
        const wns::Ratio detectionThreshold;
        const bool signalRxErrorAlthoughNotSynchronized;
        wns::simulator::Time lastFrameEnd;

        const std::string managerName;
        const std::string crcCommandName;

        struct Friends
        {
            wimemac::lowerMAC::IManagerServices* manager;
        } friends;
    };
} // end namespace convergence
} // end namespace wimemac

#endif // ifndef WIMEMAC_CONVERGENCE_FRAMESYNCHRONIZATION_HPP

---