User Manual, Developers Guide and API Documentation

FrameBuilder.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 WNS_LDK_FCF_FRAMEBUILDER_H
#define WNS_LDK_FCF_FRAMEBUILDER_H

#include <list>

#include <WNS/ldk/ldk.hpp>
#include <WNS/pyconfig/Parser.hpp>
#include <WNS/ldk/multiplexer/Dispatcher.hpp>

#include <WNS/ldk/fcf/PhaseDescriptor.hpp>
#include <WNS/ldk/fcf/NewFrameProviderObserver.hpp>

namespace wns { namespace ldk {

    class ILayer;

    namespace fcf {


        class TimingControlInterface;
        class CompoundCollectorInterface;


        class FrameBuilder
            : public wns::ldk::multiplexer::Dispatcher,
              public wns::ldk::fcf::NewFrameProvider
        {
        public:
            typedef std::list< PhaseDescriptorPtr > Descriptors;

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

            void onFUNCreated();

            simTimeType getFrameDuration() const { return frameDuration_; }

            Descriptors getAllPhaseDescriptors() const { return descriptors_; }

            void start();

            void pause();

            void stop();

            virtual void finishedPhase( CompoundCollectorInterface* collector );

            TimingControlInterface*
            getTimingControl() const
            {
                return timingControl_;
            }
        private:

            Descriptors descriptors_;
            simTimeType frameDuration_;
            simTimeType symbolDuration_;

            TimingControlInterface* timingControl_;
            wns::logger::Logger logger;
        };
    }
}}
#endif

---