User Manual, Developers Guide and API Documentation

PreambleGenerator.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_PREAMBLEGENERATOR_HPP
#define WIMEMAC_CONVERGENCE_PREAMBLEGENERATOR_HPP

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

#include <WNS/ldk/fu/Plain.hpp>
#include <WNS/ldk/Delayed.hpp>

namespace wimemac { namespace convergence {

    class PreambleGeneratorCommand:
        public wns::ldk::Command
    {
    public:
        struct {} local;
        struct {
            // id of the upcoming frame to which the preamble belongs to
            wns::Birthmark frameId;
        } peer;
        struct {} magic;

        wns::Birthmark getFrameId() const
        {
            return(this->peer.frameId);
        }
    };

    class PreambleGenerator:
        public wns::ldk::fu::Plain<PreambleGenerator, PreambleGeneratorCommand>,
        public wns::ldk::Delayed<PreambleGenerator>
    {
    public:
        PreambleGenerator(wns::ldk::fun::FUN* fun, const wns::pyconfig::View& config);

        virtual
        ~PreambleGenerator();

    private:
        void processIncoming(const wns::ldk::CompoundPtr& compound);
        void processOutgoing(const wns::ldk::CompoundPtr& compound);
        bool hasCapacity() const;
        const wns::ldk::CompoundPtr hasSomethingToSend() const;
        wns::ldk::CompoundPtr getSomethingToSend();

        void onFUNCreated();

        void calculateSizes(const wns::ldk::CommandPool* commandPool, Bit& commandPoolSize, Bit& dataSize) const;

        const std::string phyUserName;
        const std::string managerName;

        wns::logger::Logger logger;
        wimemac::CompoundType lastReceivedCompoundType;

        wns::ldk::CompoundPtr pendingCompound;
        wns::ldk::CompoundPtr pendingPreamble;

        struct Friends
        {
            wimemac::convergence::IPhyServices* phyUser;
            wimemac::lowerMAC::IManagerServices* manager;
        } friends;
    };
} // mac
} // wimemac

#endif // WIMEMAC_CONVERGENCE_PREAMBLEGENERATOR_HPP

---