User Manual, Developers Guide and API Documentation

FlowGate.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_FLOWGATE_HPP
#define WNS_LDK_FLOWGATE_HPP

#include <WNS/ldk/CommandTypeSpecifier.hpp>
#include <WNS/ldk/HasReceptor.hpp>
#include <WNS/ldk/HasConnector.hpp>
#include <WNS/ldk/HasDeliverer.hpp>

#include <WNS/ldk/FlowSeparator.hpp>

#include <WNS/ldk/fun/FUN.hpp>
#include <WNS/ldk/Key.hpp>

#include <WNS/logger/Logger.hpp>

#include <WNS/DerefLess.hpp>

namespace wns { namespace ldk {

    class FlowGateInterface
    {
    public:
        virtual
        ~FlowGateInterface(){}

        virtual void
        createFlow(const ConstKeyPtr& key) = 0;

        virtual void
        destroyFlow(const ConstKeyPtr& key) = 0;

        virtual void
        openFlow(const ConstKeyPtr& key) = 0;

        virtual void
        closeFlow(const ConstKeyPtr& key) = 0;
    };

    class FlowGate :
        virtual public FunctionalUnit,
        virtual public FlowGateInterface,
        public CommandTypeSpecifier<>,
        public HasReceptor<>,
        public HasConnector<>,
        public HasDeliverer<>,
        public Cloneable<FlowGate>
    {
        typedef std::map<ConstKeyPtr, bool, DerefLess<ConstKeyPtr> > FlowStatus;
        FlowStatus flowStatus;

        KeyBuilder* keyBuilder;

        wns::logger::Logger logger;

        bool
        flowIsKnown(const ConstKeyPtr& key) const;

    public:
        FlowGate(fun::FUN* fun, const wns::pyconfig::View& config);
        FlowGate(fun::FUN* fun, const wns::pyconfig::View& config, KeyBuilder* builder);

        virtual
        ~FlowGate();

        virtual void
        onFUNCreated();

        virtual void doSendData(const CompoundPtr& compound);
        virtual void doOnData(const CompoundPtr& compound);
        virtual bool doIsAccepting(const CompoundPtr& compound) const;
        virtual void doWakeup();


        virtual void
        createFlow(const ConstKeyPtr& key);

        virtual void
        destroyFlow(const ConstKeyPtr& key);

        virtual void
        openFlow(const ConstKeyPtr& key);

        virtual void
        closeFlow(const ConstKeyPtr& key);


    };

}
}

#endif // note defined WNS_LDK_FLOWGATE_HPP

---