User Manual, Developers Guide and API Documentation

FunctionalUnit.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_FUNCTIONALUNIT_HPP
#define WNS_LDK_FUNCTIONALUNIT_HPP

#include <WNS/ldk/Compound.hpp>
#include <WNS/ldk/CompoundHandlerInterface.hpp>
#include <WNS/ldk/CommandTypeSpecifierInterface.hpp>
#include <WNS/ldk/HasReceptorInterface.hpp>
#include <WNS/ldk/HasConnectorInterface.hpp>
#include <WNS/ldk/HasDelivererInterface.hpp>
#include <WNS/ldk/Receptor.hpp>
#include <WNS/ldk/Connector.hpp>
#include <WNS/ldk/Deliverer.hpp>
#include <WNS/ldk/ConnectorRegistry.hpp>
#include <WNS/ldk/ReceptorRegistry.hpp>
#include <WNS/ldk/DelivererRegistry.hpp>

#include <WNS/Cloneable.hpp>
#include <WNS/StaticFactory.hpp>
#include <WNS/ldk/FUNConfigCreator.hpp>
#include <WNS/PythonicOutput.hpp>


#include <string>

namespace wns { namespace ldk {
    class ILayer;

    class FunctionalUnit :
        public virtual CompoundHandlerInterface<FunctionalUnit>,
        public virtual HasConnectorInterface,
        public virtual HasReceptorInterface,
        public virtual HasDelivererInterface,
        public virtual ConnectorRegistry,
        public virtual ReceptorRegistry,
        public virtual DelivererRegistry,
        public virtual CommandTypeSpecifierInterface,
        public virtual CloneableInterface,
        public virtual PythonicOutput
    {
    public:
        friend class CommandProxy;

        FunctionalUnit() :
            name("None")
        {}

        virtual ~FunctionalUnit()
        {}

        template <typename T>
                T* connect(T* that, const std::string& srcPort = "SinglePort", const std::string& dstPort = "SinglePort")
        {
            FunctionalUnit* connectee = that->whenConnecting();
                        doConnect(connectee, srcPort, dstPort);
            return that;
        }

        template <typename T>
        T* downConnect(T* that, const std::string& srcPort = "SinglePort", const std::string& dstPort = "SinglePort")
        {
            FunctionalUnit* connectee = that->whenConnecting();
            doDownConnect(connectee, srcPort, dstPort);
            return that;
        }

        template <typename T>
        T* upConnect(T* that, const std::string& srcPort = "SinglePort", const std::string& dstPort = "SinglePort")
        {
            FunctionalUnit* connectee = that->whenConnecting();
            doUpConnect(connectee, srcPort, dstPort);
            return that;
        }

        virtual void
        onFUNCreated()
        {}

         virtual FunctionalUnit*
        whenConnecting()
        {
            return this;
        } //  whenConnecting

        virtual void
        setName(std::string _name)
        {
            name = _name;
        }

        virtual std::string
        getName() const
        {
            return name;
        }

    protected:
        virtual std::string
        doToString() const
        {
            return this->getName() + " (" + PythonicOutput::doToString() + ")";
        }

    private:
        virtual void
        doConnect(FunctionalUnit* that, const std::string& srcPort, const std::string& dstPort);

        virtual void
        doDownConnect(FunctionalUnit* that, const std::string& srcPort, const std::string& dstPort);

        virtual void
        doUpConnect(FunctionalUnit* that, const std::string& srcPort, const std::string& dstPort);

        std::string name;
    };
    typedef FUNConfigCreator<FunctionalUnit> FunctionalUnitCreator;
    typedef wns::StaticFactory<FunctionalUnitCreator> FunctionalUnitFactory;

}}


#endif // NOT defined WNS_LDK_FUNCTIONALUNIT_HPP

---