User Manual, Developers Guide and API Documentation

TimingControl.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2009
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 5, D-52074 Aachen, Germany
 * 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 WIMAC_FRAME_TIMINGCONTROL_H
#define WIMAC_FRAME_TIMINGCONTROL_H

#include <WNS/ldk/ldk.hpp>
#include <WNS/ldk/fcf/TimingControl.hpp>
#include <WNS/events/CanTimeout.hpp>


namespace wns {
    namespace pyconfig {
        class View;
    }

    namespace ldk {
        namespace fcf {
            class FrameBuilder;
            class CompoundCollectorInterface;
        }
    }
}

namespace wimac {
    namespace frame {

        class TimingControl :
            public virtual wns::ldk::fcf::TimingControlInterface,
            public wns::events::PeriodicTimeout,
            public wns::events::CanTimeout
        {
        public:

            enum Activation {
                Start,
                StartCollection,
                FinishCollection,
                Pause
            };

            TimingControl( wns::ldk::fcf::FrameBuilder* fb, const wns::pyconfig::View& config );

            void configure();
            void start();
            void pause();
            void stop();
            void getRole();
            void finishedPhase( wns::ldk::fcf::CompoundCollectorInterface* collector );
            wns::ldk::fcf::FrameBuilder* getFrameBuilder() const
            {
                return frameBuilder_;
            }

            void periodically();

            void onTimeout();

            void onFUNCreated();

            int getOffset();

        private:
            struct ActivationEntry
            {
                wns::ldk::fcf::CompoundCollectorInterface* compoundCollector;
                int mode;
                int action;
                double duration;
            };
            typedef std::list<ActivationEntry> Activations;

            void startProcessingActivations();
            void processOneActivation();

            Activations activations_;

            Activations::const_iterator activeCC_;

            // iterator is used for validation only ( assure(timeoutIsForMe == activeCC_, ...) )
            //Activations::const_iterator timeoutIsForMe;

            wns::ldk::fcf::FrameBuilder* frameBuilder_;

            bool running_;
            wns::pyconfig::View config_;

            wns::simulator::Time frameStartupDelay_;
            wns::simulator::Time frameStartTime_;

            friend class TriggerActivationStart;
        };
    }
}

#endif

---